org.apache.beam.sdk.schemas

Class Schema.FieldType

java.lang.Object

org.apache.beam.sdk.schemas.Schema.FieldType

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

Schema

@Immutable
public abstract static class Schema.FieldType
extends java.lang.Object
implements java.io.Serializable

A descriptor of a single field type. This is a recursive descriptor, as nested types are allowed.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static Schema.FieldType	BOOLEAN The type of boolean fields.
static Schema.FieldType	BYTE The type of byte fields.
static Schema.FieldType	BYTES The type of bytes fields.
static Schema.FieldType	DATETIME The type of datetime fields.
static Schema.FieldType	DECIMAL The type of decimal fields.
static Schema.FieldType	DOUBLE The type of double fields.
static Schema.FieldType	FLOAT The type of float fields.
static Schema.FieldType	INT16 The type of int16 fields.
static Schema.FieldType	INT32 The type of int32 fields.
static Schema.FieldType	INT64 The type of int64 fields.
static Schema.FieldType	STRING The type of string fields.

Constructor Summary

Constructors

Constructor and Description
FieldType()

Method Summary

Modifier and Type	Method and Description
static Schema.FieldType	array(Schema.FieldType elementType) Create an array type for the given field type.
static Schema.FieldType	array(Schema.FieldType elementType, boolean nullable) Deprecated. Set the nullability on the elementType instead
boolean	equals(java.lang.Object o)
boolean	equivalent(Schema.FieldType other, Schema.EquivalenceNullablePolicy nullablePolicy) Check whether two types are equivalent.
static org.apache.beam.sdk.schemas.Schema.FieldType.Builder	forTypeName(Schema.TypeName typeName)
abstract Schema.FieldType	getCollectionElementType()
abstract Schema.LogicalType	getLogicalType()
<LogicalTypeT> LogicalTypeT	getLogicalType(java.lang.Class<LogicalTypeT> logicalTypeClass) Helper function for retrieving the concrete logical type subclass.
abstract Schema.FieldType	getMapKeyType()
abstract Schema.FieldType	getMapValueType()
protected abstract java.util.Map<java.lang.String,org.apache.beam.sdk.schemas.Schema.ByteArrayWrapper>	getMetadata() Returns optional extra metadata.
byte[]	getMetadata(java.lang.String key)
java.lang.String	getMetadataString(java.lang.String key)
abstract java.lang.Boolean	getNullable()
abstract Schema	getRowSchema()
abstract Schema.TypeName	getTypeName()
int	hashCode()
static <InputT,BaseT> Schema.FieldType	logicalType(Schema.LogicalType<InputT,BaseT> logicalType) Creates a logical type based on a primitive field type.
static Schema.FieldType	map(Schema.FieldType keyType, Schema.FieldType valueType) Create a map type for the given key and value types.
static Schema.FieldType	map(Schema.FieldType keyType, Schema.FieldType valueType, boolean valueTypeNullable) Deprecated. Set the nullability on the valueType instead
static Schema.FieldType	of(Schema.TypeName typeName) Create a Schema.FieldType for the given type.
static Schema.FieldType	row(Schema schema) Create a map type for the given key and value types.
boolean	typesEqual(Schema.FieldType other) Returns true if two FieldTypes are equal.
Schema.FieldType	withMetadata(java.util.Map<java.lang.String,byte[]> metadata) Set the metadata map for the type, overriding any existing metadata..
Schema.FieldType	withMetadata(java.lang.String key, byte[] metadata) Returns a copy of the descriptor with metadata set for the given key.
Schema.FieldType	withMetadata(java.lang.String key, java.lang.String metadata) Returns a copy of the descriptor with metadata set for the given key.
Schema.FieldType	withNullable(boolean nullable)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

STRING

public static final Schema.FieldType STRING

The type of string fields.

BYTE

public static final Schema.FieldType BYTE

The type of byte fields.

BYTES

