com.google.cloud.dataflow.sdk.values

Class TypedPValue<T>

java.lang.Object

com.google.cloud.dataflow.sdk.values.POutputValueBase

com.google.cloud.dataflow.sdk.values.PValueBase

com.google.cloud.dataflow.sdk.values.TypedPValue<T>

Type Parameters:

T - the type of the values stored in this TypedPValue

All Implemented Interfaces:

PInput, POutput, PValue

Direct Known Subclasses:

PCollection

public abstract class TypedPValue<T>
extends PValueBase
implements PValue

A TypedPValue<T> is the abstract base class of things that store some number of values of type T. Because we know the type T, this is the layer of the inheritance hierarchy where we store a coder for objects of type T

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TypedPValue()

Method Summary

Methods

Modifier and Type	Method and Description
void	finishSpecifying() After building, finalizes this PValue to make it ready for running.
Coder<T>	getCoder() Returns the Coder used by this TypedPValue to encode and decode the values stored in it.
com.google.common.reflect.TypeToken<T>	getTypeToken() Returns a TypeToken<T> with some reflective information about T, if possible.
void	recordAsOutput(Pipeline pipeline, PTransform<?,?> transform, java.lang.String outName) Records that this POutputValueBase is an output with the given name of the given PTransform in the given Pipeline.
TypedPValue<T>	setCoder(Coder<T> coder) Sets the Coder used by this TypedPValue to encode and decode the values stored in it.
TypedPValue<T>	setPipelineInternal(Pipeline pipeline) Sets the owning Pipeline of this PValueBase.
TypedPValue<T>	setTypeTokenInternal(com.google.common.reflect.TypeToken<T> typeToken) Sets the TypeToken<T> associated with this class.

Methods inherited from class com.google.cloud.dataflow.sdk.values.PValueBase

expand, getKindString, getName, getPipeline, isFinishedSpecifyingInternal, recordAsOutput, setName, toString

Methods inherited from class com.google.cloud.dataflow.sdk.values.POutputValueBase

finishSpecifyingOutput, getProducingTransformInternal

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.cloud.dataflow.sdk.values.PValue

getName, getProducingTransformInternal

Methods inherited from interface com.google.cloud.dataflow.sdk.values.POutput

expand, finishSpecifyingOutput, recordAsOutput

Methods inherited from interface com.google.cloud.dataflow.sdk.values.PInput

expand, getPipeline

Constructor Detail

TypedPValue

protected TypedPValue()

Method Detail

getCoder

public Coder<T> getCoder()

Returns the Coder used by this TypedPValue to encode and decode the values stored in it.

Throws:

java.lang.IllegalStateException - if the Coder hasn't been set, and couldn't be inferred

setCoder

public TypedPValue<T> setCoder(Coder<T> coder)

Sets the Coder used by this TypedPValue to encode and decode the values stored in it. Returns this.

Throws:

java.lang.IllegalStateException - if this TypedPValue has already been finalized and is no longer settable, e.g., by having apply() called on it

recordAsOutput

public void recordAsOutput(Pipeline pipeline,
                  PTransform<?,?> transform,
                  java.lang.String outName)

Description copied from class: PValueBase

Records that this POutputValueBase is an output with the given name of the given PTransform in the given Pipeline.

To be invoked only by POutput.recordAsOutput(com.google.cloud.dataflow.sdk.Pipeline, com.google.cloud.dataflow.sdk.transforms.PTransform<?, ?>) implementations. Not to be invoked directly by user code.

Overrides:

recordAsOutput in class PValueBase

setPipelineInternal

public TypedPValue<T> setPipelineInternal(Pipeline pipeline)

Description copied from class: PValueBase

Sets the owning Pipeline of this PValueBase. Returns this.

For internal use only.

Specified by:

setPipelineInternal in interface PValue

Overrides:

setPipelineInternal in class PValueBase

finishSpecifying

public void finishSpecifying()

After building, finalizes this PValue to make it ready for running. Automatically invoked whenever the PValue is "used" (e.g., when apply() is called on it) and when the Pipeline is run (useful if this is a PValue with no consumers).

Specified by:

finishSpecifying in interface PInput

Overrides:

finishSpecifying in class PValueBase

getTypeToken

public com.google.common.reflect.TypeToken<T> getTypeToken()

Returns a TypeToken<T> with some reflective information about T, if possible. May return null if no information is available. Subclasses may override this to enable better Coder inference.

setTypeTokenInternal

public TypedPValue<T> setTypeTokenInternal(com.google.common.reflect.TypeToken<T> typeToken)

Sets the TypeToken<T> associated with this class. Better reflective type information will lead to better Coder inference.