Class DataStoreV1SchemaIOProvider
- java.lang.Object
-
- org.apache.beam.sdk.io.gcp.datastore.DataStoreV1SchemaIOProvider
-
- All Implemented Interfaces:
org.apache.beam.sdk.schemas.io.SchemaIOProvider
@Internal @AutoService(org.apache.beam.sdk.schemas.io.SchemaIOProvider.class) public class DataStoreV1SchemaIOProvider extends java.lang.Object implements org.apache.beam.sdk.schemas.io.SchemaIOProvider
An implementation ofSchemaIOProvider
for reading and writing payloads withDatastoreIO
.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
DataStoreV1SchemaIOProvider.DataStoreV1SchemaIO
An abstraction to create schema aware IOs.
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
KEY_FIELD_PROPERTY
-
Constructor Summary
Constructors Constructor Description DataStoreV1SchemaIOProvider()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description org.apache.beam.sdk.schemas.Schema
configurationSchema()
Returns the expected schema of the configuration object.DataStoreV1SchemaIOProvider.DataStoreV1SchemaIO
from(java.lang.String location, org.apache.beam.sdk.values.Row configuration, org.apache.beam.sdk.schemas.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.org.apache.beam.sdk.values.PCollection.IsBounded
isBounded()
boolean
requiresDataSchema()
-
-
-
Field Detail
-
KEY_FIELD_PROPERTY
public static final java.lang.String KEY_FIELD_PROPERTY
- See Also:
- Constant Field Values
-
-
Method Detail
-
identifier
public java.lang.String identifier()
Returns an id that uniquely represents this IO.- Specified by:
identifier
in interfaceorg.apache.beam.sdk.schemas.io.SchemaIOProvider
-
configurationSchema
public org.apache.beam.sdk.schemas.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 interfaceorg.apache.beam.sdk.schemas.io.SchemaIOProvider
- STRING keyField: The name of the Beam schema field to map the DataStore entity key.
Defaults to
-
from
public DataStoreV1SchemaIOProvider.DataStoreV1SchemaIO from(java.lang.String location, org.apache.beam.sdk.values.Row configuration, org.apache.beam.sdk.schemas.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 interfaceorg.apache.beam.sdk.schemas.io.SchemaIOProvider
-
requiresDataSchema
public boolean requiresDataSchema()
- Specified by:
requiresDataSchema
in interfaceorg.apache.beam.sdk.schemas.io.SchemaIOProvider
-
isBounded
public org.apache.beam.sdk.values.PCollection.IsBounded isBounded()
- Specified by:
isBounded
in interfaceorg.apache.beam.sdk.schemas.io.SchemaIOProvider
-
-