Package org.apache.beam.sdk.schemas.logicaltypes

Class DateTime

java.lang.Object

org.apache.beam.sdk.schemas.logicaltypes.DateTime

All Implemented Interfaces:

Serializable, Schema.LogicalType<LocalDateTime,Row>

public class DateTime
extends Object
implements Schema.LogicalType<LocalDateTime,Row>

A datetime without a time-zone.

It cannot represent an instant on the time-line without additional information such as an offset or time-zone.

Its input type is a LocalDateTime, and base type is a Row containing Date field and Time field. Date field is the same as the base type of Date, which is a Long that represents incrementing count of days where day 0 is 1970-01-01 (ISO). Time field is the same as the base type of Time, which is a Long that represents a count of time in nanoseconds.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DATE_FIELD_NAME
static final Schema	DATETIME_SCHEMA
static final String	IDENTIFIER
static final String	TIME_FIELD_NAME

Constructor Summary

Constructors

Constructor	Description
DateTime()

Method Summary

Modifier and Type	Method	Description
String	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.
String	getIdentifier()	The unique identifier for this type.
Row	toBaseType(LocalDateTime input)	Convert the input type to the type Java type used by the base Schema.FieldType.
LocalDateTime	toInputType(Row base)	Convert the Java type used by the base Schema.FieldType to the input type.

Methods inherited from class java.lang.Object

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

Field Details

IDENTIFIER

public static final String IDENTIFIER

See Also:

• Constant Field Values

DATE_FIELD_NAME

public static final String DATE_FIELD_NAME

See Also:

• Constant Field Values

TIME_FIELD_NAME

public static final String TIME_FIELD_NAME

See Also:

• Constant Field Values

DATETIME_SCHEMA

public static final Schema DATETIME_SCHEMA

Constructor Details

DateTime

public DateTime()

Method Details

getIdentifier

public String getIdentifier()

Description copied from interface: Schema.LogicalType

The unique identifier for this type.

Specified by:

getIdentifier in interface Schema.LogicalType<LocalDateTime,Row>

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<LocalDateTime,Row>

getArgument

public String getArgument()

Description copied from interface: Schema.LogicalType

An optional argument to configure the type.

Specified by:

getArgument in interface Schema.LogicalType<LocalDateTime,Row>

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<LocalDateTime,Row>

toBaseType

public Row toBaseType(LocalDateTime 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<LocalDateTime,Row>

toInputType

public LocalDateTime toInputType(Row 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<LocalDateTime,Row>