com.google.cloud.dataflow.sdk.io.bigtable

Class BigtableIO.Read

java.lang.Object

com.google.cloud.dataflow.sdk.transforms.PTransform<PBegin,PCollection<com.google.bigtable.v1.Row>>

com.google.cloud.dataflow.sdk.io.bigtable.BigtableIO.Read

All Implemented Interfaces:

HasDisplayData, Serializable

Enclosing class:

BigtableIO

@Experimental
public static class BigtableIO.Read
extends PTransform<PBegin,PCollection<com.google.bigtable.v1.Row>>

A PTransform that reads from Google Cloud Bigtable. See the class-level Javadoc on BigtableIO for more information.

See Also:

BigtableIO, Serialized Form

Field Summary

Fields inherited from class com.google.cloud.dataflow.sdk.transforms.PTransform

name

Method Summary

Modifier and Type	Method and Description
PCollection<com.google.bigtable.v1.Row>	apply(PBegin input) Applies this PTransform on the given InputT, and returns its Output.
com.google.cloud.bigtable.config.BigtableOptions	getBigtableOptions() Returns the Google Cloud Bigtable cluster being read from, and other parameters.
String	getTableId() Returns the table being read from.
String	toString()
void	validate(PBegin input) Called before invoking apply (which may be intercepted by the runner) to verify this transform is fully specified and applicable to the specified input.
BigtableIO.Read	withBigtableOptions(com.google.cloud.bigtable.config.BigtableOptions.Builder optionsBuilder) Returns a new BigtableIO.Read that will read from the Cloud Bigtable cluster indicated by the given options, and using any other specified customizations.
BigtableIO.Read	withBigtableOptions(com.google.cloud.bigtable.config.BigtableOptions options) Returns a new BigtableIO.Read that will read from the Cloud Bigtable cluster indicated by the given options, and using any other specified customizations.
BigtableIO.Read	withRowFilter(com.google.bigtable.v1.RowFilter filter) Returns a new BigtableIO.Read that will filter the rows read from Cloud Bigtable using the given row filter.
BigtableIO.Read	withTableId(String tableId) Returns a new BigtableIO.Read that will read from the specified table.

Methods inherited from class com.google.cloud.dataflow.sdk.transforms.PTransform

getDefaultOutputCoder, getDefaultOutputCoder, getDefaultOutputCoder, getKindString, getName, populateDisplayData

Methods inherited from class java.lang.Object

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

Method Detail

withBigtableOptions

public BigtableIO.Read withBigtableOptions(com.google.cloud.bigtable.config.BigtableOptions options)

Returns a new BigtableIO.Read that will read from the Cloud Bigtable cluster indicated by the given options, and using any other specified customizations.

Does not modify this object.

withBigtableOptions

public BigtableIO.Read withBigtableOptions(com.google.cloud.bigtable.config.BigtableOptions.Builder optionsBuilder)

Returns a new BigtableIO.Read that will read from the Cloud Bigtable cluster indicated by the given options, and using any other specified customizations.

Clones the given BigtableOptions builder so that any further changes will have no effect on the returned BigtableIO.Read.

Does not modify this object.

withRowFilter

public BigtableIO.Read withRowFilter(com.google.bigtable.v1.RowFilter filter)

Returns a new BigtableIO.Read that will filter the rows read from Cloud Bigtable using the given row filter.

Does not modify this object.

withTableId

public BigtableIO.Read withTableId(String tableId)

Returns a new BigtableIO.Read that will read from the specified table.

Does not modify this object.

getBigtableOptions

public com.google.cloud.bigtable.config.BigtableOptions getBigtableOptions()

Returns the Google Cloud Bigtable cluster being read from, and other parameters.

getTableId

public String getTableId()

Returns the table being read from.

apply

public PCollection<com.google.bigtable.v1.Row> apply(PBegin input)

Description copied from class: PTransform

Applies this PTransform on the given InputT, and returns its Output.

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).

The default implementation throws an exception. A derived class must either implement apply, or else each runner must supply a custom implementation via PipelineRunner.apply(com.google.cloud.dataflow.sdk.transforms.PTransform<InputT, OutputT>, InputT).

Overrides:

apply in class PTransform<PBegin,PCollection<com.google.bigtable.v1.Row>>

validate

public void validate(PBegin input)

Description copied from class: PTransform

Called before invoking apply (which may be intercepted by the runner) to verify this transform is fully specified and applicable to the specified input.

By default, does nothing.

Overrides:

validate in class PTransform<PBegin,PCollection<com.google.bigtable.v1.Row>>

toString

public String toString()

Overrides:

toString in class PTransform<PBegin,PCollection<com.google.bigtable.v1.Row>>