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:

Serializable

Enclosing class:

SpannerReadSchemaTransformProvider

@DefaultSchema(AutoValueSchema.class)
public abstract static class SpannerReadSchemaTransformProvider.SpannerReadSchemaTransformConfiguration
extends Object
implements 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 Boolean	getBatching()
abstract List<String>	getColumns()
abstract String	getDatabaseId()
abstract ErrorHandling	getErrorHandling()
abstract String	getIndex()
abstract String	getInstanceId()
abstract String	getProjectId()
abstract String	getQuery()
abstract String	getTableId()
void	validate()

Methods inherited from class java.lang.Object

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

Constructor Details

SpannerReadSchemaTransformConfiguration

public SpannerReadSchemaTransformConfiguration()

Method Details

validate

public void validate()

builder

public static SpannerReadSchemaTransformProvider.SpannerReadSchemaTransformConfiguration.Builder builder()

getInstanceId

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

getDatabaseId

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

getProjectId

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

getTableId

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

getQuery

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

getColumns

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

getIndex

@SchemaFieldDescription("Specifies the Index to read from. This parameter can only be specified when using table.")
@Nullable
public abstract 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 Boolean getBatching()

getErrorHandling

@SchemaFieldDescription("This option specifies whether and where to output unwritable rows.")
@Nullable
public abstract ErrorHandling getErrorHandling()