org.apache.beam.sdk.io.gcp.datastore

Class DataStoreV1SchemaIOProvider

java.lang.Object

org.apache.beam.sdk.io.gcp.datastore.DataStoreV1SchemaIOProvider

All Implemented Interfaces:

SchemaIOProvider

@Internal
 @AutoService(value=SchemaIOProvider.class)
public class DataStoreV1SchemaIOProvider
extends java.lang.Object
implements SchemaIOProvider

An implementation of SchemaIOProvider for reading and writing payloads with DatastoreIO.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DataStoreV1SchemaIOProvider.DataStoreV1SchemaIO An abstraction to create schema aware IOs.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	KEY_FIELD_PROPERTY

Constructor Summary

Constructors

Constructor and Description
DataStoreV1SchemaIOProvider()

Method Summary

Modifier and Type	Method and Description
Schema	configurationSchema() Returns the expected schema of the configuration object.
DataStoreV1SchemaIOProvider.DataStoreV1SchemaIO	from(java.lang.String location, Row configuration, Schema dataSchema) Produce a SchemaIO given a String representing the data's location, the schema of the data that resides there, and some IO-specific configuration object.
java.lang.String	identifier() Returns an id that uniquely represents this IO.
PCollection.IsBounded	isBounded()
boolean	requiresDataSchema() Indicates whether the dataSchema value is necessary.

Methods inherited from class java.lang.Object

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

Field Detail

KEY_FIELD_PROPERTY

public static final java.lang.String KEY_FIELD_PROPERTY

See Also:

Constant Field Values

Constructor Detail

DataStoreV1SchemaIOProvider

public DataStoreV1SchemaIOProvider()

Method Detail

identifier

public java.lang.String identifier()

Returns an id that uniquely represents this IO.

Specified by:

identifier in interface SchemaIOProvider

configurationSchema

public Schema configurationSchema()

Returns the expected schema of the configuration object. Note this is distinct from the schema of the data source itself.

Configuration Parameters:

• STRING keyField: The name of the Beam schema field to map the DataStore entity key. Defaults to __key__ if not set or null.

Specified by:

configurationSchema in interface SchemaIOProvider

from

public DataStoreV1SchemaIOProvider.DataStoreV1SchemaIO from(java.lang.String location,
                                                            Row configuration,
                                                            Schema dataSchema)

Produce a SchemaIO given a String representing the data's location, the schema of the data that resides there, and some IO-specific configuration object.

Specified by:

from in interface SchemaIOProvider

requiresDataSchema

public boolean requiresDataSchema()

Description copied from interface: SchemaIOProvider

Indicates whether the dataSchema value is necessary.

Specified by:

requiresDataSchema in interface SchemaIOProvider

isBounded

public PCollection.IsBounded isBounded()

Specified by:

isBounded in interface SchemaIOProvider