org.apache.beam.sdk.schemas.logicaltypes

Class VariableBytes

java.lang.Object

org.apache.beam.sdk.schemas.logicaltypes.PassThroughLogicalType<byte[]>

org.apache.beam.sdk.schemas.logicaltypes.VariableBytes

All Implemented Interfaces:

java.io.Serializable, Schema.LogicalType<byte[],byte[]>

public class VariableBytes
extends PassThroughLogicalType<byte[]>

A LogicalType representing a variable-length byte array with specified maximum length.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	IDENTIFIER

Method Summary

Modifier and Type	Method and Description
int	getMaxLength()
@Nullable java.lang.String	getName()
static VariableBytes	of(int maxByteArrayLength) Return an instance of VariableBytes with specified max byte array length.
static VariableBytes	of(@Nullable java.lang.String name, int maxByteArrayLength) Return an instance of VariableBytes with specified max byte array length.
byte[]	toInputType(byte[] base) Convert the Java type used by the base Schema.FieldType to the input type.
java.lang.String	toString()

Methods inherited from class org.apache.beam.sdk.schemas.logicaltypes.PassThroughLogicalType

getArgument, getArgumentType, getBaseType, getIdentifier, toBaseType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

IDENTIFIER

public static final java.lang.String IDENTIFIER

Method Detail

of

public static VariableBytes of(@Nullable java.lang.String name,
                               int maxByteArrayLength)

Return an instance of VariableBytes with specified max byte array length.

The name, if set, refers to the TYPE name in the underlying database, for example, VARBINARY and LONGVARBINARY.

of

public static VariableBytes of(int maxByteArrayLength)

Return an instance of VariableBytes with specified max byte array length.

getMaxLength

public int getMaxLength()

getName

public @Nullable java.lang.String getName()

toInputType

public byte[] toInputType(byte[] base)

Description copied from interface: Schema.LogicalType

Convert the Java type used by the base Schema.FieldType to the input type.

Specified by:

toInputType in interface Schema.LogicalType<byte[],byte[]>

Overrides:

toInputType in class PassThroughLogicalType<byte[]>

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object