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

Class BigtableIO.WriteWithResults

java.lang.Object

org.apache.beam.sdk.transforms.PTransform<PCollection<KV<ByteString,Iterable<com.google.bigtable.v2.Mutation>>>,PCollection<BigtableWriteResult>>

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

All Implemented Interfaces:

Serializable, HasDisplayData

Enclosing class:

BigtableIO

public static class BigtableIO.WriteWithResults
extends PTransform<PCollection<KV<ByteString,Iterable<com.google.bigtable.v2.Mutation>>>,PCollection<BigtableWriteResult>>

A PTransform that writes to Google Cloud Bigtable and emits a BigtableWriteResult for each batch written. 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

annotations, displayData, name, resourceHints

Method Summary

Modifier and Type	Method	Description
PCollection<BigtableWriteResult>	expand(PCollection<KV<ByteString,Iterable<com.google.bigtable.v2.Mutation>>> input)	Override this method to specify how this PTransform should be expanded on the given InputT.
void	populateDisplayData(DisplayData.Builder builder)	Register display data for the given transform or component.
String	toString()
void	validate(PipelineOptions options)	Called before running the Pipeline to verify this transform is fully and correctly specified.

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

addAnnotation, compose, compose, getAdditionalInputs, getAnnotations, getDefaultOutputCoder, getDefaultOutputCoder, getDefaultOutputCoder, getKindString, getName, getResourceHints, setDisplayData, setResourceHints, validate

Methods inherited from class java.lang.Object

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

Method Details

expand

public PCollection<BigtableWriteResult> expand(PCollection<KV<ByteString,Iterable<com.google.bigtable.v2.Mutation>>> input)

Description copied from class: PTransform

Override this method to specify how this PTransform should be expanded on the given InputT.

NOTE: This method should not be called directly. Instead apply the PTransform should be applied to the InputT using the apply method.

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<PCollection<KV<ByteString,Iterable<com.google.bigtable.v2.Mutation>>>,PCollection<BigtableWriteResult>>

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<PCollection<KV<ByteString,Iterable<com.google.bigtable.v2.Mutation>>>,PCollection<BigtableWriteResult>>

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<PCollection<KV<ByteString,Iterable<com.google.bigtable.v2.Mutation>>>,PCollection<BigtableWriteResult>>

Parameters:

builder - The builder to populate with display data.

See Also:

• HasDisplayData

toString

public String toString()

Overrides:

toString in class PTransform<PCollection<KV<ByteString,Iterable<com.google.bigtable.v2.Mutation>>>,PCollection<BigtableWriteResult>>