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

Class MicrosInstant

java.lang.Object

org.apache.beam.sdk.schemas.logicaltypes.MicrosInstant

All Implemented Interfaces:

Serializable, Schema.LogicalType<Instant,Row>

public class MicrosInstant
extends Object
implements Schema.LogicalType<Instant,Row>

A timestamp represented as microseconds since the epoch.

WARNING: This logical type exists solely for interoperability with other type systems such as SQL and other Beam SDKs. It should never be used in a native Java context where the java.time.Instant instances it describes may have higher than microsecond precision. Ignoring this will likely result in an AssertionError at pipeline execution time.

For a more faithful logical type to use with java.time.Instant, see NanosInstant.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	IDENTIFIER

Constructor Summary

Constructors

Constructor	Description
MicrosInstant()

Method Summary

Modifier and Type	Method	Description
@Nullable 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(Instant input)	Convert the input type to the type Java type used by the base Schema.FieldType.
Instant	toInputType(Row row)	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

Methods inherited from interface org.apache.beam.sdk.schemas.Schema.LogicalType

getArgument

Field Details

IDENTIFIER

public static final String IDENTIFIER

Constructor Details

MicrosInstant

public MicrosInstant()

Method Details

toBaseType

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

toInputType

public Instant toInputType(Row row)

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

getIdentifier

public String getIdentifier()

Description copied from interface: Schema.LogicalType

The unique identifier for this type.

Specified by:

getIdentifier in interface Schema.LogicalType<Instant,Row>

getArgumentType

public @Nullable 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<Instant,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<Instant,Row>