org.apache.beam.sdk.io.hadoop.format

Class HadoopFormatIO.Write<KeyT,ValueT>

java.lang.Object

org.apache.beam.sdk.transforms.PTransform<PCollection<KV<KeyT,ValueT>>,PDone>

org.apache.beam.sdk.io.hadoop.format.HadoopFormatIO.Write<KeyT,ValueT>

Type Parameters:

KeyT - Type of keys to be written.

ValueT - Type of values to be written.

All Implemented Interfaces:

java.io.Serializable, HasDisplayData

Enclosing class:

HadoopFormatIO

public static class HadoopFormatIO.Write<KeyT,ValueT>
extends PTransform<PCollection<KV<KeyT,ValueT>>,PDone>

A PTransform that writes to any data sink which implements Hadoop OutputFormat. For e.g. Cassandra, Elasticsearch, HBase, Redis, Postgres, etc. See the class-level Javadoc on HadoopFormatIO for more information.

See Also:

HadoopFormatIO, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	HadoopFormatIO.Write.ExternalSynchronizationBuilder<KeyT,ValueT> Builder for External Synchronization defining.
static interface	HadoopFormatIO.Write.PartitionedWriterBuilder<KeyT,ValueT> Builder for partitioning determining.
static interface	HadoopFormatIO.Write.WriteBuilder<KeyT,ValueT> Main builder of Write transformation.

Field Summary

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

name

Constructor Summary

Constructors

Constructor and Description
Write(org.apache.hadoop.conf.Configuration configuration, PTransform<PCollection<? extends KV<KeyT,ValueT>>,PCollectionView<org.apache.hadoop.conf.Configuration>> configTransform, ExternalSynchronization externalSynchronization, boolean withPartitioning)

Method Summary

Modifier and Type	Method and Description
PDone	expand(PCollection<KV<KeyT,ValueT>> 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.
void	validate(PipelineOptions pipelineOptions) Called before running the Pipeline to verify this transform is fully and correctly specified.

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

compose, getAdditionalInputs, getDefaultOutputCoder, getDefaultOutputCoder, getDefaultOutputCoder, getKindString, getName, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

Write

public Write(@Nullable
             org.apache.hadoop.conf.Configuration configuration,
             @Nullable
             PTransform<PCollection<? extends KV<KeyT,ValueT>>,PCollectionView<org.apache.hadoop.conf.Configuration>> configTransform,
             ExternalSynchronization externalSynchronization,
             boolean withPartitioning)

Method Detail

validate

public void validate(PipelineOptions pipelineOptions)

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<KeyT,ValueT>>,PDone>

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<KeyT,ValueT>>,PDone>

Parameters:

builder - The builder to populate with display data.

See Also:

HasDisplayData

expand

public PDone expand(PCollection<KV<KeyT,ValueT>> 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<KeyT,ValueT>>,PDone>