public abstract static class BigtableIO.Write
extends org.apache.beam.sdk.transforms.PTransform<org.apache.beam.sdk.values.PCollection<org.apache.beam.sdk.values.KV<com.google.protobuf.ByteString,java.lang.Iterable<com.google.bigtable.v2.Mutation>>>,org.apache.beam.sdk.values.PDone>
PTransform
that writes to Google Cloud Bigtable. See the class-level Javadoc on
BigtableIO
for more information.BigtableIO
,
Serialized FormConstructor and Description |
---|
Write() |
Modifier and Type | Method and Description |
---|---|
org.apache.beam.sdk.values.PDone |
expand(org.apache.beam.sdk.values.PCollection<org.apache.beam.sdk.values.KV<com.google.protobuf.ByteString,java.lang.Iterable<com.google.bigtable.v2.Mutation>>> input) |
@Nullable com.google.cloud.bigtable.config.BigtableOptions |
getBigtableOptions()
Deprecated.
will be replaced by bigtable options configurator.
|
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.Write |
withBigtableOptions(com.google.cloud.bigtable.config.BigtableOptions.Builder optionsBuilder)
Deprecated.
will be replaced by bigtable options configurator.
|
BigtableIO.Write |
withBigtableOptions(com.google.cloud.bigtable.config.BigtableOptions options)
Deprecated.
will be replaced by bigtable options configurator.
|
BigtableIO.Write |
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.Write that will read from the Cloud Bigtable instance with
customized options provided by given configurator. |
BigtableIO.Write |
withInstanceId(java.lang.String instanceId)
Returns a new
BigtableIO.Write that will write into 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.Write |
withInstanceId(org.apache.beam.sdk.options.ValueProvider<java.lang.String> instanceId)
Returns a new
BigtableIO.Write that will write into 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.Write |
withoutValidation()
Disables validation that the table being written to exists.
|
BigtableIO.Write |
withProjectId(java.lang.String projectId)
Returns a new
BigtableIO.Write that will write into 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.Write |
withProjectId(org.apache.beam.sdk.options.ValueProvider<java.lang.String> projectId)
Returns a new
BigtableIO.Write that will write into 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.Write |
withTableId(java.lang.String tableId)
Returns a new
BigtableIO.Write that will write to the specified table. |
BigtableIO.Write |
withTableId(org.apache.beam.sdk.options.ValueProvider<java.lang.String> tableId)
Returns a new
BigtableIO.Write that will write to the specified table. |
BigtableIO.WriteWithResults |
withWriteResults()
Returns a
BigtableIO.WriteWithResults that will emit a BigtableWriteResult
for each batch of rows written. |
@Deprecated public @Nullable com.google.cloud.bigtable.config.BigtableOptions getBigtableOptions()
public BigtableIO.Write withProjectId(org.apache.beam.sdk.options.ValueProvider<java.lang.String> projectId)
BigtableIO.Write
that will write into 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.Write withProjectId(java.lang.String projectId)
BigtableIO.Write
that will write into 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.Write withInstanceId(org.apache.beam.sdk.options.ValueProvider<java.lang.String> instanceId)
BigtableIO.Write
that will write into 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.Write withInstanceId(java.lang.String instanceId)
BigtableIO.Write
that will write into 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.Write withTableId(org.apache.beam.sdk.options.ValueProvider<java.lang.String> tableId)
BigtableIO.Write
that will write to the specified table.
Does not modify this object.
public BigtableIO.Write withTableId(java.lang.String tableId)
BigtableIO.Write
that will write to the specified table.
Does not modify this object.
@Deprecated public BigtableIO.Write 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.Write
that will write to the Cloud Bigtable instance
indicated by the given options, and using any other specified customizations.
Does not modify this object.
@Deprecated public BigtableIO.Write 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.Write
that will write to 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.Write
.
Does not modify this object.
public BigtableIO.Write withBigtableOptionsConfigurator(org.apache.beam.sdk.transforms.SerializableFunction<com.google.cloud.bigtable.config.BigtableOptions.Builder,com.google.cloud.bigtable.config.BigtableOptions.Builder> configurator)
BigtableIO.Write
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.Write withoutValidation()
public BigtableIO.WriteWithResults withWriteResults()
BigtableIO.WriteWithResults
that will emit a BigtableWriteResult
for each batch of rows written.public org.apache.beam.sdk.values.PDone expand(org.apache.beam.sdk.values.PCollection<org.apache.beam.sdk.values.KV<com.google.protobuf.ByteString,java.lang.Iterable<com.google.bigtable.v2.Mutation>>> input)
expand
in class org.apache.beam.sdk.transforms.PTransform<org.apache.beam.sdk.values.PCollection<org.apache.beam.sdk.values.KV<com.google.protobuf.ByteString,java.lang.Iterable<com.google.bigtable.v2.Mutation>>>,org.apache.beam.sdk.values.PDone>
public void validate(org.apache.beam.sdk.options.PipelineOptions options)
validate
in class org.apache.beam.sdk.transforms.PTransform<org.apache.beam.sdk.values.PCollection<org.apache.beam.sdk.values.KV<com.google.protobuf.ByteString,java.lang.Iterable<com.google.bigtable.v2.Mutation>>>,org.apache.beam.sdk.values.PDone>
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.PCollection<org.apache.beam.sdk.values.KV<com.google.protobuf.ByteString,java.lang.Iterable<com.google.bigtable.v2.Mutation>>>,org.apache.beam.sdk.values.PDone>
public java.lang.String toString()
toString
in class org.apache.beam.sdk.transforms.PTransform<org.apache.beam.sdk.values.PCollection<org.apache.beam.sdk.values.KV<com.google.protobuf.ByteString,java.lang.Iterable<com.google.bigtable.v2.Mutation>>>,org.apache.beam.sdk.values.PDone>