org.apache.beam.sdk.schemas.logicaltypes

Class FixedBytes

java.lang.Object

org.apache.beam.sdk.schemas.logicaltypes.FixedBytes

All Implemented Interfaces:

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

@Experimental(value=SCHEMAS)
public class FixedBytes
extends java.lang.Object
implements Schema.LogicalType<byte[],byte[]>

A LogicalType representing a fixed-size byte array.

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
java.lang.Integer	getArgument() An optional argument to configure the type.
Schema.FieldType	getArgumentType() A schema type representing how to interpret the argument.
Schema.FieldType	getBaseType() The base Schema.FieldType used to store values of this type.
java.lang.String	getIdentifier() The unique identifier for this type.
int	getLength()
static FixedBytes	of(int byteArraySize)
byte[]	toBaseType(byte[] input) Convert the input type to the type Java type used by the base Schema.FieldType.
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 java.lang.Object

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

Field Detail

IDENTIFIER

public static final java.lang.String IDENTIFIER

See Also:

Constant Field Values

Method Detail

of

public static FixedBytes of(int byteArraySize)

getLength

public int getLength()

getIdentifier

public java.lang.String getIdentifier()

Description copied from interface: Schema.LogicalType

The unique identifier for this type.

Specified by:

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

getArgumentType

public Schema.FieldType getArgumentType()

Description copied from interface: Schema.LogicalType

A schema type representing how to interpret the argument. null indicates this logical type is not parameterized by an argument.

Specified by:

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

getArgument

public java.lang.Integer getArgument()

Description copied from interface: Schema.LogicalType

An optional argument to configure the type.

Specified by:

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

getBaseType

public Schema.FieldType getBaseType()

Description copied from interface: Schema.LogicalType

The base Schema.FieldType used to store values of this type.

Specified by:

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

toBaseType

public byte[] toBaseType(byte[] input)

Description copied from interface: Schema.LogicalType

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

Specified by:

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

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[]>

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object