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

Class BigQueryIO.TypedRead<T>

java.lang.Object

org.apache.beam.sdk.transforms.PTransform<PBegin,PCollection<T>>

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

All Implemented Interfaces:

java.io.Serializable, HasDisplayData

Enclosing class:

BigQueryIO

public abstract static class BigQueryIO.TypedRead<T>
extends PTransform<PBegin,PCollection<T>>

Implementation of BigQueryIO.read(SerializableFunction).

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BigQueryIO.TypedRead.QueryPriority An enumeration type for the priority of a query.

Field Summary

Fields inherited from class org.apache.beam.sdk.transforms.PTransform

name

Constructor Summary

Constructors

Constructor and Description
TypedRead()

Method Summary

Modifier and Type	Method and Description
PCollection<T>	expand(PBegin input) Override this method to specify how this PTransform should be expanded on the given InputT.
BigQueryIO.TypedRead<T>	from(java.lang.String tableSpec) See BigQueryIO.Read.from(String).
BigQueryIO.TypedRead<T>	from(TableReference table) See BigQueryIO.Read.from(TableReference).
BigQueryIO.TypedRead<T>	from(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(ValueProvider<java.lang.String> query) See BigQueryIO.Read.fromQuery(ValueProvider).
TableReference	getTable() See BigQueryIO.Read.getTable().
ValueProvider<TableReference>	getTableProvider() See BigQueryIO.Read.getTableProvider().
void	populateDisplayData(DisplayData.Builder builder) Register display data for the given transform or component.
BigQueryIO.TypedRead<T>	usingStandardSql() See BigQueryIO.Read.usingStandardSql().
void	validate(PipelineOptions options) Called before running the Pipeline to verify this transform is fully and correctly specified.
BigQueryIO.TypedRead<T>	withCoder(Coder<T> coder) Sets a Coder for the result of the parse function.
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>	withTemplateCompatibility()

Methods inherited from class org.apache.beam.sdk.transforms.PTransform

getAdditionalInputs, getDefaultOutputCoder, getDefaultOutputCoder, getDefaultOutputCoder, getKindString, getName, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

TypedRead

public TypedRead()

Method Detail

validate

public void validate(PipelineOptions options)

Description copied from class: PTransform

Called before running the Pipeline to verify this transform is fully and correctly specified.

By default, does nothing.

Overrides:

validate in class PTransform<PBegin,PCollection<T>>

expand

public PCollection<T> expand(PBegin input)

Description copied from class: PTransform

Override this method to specify how this PTransform should be expanded on the given InputT.

NOTE: This method should not be called directly. Instead apply the PTransform should be applied to the InputT using the apply method.

Composite transforms, which are defined in terms of other transforms, should return the output of one of the composed transforms. Non-composite transforms, which do not apply any transforms internally, should return a new unbound output and register evaluators (via backend-specific registration methods).

Specified by:

expand in class PTransform<PBegin,PCollection<T>>

populateDisplayData

public void populateDisplayData(DisplayData.Builder builder)

Description copied from class: PTransform

Register display data for the given transform or component.

populateDisplayData(DisplayData.Builder) is invoked by Pipeline runners to collect display data via DisplayData.from(HasDisplayData). Implementations may call super.populateDisplayData(builder) in order to register display data in the current namespace, but should otherwise use subcomponent.populateDisplayData(builder) to use the namespace of the subcomponent.

By default, does not register any display data. Implementors may override this method to provide their own display data.

Specified by:

populateDisplayData in interface HasDisplayData

Overrides:

populateDisplayData in class PTransform<PBegin,PCollection<T>>

Parameters:

builder - The builder to populate with display data.

See Also:

HasDisplayData

getTableProvider

@Nullable
public ValueProvider<TableReference> getTableProvider()

See BigQueryIO.Read.getTableProvider().

getTable

@Nullable
public TableReference getTable()

See BigQueryIO.Read.getTable().

withCoder

public BigQueryIO.TypedRead<T> withCoder(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.

from

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

See BigQueryIO.Read.from(String).

from

public BigQueryIO.TypedRead<T> from(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(ValueProvider<java.lang.String> query)

See BigQueryIO.Read.fromQuery(ValueProvider).

from

public BigQueryIO.TypedRead<T> from(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.

withTemplateCompatibility

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