public abstract static class BigtableIO.Read
extends org.apache.beam.sdk.transforms.PTransform<org.apache.beam.sdk.values.PBegin,org.apache.beam.sdk.values.PCollection<com.google.bigtable.v2.Row>>
PTransform
that reads from Google Cloud Bigtable. See the class-level Javadoc on
BigtableIO
for more information.BigtableIO
,
Serialized FormConstructor and Description |
---|
Read() |
Modifier and Type | Method and Description |
---|---|
org.apache.beam.sdk.values.PCollection<com.google.bigtable.v2.Row> |
expand(org.apache.beam.sdk.values.PBegin input) |
@Nullable com.google.cloud.bigtable.config.BigtableOptions |
getBigtableOptions()
Deprecated.
will be replaced by bigtable options configurator.
|
@Nullable java.lang.String |
getTableId()
Returns the table being read from.
|
void |
populateDisplayData(org.apache.beam.sdk.transforms.display.DisplayData.Builder builder) |
java.lang.String |
toString() |
void |
validate(org.apache.beam.sdk.options.PipelineOptions options) |
BigtableIO.Read |
withBigtableOptions(com.google.cloud.bigtable.config.BigtableOptions.Builder optionsBuilder)
Deprecated.
will be replaced by bigtable options configurator.
|
BigtableIO.Read |
withBigtableOptions(com.google.cloud.bigtable.config.BigtableOptions options)
Deprecated.
will be replaced by bigtable options configurator.
|
BigtableIO.Read |
withBigtableOptionsConfigurator(org.apache.beam.sdk.transforms.SerializableFunction<com.google.cloud.bigtable.config.BigtableOptions.Builder,com.google.cloud.bigtable.config.BigtableOptions.Builder> configurator)
Returns a new
BigtableIO.Read that will read from the Cloud Bigtable instance with
customized options provided by given configurator. |
BigtableIO.Read |
withEmulator(java.lang.String emulatorHost)
Returns a new
BigtableIO.Read that will use an official Bigtable emulator. |
BigtableIO.Read |
withInstanceId(java.lang.String instanceId)
Returns a new
BigtableIO.Read that will read from the Cloud Bigtable instance
indicated by given parameter, requires withProjectId(org.apache.beam.sdk.options.ValueProvider<java.lang.String>) to be called to determine the
project. |
BigtableIO.Read |
withInstanceId(org.apache.beam.sdk.options.ValueProvider<java.lang.String> instanceId)
Returns a new
BigtableIO.Read that will read from the Cloud Bigtable instance
indicated by given parameter, requires withProjectId(org.apache.beam.sdk.options.ValueProvider<java.lang.String>) to be called to determine the
project. |
BigtableIO.Read |
withKeyRange(org.apache.beam.sdk.io.range.ByteKeyRange keyRange)
Returns a new
BigtableIO.Read that will read only rows in the specified range. |
BigtableIO.Read |
withKeyRanges(java.util.List<org.apache.beam.sdk.io.range.ByteKeyRange> keyRanges)
Returns a new
BigtableIO.Read that will read only rows in the specified ranges. |
BigtableIO.Read |
withKeyRanges(org.apache.beam.sdk.options.ValueProvider<java.util.List<org.apache.beam.sdk.io.range.ByteKeyRange>> keyRanges)
Returns a new
BigtableIO.Read that will read only rows in the specified ranges. |
BigtableIO.Read |
withoutValidation()
Disables validation that the table being read from exists.
|
BigtableIO.Read |
withProjectId(java.lang.String projectId)
Returns a new
BigtableIO.Read that will read from the Cloud Bigtable project
indicated by given parameter, requires withInstanceId(org.apache.beam.sdk.options.ValueProvider<java.lang.String>) to be called to determine the
instance. |
BigtableIO.Read |
withProjectId(org.apache.beam.sdk.options.ValueProvider<java.lang.String> projectId)
Returns a new
BigtableIO.Read that will read from the Cloud Bigtable project
indicated by given parameter, requires withInstanceId(org.apache.beam.sdk.options.ValueProvider<java.lang.String>) to be called to determine the
instance. |
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 |
withRowFilter(org.apache.beam.sdk.options.ValueProvider<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. |
BigtableIO.Read |
withTableId(org.apache.beam.sdk.options.ValueProvider<java.lang.String> tableId)
Returns a new
BigtableIO.Read that will read from the specified table. |
public @Nullable java.lang.String getTableId()
@Deprecated public @Nullable com.google.cloud.bigtable.config.BigtableOptions getBigtableOptions()
public BigtableIO.Read withProjectId(org.apache.beam.sdk.options.ValueProvider<java.lang.String> projectId)
BigtableIO.Read
that will read from the Cloud Bigtable project
indicated by given parameter, requires withInstanceId(org.apache.beam.sdk.options.ValueProvider<java.lang.String>)
to be called to determine the
instance.
Does not modify this object.
public BigtableIO.Read withProjectId(java.lang.String projectId)
BigtableIO.Read
that will read from the Cloud Bigtable project
indicated by given parameter, requires withInstanceId(org.apache.beam.sdk.options.ValueProvider<java.lang.String>)
to be called to determine the
instance.
Does not modify this object.
public BigtableIO.Read withInstanceId(org.apache.beam.sdk.options.ValueProvider<java.lang.String> instanceId)
BigtableIO.Read
that will read from the Cloud Bigtable instance
indicated by given parameter, requires withProjectId(org.apache.beam.sdk.options.ValueProvider<java.lang.String>)
to be called to determine the
project.
Does not modify this object.
public BigtableIO.Read withInstanceId(java.lang.String instanceId)
BigtableIO.Read
that will read from the Cloud Bigtable instance
indicated by given parameter, requires withProjectId(org.apache.beam.sdk.options.ValueProvider<java.lang.String>)
to be called to determine the
project.
Does not modify this object.
public BigtableIO.Read withTableId(org.apache.beam.sdk.options.ValueProvider<java.lang.String> tableId)
BigtableIO.Read
that will read from the specified table.
Does not modify this object.
public BigtableIO.Read withTableId(java.lang.String tableId)
BigtableIO.Read
that will read from the specified table.
Does not modify this object.
@Deprecated public BigtableIO.Read withBigtableOptions(com.google.cloud.bigtable.config.BigtableOptions options)
withInstanceId(org.apache.beam.sdk.options.ValueProvider<java.lang.String>)
and withProjectId(org.apache.beam.sdk.options.ValueProvider<java.lang.String>)
respectively.
Returns a new BigtableIO.Read
that will read from the Cloud Bigtable instance
indicated by withProjectId(org.apache.beam.sdk.options.ValueProvider<java.lang.String>)
, and using any other specified customizations.
Does not modify this object.
@Deprecated public BigtableIO.Read withBigtableOptions(com.google.cloud.bigtable.config.BigtableOptions.Builder optionsBuilder)
withInstanceId(org.apache.beam.sdk.options.ValueProvider<java.lang.String>)
and withProjectId(org.apache.beam.sdk.options.ValueProvider<java.lang.String>)
respectively.
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.
public BigtableIO.Read withBigtableOptionsConfigurator(org.apache.beam.sdk.transforms.SerializableFunction<com.google.cloud.bigtable.config.BigtableOptions.Builder,com.google.cloud.bigtable.config.BigtableOptions.Builder> configurator)
BigtableIO.Read
that will read from the Cloud Bigtable instance with
customized options provided by given configurator.
WARNING: instanceId and projectId should not be provided here and should be provided over
withProjectId(org.apache.beam.sdk.options.ValueProvider<java.lang.String>)
and withInstanceId(org.apache.beam.sdk.options.ValueProvider<java.lang.String>)
.
Does not modify this object.
public BigtableIO.Read withRowFilter(org.apache.beam.sdk.options.ValueProvider<com.google.bigtable.v2.RowFilter> filter)
BigtableIO.Read
that will filter the rows read from Cloud Bigtable
using the given row filter.
Does not modify this object.
public BigtableIO.Read withRowFilter(com.google.bigtable.v2.RowFilter filter)
BigtableIO.Read
that will filter the rows read from Cloud Bigtable
using the given row filter.
Does not modify this object.
public BigtableIO.Read withKeyRange(org.apache.beam.sdk.io.range.ByteKeyRange keyRange)
BigtableIO.Read
that will read only rows in the specified range.
Does not modify this object.
public BigtableIO.Read withKeyRanges(org.apache.beam.sdk.options.ValueProvider<java.util.List<org.apache.beam.sdk.io.range.ByteKeyRange>> keyRanges)
BigtableIO.Read
that will read only rows in the specified ranges.
Ranges must not overlap.
Does not modify this object.
public BigtableIO.Read withKeyRanges(java.util.List<org.apache.beam.sdk.io.range.ByteKeyRange> keyRanges)
BigtableIO.Read
that will read only rows in the specified ranges.
Ranges must not overlap.
Does not modify this object.
public BigtableIO.Read withoutValidation()
public BigtableIO.Read withEmulator(java.lang.String emulatorHost)
BigtableIO.Read
that will use an official Bigtable emulator.
This is used for testing.
public org.apache.beam.sdk.values.PCollection<com.google.bigtable.v2.Row> expand(org.apache.beam.sdk.values.PBegin input)
expand
in class org.apache.beam.sdk.transforms.PTransform<org.apache.beam.sdk.values.PBegin,org.apache.beam.sdk.values.PCollection<com.google.bigtable.v2.Row>>
public void validate(org.apache.beam.sdk.options.PipelineOptions options)
validate
in class org.apache.beam.sdk.transforms.PTransform<org.apache.beam.sdk.values.PBegin,org.apache.beam.sdk.values.PCollection<com.google.bigtable.v2.Row>>
public void populateDisplayData(org.apache.beam.sdk.transforms.display.DisplayData.Builder builder)
populateDisplayData
in interface org.apache.beam.sdk.transforms.display.HasDisplayData
populateDisplayData
in class org.apache.beam.sdk.transforms.PTransform<org.apache.beam.sdk.values.PBegin,org.apache.beam.sdk.values.PCollection<com.google.bigtable.v2.Row>>
public java.lang.String toString()
toString
in class org.apache.beam.sdk.transforms.PTransform<org.apache.beam.sdk.values.PBegin,org.apache.beam.sdk.values.PCollection<com.google.bigtable.v2.Row>>