org.apache.beam.sdk.io

Class Write.Bound<T>

java.lang.Object

org.apache.beam.sdk.transforms.PTransform<PCollection<T>,PDone>

org.apache.beam.sdk.io.Write.Bound<T>

All Implemented Interfaces:

Serializable, HasDisplayData

Enclosing class:

Write

public static class Write.Bound<T>
extends PTransform<PCollection<T>,PDone>

A PTransform that writes to a Sink. See the class-level Javadoc for more information.

See Also:

Write, Sink, Serialized Form

Field Summary

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

name

Method Summary

Modifier and Type	Method and Description
PDone	apply(PCollection<T> input) Applies this PTransform on the given InputT, and returns its Output.
int	getNumShards() Returns the number of shards that will be produced in the output.
Sink<T>	getSink() Returns the Sink associated with this PTransform.
void	populateDisplayData(DisplayData.Builder builder) Register display data for the given transform or component.
Write.Bound<T>	withNumShards(int numShards) Returns a new Write.Bound that will write to the current Sink using the specified number of shards.

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

getDefaultOutputCoder, getDefaultOutputCoder, getDefaultOutputCoder, getKindString, getName, toString, validate

Methods inherited from class java.lang.Object

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

Method Detail

apply

public PDone apply(PCollection<T> input)

Description copied from class: PTransform

Applies this PTransform on the given InputT, and returns its Output.

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:

apply in class PTransform<PCollection<T>,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<T>,PDone>

Parameters:

builder - The builder to populate with display data.

See Also:

HasDisplayData

getNumShards

public int getNumShards()

Returns the number of shards that will be produced in the output.

See Also:

for more information

getSink

public Sink<T> getSink()

Returns the Sink associated with this PTransform.

withNumShards

public Write.Bound<T> withNumShards(int numShards)

Returns a new Write.Bound that will write to the current Sink using the specified number of shards.

This option should be used sparingly as it can hurt performance. See Write for more information.

A value less than or equal to 0 will be equivalent to the default behavior of runner-controlled sharding.