public static final Schema.FieldType BYTES

The type of bytes fields.

INT16

public static final Schema.FieldType INT16

The type of int16 fields.

INT32

public static final Schema.FieldType INT32

The type of int32 fields.

INT64

public static final Schema.FieldType INT64

The type of int64 fields.

FLOAT

public static final Schema.FieldType FLOAT

The type of float fields.

DOUBLE

public static final Schema.FieldType DOUBLE

The type of double fields.

DECIMAL

public static final Schema.FieldType DECIMAL

The type of decimal fields.

BOOLEAN

public static final Schema.FieldType BOOLEAN

The type of boolean fields.

DATETIME

public static final Schema.FieldType DATETIME

The type of datetime fields.

Constructor Detail

FieldType

public FieldType()

Method Detail

getTypeName

public abstract Schema.TypeName getTypeName()

getNullable

public abstract java.lang.Boolean getNullable()

getLogicalType

@Nullable
public abstract Schema.LogicalType getLogicalType()

getCollectionElementType

@Nullable
public abstract Schema.FieldType getCollectionElementType()

getMapKeyType

@Nullable
public abstract Schema.FieldType getMapKeyType()

getMapValueType

@Nullable
public abstract Schema.FieldType getMapValueType()

getRowSchema

@Nullable
public abstract Schema getRowSchema()

getMetadata

protected abstract java.util.Map<java.lang.String,org.apache.beam.sdk.schemas.Schema.ByteArrayWrapper> getMetadata()

Returns optional extra metadata.

getLogicalType

public <LogicalTypeT> LogicalTypeT getLogicalType(java.lang.Class<LogicalTypeT> logicalTypeClass)

Helper function for retrieving the concrete logical type subclass.

forTypeName

public static org.apache.beam.sdk.schemas.Schema.FieldType.Builder forTypeName(Schema.TypeName typeName)

of

public static Schema.FieldType of(Schema.TypeName typeName)

Create a Schema.FieldType for the given type.

array

public static final Schema.FieldType array(Schema.FieldType elementType)

Create an array type for the given field type.

array

@Deprecated
public static final Schema.FieldType array(Schema.FieldType elementType,
                                                       boolean nullable)

Deprecated. Set the nullability on the elementType instead

map

public static final Schema.FieldType map(Schema.FieldType keyType,
                                         Schema.FieldType valueType)

Create a map type for the given key and value types.

map

@Deprecated
public static final Schema.FieldType map(Schema.FieldType keyType,
                                                     Schema.FieldType valueType,
                                                     boolean valueTypeNullable)

Deprecated. Set the nullability on the valueType instead

row

public static final Schema.FieldType row(Schema schema)

Create a map type for the given key and value types.

logicalType

public static final <InputT,BaseT> Schema.FieldType logicalType(Schema.LogicalType<InputT,BaseT> logicalType)

Creates a logical type based on a primitive field type.

withMetadata

public Schema.FieldType withMetadata(java.util.Map<java.lang.String,byte[]> metadata)

Set the metadata map for the type, overriding any existing metadata..

withMetadata

public Schema.FieldType withMetadata(java.lang.String key,
                                     byte[] metadata)

Returns a copy of the descriptor with metadata set for the given key.

withMetadata

public Schema.FieldType withMetadata(java.lang.String key,
                                     java.lang.String metadata)

Returns a copy of the descriptor with metadata set for the given key.

getMetadata

@Nullable
public byte[] getMetadata(java.lang.String key)

getMetadataString

public java.lang.String getMetadataString(java.lang.String key)

withNullable

public Schema.FieldType withNullable(boolean nullable)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

typesEqual

public boolean typesEqual(Schema.FieldType other)

Returns true if two FieldTypes are equal.

equivalent

public boolean equivalent(Schema.FieldType other,
                          Schema.EquivalenceNullablePolicy nullablePolicy)

Check whether two types are equivalent.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object