org.apache.beam.sdk.io.gcp.bigtable

Class BigtableIO.Read

java.lang.Object

org.apache.beam.sdk.transforms.PTransform<PBegin,PCollection<com.google.bigtable.v2.Row>>

org.apache.beam.sdk.io.gcp.bigtable.BigtableIO.Read

All Implemented Interfaces:

java.io.Serializable, HasDisplayData

Enclosing class:

BigtableIO

@Experimental
public static class BigtableIO.Read
extends PTransform<PBegin,PCollection<com.google.bigtable.v2.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 org.apache.beam.sdk.transforms.PTransform

name

Method Summary

Modifier and Type	Method and Description
PCollection<com.google.bigtable.v2.Row>	expand(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 instance being read from, and other parameters.
ByteKeyRange	getKeyRange() Returns the range of keys that will be read from the table.
java.lang.String	getTableId() Returns the table being read from.
void	populateDisplayData(DisplayData.Builder builder) Register display data for the given transform or component.
java.lang.String	toString()
void	validate(PipelineOptions options) Called before running the Pipeline to verify this transform is fully and correctly specified.
BigtableIO.Read	withBigtableOptions(com.google.cloud.bigtable.config.BigtableOptions.Builder optionsBuilder) Returns a new BigtableIO.Read that will read from the Cloud Bigtable instance 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 instance indicated by the given options, and using any other specified customizations.
BigtableIO.Read	withKeyRange(ByteKeyRange keyRange) Returns a new BigtableIO.Read that will read only rows in the specified range.
BigtableIO.Read	withRowFilter(com.google.bigtable.v2.RowFilter filter) Returns a new BigtableIO.Read that will filter the rows read from Cloud Bigtable using the given row filter.
BigtableIO.Read	withTableId(java.lang.String tableId) Returns a new BigtableIO.Read that will read from the specified table.

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

getAdditionalInputs, getDefaultOutputCoder, getDefaultOutputCoder, getDefaultOutputCoder, getKindString, getName

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 instance 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 instance 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.v2.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.

withKeyRange

public BigtableIO.Read withKeyRange(ByteKeyRange keyRange)

Returns a new BigtableIO.Read that will read only rows in the specified range.

Does not modify this object.

withTableId

public BigtableIO.Read withTableId(java.lang.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 instance being read from, and other parameters.

getKeyRange

public ByteKeyRange getKeyRange()

Returns the range of keys that will be read from the table. By default, returns ByteKeyRange.ALL_KEYS to scan the entire table.

getTableId

public java.lang.String getTableId()

Returns the table being read from.

expand

public PCollection<com.google.bigtable.v2.Row> expand(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).

Specified by:

expand in class PTransform<PBegin,PCollection<com.google.bigtable.v2.Row>>

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<com.google.bigtable.v2.Row>>

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<com.google.bigtable.v2.Row>>

Parameters:

builder - The builder to populate with display data.

See Also:

HasDisplayData

toString

public java.lang.String toString()

Overrides:

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