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:

Serializable, HasDisplayData

Enclosing class:

BigtableIO

@Experimental(value=SOURCE_SINK)
public abstract 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

Constructor Summary

Constructors

Constructor and Description
Read()

Method Summary

Modifier and Type	Method and Description
PCollection<com.google.bigtable.v2.Row>	expand(PBegin input)
abstract com.google.cloud.bigtable.config.BigtableOptions	getBigtableOptions() Returns the Google Cloud Bigtable instance being read from, and other parameters.
abstract ByteKeyRange	getKeyRange() Returns the range of keys that will be read from the table.
abstract String	getTableId() Returns the table being read from.
abstract boolean	getValidate()
void	populateDisplayData(DisplayData.Builder builder)
String	toString()
void	validate(PipelineOptions options)
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	withoutValidation() Disables validation that the table being read from exists.
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(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

Constructor Detail

Read

public Read()

Method Detail

getKeyRange

@Nullable
public abstract ByteKeyRange getKeyRange()

Returns the range of keys that will be read from the table.

getTableId

@Nullable
public abstract String getTableId()

Returns the table being read from.

getBigtableOptions

@Nullable
public abstract com.google.cloud.bigtable.config.BigtableOptions getBigtableOptions()

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

getValidate

public abstract boolean getValidate()

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(String tableId)

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

Does not modify this object.

withoutValidation

public BigtableIO.Read withoutValidation()

Disables validation that the table being read from exists.

expand

public PCollection<com.google.bigtable.v2.Row> expand(PBegin input)

Specified by:

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

validate

public void validate(PipelineOptions options)

Overrides:

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

populateDisplayData

public void populateDisplayData(DisplayData.Builder builder)

Specified by:

populateDisplayData in interface HasDisplayData

Overrides:

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

toString

public String toString()

Overrides:

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