Package org.apache.beam.sdk.io.gcp.bigquery.providers

Class BigQueryDirectReadSchemaTransformProvider.BigQueryDirectReadSchemaTransformConfiguration

java.lang.Object

org.apache.beam.sdk.io.gcp.bigquery.providers.BigQueryDirectReadSchemaTransformProvider.BigQueryDirectReadSchemaTransformConfiguration

Enclosing class:

BigQueryDirectReadSchemaTransformProvider

@DefaultSchema(AutoValueSchema.class)
public abstract static class BigQueryDirectReadSchemaTransformProvider.BigQueryDirectReadSchemaTransformConfiguration
extends Object

Configuration for reading from BigQuery with Storage Read API.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BigQueryDirectReadSchemaTransformProvider.BigQueryDirectReadSchemaTransformConfiguration.Builder

Constructor Summary

Constructors

Constructor	Description
BigQueryDirectReadSchemaTransformConfiguration()

Method Summary

Modifier and Type	Method	Description
static BigQueryDirectReadSchemaTransformProvider.BigQueryDirectReadSchemaTransformConfiguration.Builder	builder()	Instantiates a BigQueryDirectReadSchemaTransformProvider.BigQueryDirectReadSchemaTransformConfiguration.Builder instance.
abstract String	getKmsKey()
abstract String	getQuery()
abstract String	getRowRestriction()
abstract List<String>	getSelectedFields()
abstract String	getTableSpec()
void	validate()

Methods inherited from class java.lang.Object

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

Constructor Details

BigQueryDirectReadSchemaTransformConfiguration

public BigQueryDirectReadSchemaTransformConfiguration()

Method Details

validate

public void validate()

builder

public static BigQueryDirectReadSchemaTransformProvider.BigQueryDirectReadSchemaTransformConfiguration.Builder builder()

Instantiates a BigQueryDirectReadSchemaTransformProvider.BigQueryDirectReadSchemaTransformConfiguration.Builder instance.

getQuery

@SchemaFieldDescription("The SQL query to be executed to read from the BigQuery table.")
@Nullable
public abstract String getQuery()

getTableSpec

@SchemaFieldDescription("The fully-qualified name of the BigQuery table to read from. Format: [${PROJECT}:]${DATASET}.${TABLE}")
@Nullable
public abstract String getTableSpec()

getRowRestriction

@SchemaFieldDescription("Read only rows that match this filter, which must be compatible with Google standard SQL. This is not supported when reading via query.")
@Nullable
public abstract String getRowRestriction()

getSelectedFields

@SchemaFieldDescription("Read only the specified fields (columns) from a BigQuery table. Fields may not be returned in the order specified. If no value is specified, then all fields are returned. Example: \"col1, col2, col3\"")
@Nullable
public abstract List<String> getSelectedFields()

getKmsKey

@SchemaFieldDescription("Use this Cloud KMS key to encrypt your data")
@Nullable
public abstract String getKmsKey()