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

Class BigtableIO.Write

java.lang.Object

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>

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

All Implemented Interfaces:

java.io.Serializable, org.apache.beam.sdk.transforms.display.HasDisplayData

Enclosing class:

BigtableIO

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>

A PTransform that writes to 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, resourceHints

Constructor Summary

Constructors

Constructor	Description
Write()

Method Summary

Modifier and Type	Method	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 options)	Deprecated. will be replaced by bigtable options configurator.
BigtableIO.Write	withBigtableOptions(com.google.cloud.bigtable.config.BigtableOptions.Builder optionsBuilder)	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	withEmulator(java.lang.String emulatorHost)	Returns a new BigtableIO.Write that will use an official Bigtable emulator.
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.

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

compose, compose, getAdditionalInputs, getDefaultOutputCoder, getDefaultOutputCoder, getDefaultOutputCoder, getKindString, getName, getResourceHints, setResourceHints, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

Write

public Write()

Method Detail

getBigtableOptions

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

Deprecated.

will be replaced by bigtable options configurator.

Returns the Google Cloud Bigtable instance being written to, and other parameters.

withProjectId

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

Does not modify this object.

withProjectId

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

Does not modify this object.

withInstanceId

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

Does not modify this object.

withInstanceId

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

Does not modify this object.

withTableId

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

Does not modify this object.

withTableId

public BigtableIO.Write withTableId(java.lang.String tableId)

Returns a new BigtableIO.Write that will write to the specified table.

Does not modify this object.

withBigtableOptions

@Deprecated
public BigtableIO.Write withBigtableOptions(com.google.cloud.bigtable.config.BigtableOptions options)

Deprecated.

will be replaced by bigtable options configurator.

WARNING: Should be used only to specify additional parameters for connection to the Cloud Bigtable, instanceId and projectId should be provided over 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.

withBigtableOptions

@Deprecated
public BigtableIO.Write withBigtableOptions(com.google.cloud.bigtable.config.BigtableOptions.Builder optionsBuilder)

Deprecated.

will be replaced by bigtable options configurator.

WARNING: Should be used only to specify additional parameters for connection to the Cloud Bigtable, instanceId and projectId should be provided over 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.

withBigtableOptionsConfigurator

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)

Returns a new 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.

withoutValidation

public BigtableIO.Write withoutValidation()

Disables validation that the table being written to exists.

withEmulator

public BigtableIO.Write withEmulator(java.lang.String emulatorHost)

Returns a new BigtableIO.Write that will use an official Bigtable emulator.

This is used for testing.

withWriteResults

public BigtableIO.WriteWithResults withWriteResults()

Returns a BigtableIO.WriteWithResults that will emit a BigtableWriteResult for each batch of rows written.

expand

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)

Specified by:

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>

validate

public void validate(org.apache.beam.sdk.options.PipelineOptions options)

Overrides:

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>

populateDisplayData

public void populateDisplayData(org.apache.beam.sdk.transforms.display.DisplayData.Builder builder)

Specified by:

populateDisplayData in interface org.apache.beam.sdk.transforms.display.HasDisplayData

Overrides:

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>

toString

public final java.lang.String toString()

Overrides:

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>