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

Class BigQueryIO.TypedRead<T>

java.lang.Object

<any>

org.apache.beam.sdk.io.gcp.bigquery.BigQueryIO.TypedRead<T>

Enclosing class:

BigQueryIO

public abstract static class BigQueryIO.TypedRead<T>
extends <any>

Implementation of BigQueryIO.read(SerializableFunction).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BigQueryIO.TypedRead.Method Determines the method used to read data from BigQuery.
static class	BigQueryIO.TypedRead.QueryPriority An enumeration type for the priority of a query.

Constructor Summary

Constructors

Constructor and Description
TypedRead()

Method Summary

Modifier and Type	Method and Description
org.apache.beam.sdk.values.PCollection<T>	expand(org.apache.beam.sdk.values.PBegin input)
BigQueryIO.TypedRead<T>	from(java.lang.String tableSpec) See BigQueryIO.Read.from(String).
BigQueryIO.TypedRead<T>	from(com.google.api.services.bigquery.model.TableReference table) See BigQueryIO.Read.from(TableReference).
BigQueryIO.TypedRead<T>	from(org.apache.beam.sdk.options.ValueProvider<java.lang.String> tableSpec) See BigQueryIO.Read.from(ValueProvider).
BigQueryIO.TypedRead<T>	fromQuery(java.lang.String query) See BigQueryIO.Read.fromQuery(String).
BigQueryIO.TypedRead<T>	fromQuery(org.apache.beam.sdk.options.ValueProvider<java.lang.String> query) See BigQueryIO.Read.fromQuery(ValueProvider).
com.google.api.services.bigquery.model.TableReference	getTable() See BigQueryIO.Read.getTable().
org.apache.beam.sdk.options.ValueProvider<com.google.api.services.bigquery.model.TableReference>	getTableProvider() See BigQueryIO.Read.getTableProvider().
void	populateDisplayData(org.apache.beam.sdk.transforms.display.DisplayData.Builder builder)
BigQueryIO.TypedRead<T>	usingStandardSql() See BigQueryIO.Read.usingStandardSql().
void	validate(org.apache.beam.sdk.options.PipelineOptions options)
BigQueryIO.TypedRead<T>	withCoder(org.apache.beam.sdk.coders.Coder<T> coder) Sets a Coder for the result of the parse function.
BigQueryIO.TypedRead<T>	withKmsKey(java.lang.String kmsKey) For query sources, use this Cloud KMS key to encrypt any temporary tables created.
BigQueryIO.TypedRead<T>	withMethod(BigQueryIO.TypedRead.Method method) See BigQueryIO.TypedRead.Method.
BigQueryIO.TypedRead<T>	withoutResultFlattening() See BigQueryIO.Read.withoutResultFlattening().
BigQueryIO.TypedRead<T>	withoutValidation() See BigQueryIO.Read.withoutValidation().
BigQueryIO.TypedRead<T>	withQueryLocation(java.lang.String location) BigQuery geographic location where the query job will be executed.
BigQueryIO.TypedRead<T>	withQueryPriority(BigQueryIO.TypedRead.QueryPriority priority) See BigQueryIO.TypedRead.QueryPriority.
BigQueryIO.TypedRead<T>	withReadOptions(com.google.cloud.bigquery.storage.v1beta1.ReadOptions.TableReadOptions readOptions) Read options, including a list of selected columns and push-down SQL filter text.
BigQueryIO.TypedRead<T>	withTemplateCompatibility()

Methods inherited from class java.lang.Object

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

Constructor Detail

TypedRead

public TypedRead()

Method Detail

validate

public void validate(org.apache.beam.sdk.options.PipelineOptions options)

expand

public org.apache.beam.sdk.values.PCollection<T> expand(org.apache.beam.sdk.values.PBegin input)

populateDisplayData

public void populateDisplayData(org.apache.beam.sdk.transforms.display.DisplayData.Builder builder)

getTableProvider

@Nullable
public org.apache.beam.sdk.options.ValueProvider<com.google.api.services.bigquery.model.TableReference> getTableProvider()

See BigQueryIO.Read.getTableProvider().

getTable

@Nullable
public com.google.api.services.bigquery.model.TableReference getTable()

See BigQueryIO.Read.getTable().

withCoder

public BigQueryIO.TypedRead<T> withCoder(org.apache.beam.sdk.coders.Coder<T> coder)

Sets a Coder for the result of the parse function. This may be required if a coder can not be inferred automatically.

withKmsKey

public BigQueryIO.TypedRead<T> withKmsKey(java.lang.String kmsKey)

For query sources, use this Cloud KMS key to encrypt any temporary tables created.

from

public BigQueryIO.TypedRead<T> from(java.lang.String tableSpec)

See BigQueryIO.Read.from(String).

from

public BigQueryIO.TypedRead<T> from(org.apache.beam.sdk.options.ValueProvider<java.lang.String> tableSpec)

See BigQueryIO.Read.from(ValueProvider).

fromQuery

public BigQueryIO.TypedRead<T> fromQuery(java.lang.String query)

See BigQueryIO.Read.fromQuery(String).

fromQuery

public BigQueryIO.TypedRead<T> fromQuery(org.apache.beam.sdk.options.ValueProvider<java.lang.String> query)

See BigQueryIO.Read.fromQuery(ValueProvider).

from

public BigQueryIO.TypedRead<T> from(com.google.api.services.bigquery.model.TableReference table)

See BigQueryIO.Read.from(TableReference).

withoutValidation

public BigQueryIO.TypedRead<T> withoutValidation()

See BigQueryIO.Read.withoutValidation().

withoutResultFlattening

public BigQueryIO.TypedRead<T> withoutResultFlattening()

See BigQueryIO.Read.withoutResultFlattening().

usingStandardSql

public BigQueryIO.TypedRead<T> usingStandardSql()

See BigQueryIO.Read.usingStandardSql().

withQueryPriority

public BigQueryIO.TypedRead<T> withQueryPriority(BigQueryIO.TypedRead.QueryPriority priority)

See BigQueryIO.TypedRead.QueryPriority.

withQueryLocation

public BigQueryIO.TypedRead<T> withQueryLocation(java.lang.String location)

BigQuery geographic location where the query job will be executed. If not specified, Beam tries to determine the location by examining the tables referenced by the query. Location must be specified for queries not executed in US or EU. See BigQuery Jobs: query.

withMethod

@Experimental(value=SOURCE_SINK)
public BigQueryIO.TypedRead<T> withMethod(BigQueryIO.TypedRead.Method method)

See BigQueryIO.TypedRead.Method.

withReadOptions

@Experimental(value=SOURCE_SINK)
public BigQueryIO.TypedRead<T> withReadOptions(com.google.cloud.bigquery.storage.v1beta1.ReadOptions.TableReadOptions readOptions)

Read options, including a list of selected columns and push-down SQL filter text.

withTemplateCompatibility

@Experimental(value=SOURCE_SINK)
public BigQueryIO.TypedRead<T> withTemplateCompatibility()