Package org.apache.beam.sdk.io.gcp.spanner

Class SpannerReadSchemaTransformProvider.SpannerReadSchemaTransformConfiguration

java.lang.Object

org.apache.beam.sdk.io.gcp.spanner.SpannerReadSchemaTransformProvider.SpannerReadSchemaTransformConfiguration

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

SpannerReadSchemaTransformProvider

@DefaultSchema(org.apache.beam.sdk.schemas.AutoValueSchema.class)
public abstract static class SpannerReadSchemaTransformProvider.SpannerReadSchemaTransformConfiguration
extends java.lang.Object
implements java.io.Serializable

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SpannerReadSchemaTransformProvider.SpannerReadSchemaTransformConfiguration.Builder

Constructor Summary

Constructors

Constructor	Description
SpannerReadSchemaTransformConfiguration()

Method Summary

Modifier and Type	Method	Description
static SpannerReadSchemaTransformProvider.SpannerReadSchemaTransformConfiguration.Builder	builder()
abstract java.lang.Boolean	getBatching()
abstract java.util.List<java.lang.String>	getColumns()
abstract java.lang.String	getDatabaseId()
abstract org.apache.beam.sdk.schemas.transforms.providers.ErrorHandling	getErrorHandling()
abstract java.lang.String	getIndex()
abstract java.lang.String	getInstanceId()
abstract java.lang.String	getProjectId()
abstract java.lang.String	getQuery()
abstract java.lang.String	getTableId()
void	validate()

Methods inherited from class java.lang.Object

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

Constructor Detail

SpannerReadSchemaTransformConfiguration

public SpannerReadSchemaTransformConfiguration()

Method Detail

validate

public void validate()

builder

public static SpannerReadSchemaTransformProvider.SpannerReadSchemaTransformConfiguration.Builder builder()

getInstanceId

@SchemaFieldDescription("Specifies the Cloud Spanner instance.")
public abstract java.lang.String getInstanceId()

getDatabaseId

@SchemaFieldDescription("Specifies the Cloud Spanner database.")
public abstract java.lang.String getDatabaseId()

getProjectId

@SchemaFieldDescription("Specifies the GCP project ID.")
@Nullable
public abstract java.lang.String getProjectId()

getTableId

@SchemaFieldDescription("Specifies the Cloud Spanner table.")
@Nullable
public abstract java.lang.String getTableId()

getQuery

@SchemaFieldDescription("Specifies the SQL query to execute.")
@Nullable
public abstract java.lang.String getQuery()

getColumns

@SchemaFieldDescription("Specifies the columns to read from the table. This parameter is required when table is specified.")
@Nullable
public abstract java.util.List<java.lang.String> getColumns()

getIndex

@SchemaFieldDescription("Specifies the Index to read from. This parameter can only be specified when using table.")
@Nullable
public abstract java.lang.String getIndex()

getBatching

@SchemaFieldDescription("Set to false to disable batching. Useful when using a query that is not compatible with the PartitionQuery API. Defaults to true.")
@Nullable
public abstract java.lang.Boolean getBatching()

getErrorHandling

@SchemaFieldDescription("This option specifies whether and where to output unwritable rows.")
@Nullable
public abstract org.apache.beam.sdk.schemas.transforms.providers.ErrorHandling getErrorHandling()