org.apache.beam.sdk.schemas.logicaltypes

Class FixedString

java.lang.Object

org.apache.beam.sdk.schemas.logicaltypes.PassThroughLogicalType<java.lang.String>

org.apache.beam.sdk.schemas.logicaltypes.FixedString

All Implemented Interfaces:

java.io.Serializable, Schema.LogicalType<java.lang.String,java.lang.String>

public class FixedString
extends PassThroughLogicalType<java.lang.String>

A LogicalType representing a fixed-length string.

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	getLength()
@Nullable java.lang.String	getName()
static FixedString	of(int stringLength) Return an instance of FixedString with specified string length.
static FixedString	of(@Nullable java.lang.String name, int stringLength) Return an instance of FixedString with specified string length.
java.lang.String	toInputType(java.lang.String 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 FixedString of(@Nullable java.lang.String name,
                             int stringLength)

Return an instance of FixedString with specified string length.

The name, if set, refers to the TYPE name in the underlying database, for example, CHAR.

of

public static FixedString of(int stringLength)

Return an instance of FixedString with specified string length.

getLength

public int getLength()

getName

public @Nullable java.lang.String getName()

toInputType

public java.lang.String toInputType(java.lang.String 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<java.lang.String,java.lang.String>

Overrides:

toInputType in class PassThroughLogicalType<java.lang.String>

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object