org.apache.beam.sdk.util

Class DoFnInfo<InputT,OutputT>

java.lang.Object

org.apache.beam.sdk.util.DoFnInfo<InputT,OutputT>

Type Parameters:

InputT - the type of the (main) input elements of the DoFn

OutputT - the type of the (main) output elements of the DoFn

All Implemented Interfaces:

java.io.Serializable

@Internal
public class DoFnInfo<InputT,OutputT>
extends java.lang.Object
implements java.io.Serializable

Wrapper class holding the necessary information to serialize a DoFn.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
static <InputT,OutputT> DoFnInfo<InputT,OutputT>	forFn(DoFn<InputT,OutputT> doFn, WindowingStrategy<?,?> windowingStrategy, java.lang.Iterable<PCollectionView<?>> sideInputViews, Coder<InputT> inputCoder, java.util.Map<TupleTag<?>,Coder<?>> outputCoders, TupleTag<OutputT> mainOutput, DoFnSchemaInformation doFnSchemaInformation, java.util.Map<java.lang.String,PCollectionView<?>> sideInputMapping) Creates a DoFnInfo for the given DoFn.
static <InputT,OutputT> DoFnInfo<InputT,OutputT>	forFn(DoFn<InputT,OutputT> doFn, WindowingStrategy<?,?> windowingStrategy, java.lang.Iterable<PCollectionView<?>> sideInputViews, Coder<InputT> inputCoder, TupleTag<OutputT> mainOutput, DoFnSchemaInformation doFnSchemaInformation, java.util.Map<java.lang.String,PCollectionView<?>> sideInputMapping) Creates a DoFnInfo for the given DoFn.
DoFn<InputT,OutputT>	getDoFn() Returns the embedded function.
DoFnSchemaInformation	getDoFnSchemaInformation()
Coder<InputT>	getInputCoder()
TupleTag<OutputT>	getMainOutput()
java.util.Map<TupleTag<?>,Coder<?>>	getOutputCoders()
java.util.Map<java.lang.String,PCollectionView<?>>	getSideInputMapping()
java.lang.Iterable<PCollectionView<?>>	getSideInputViews()
WindowingStrategy<?,?>	getWindowingStrategy()
DoFnInfo<InputT,OutputT>	withFn(DoFn<InputT,OutputT> newFn)

Methods inherited from class java.lang.Object

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

Method Detail

forFn

public static <InputT,OutputT> DoFnInfo<InputT,OutputT> forFn(DoFn<InputT,OutputT> doFn,
                                                              WindowingStrategy<?,?> windowingStrategy,
                                                              java.lang.Iterable<PCollectionView<?>> sideInputViews,
                                                              Coder<InputT> inputCoder,
                                                              TupleTag<OutputT> mainOutput,
                                                              DoFnSchemaInformation doFnSchemaInformation,
                                                              java.util.Map<java.lang.String,PCollectionView<?>> sideInputMapping)

Creates a DoFnInfo for the given DoFn.

This method exists for backwards compatibility with the Dataflow runner. Once the Dataflow runner has been updated to use the new constructor, remove this one.

forFn

public static <InputT,OutputT> DoFnInfo<InputT,OutputT> forFn(DoFn<InputT,OutputT> doFn,
                                                              WindowingStrategy<?,?> windowingStrategy,
                                                              java.lang.Iterable<PCollectionView<?>> sideInputViews,
                                                              Coder<InputT> inputCoder,
                                                              java.util.Map<TupleTag<?>,Coder<?>> outputCoders,
                                                              TupleTag<OutputT> mainOutput,
                                                              DoFnSchemaInformation doFnSchemaInformation,
                                                              java.util.Map<java.lang.String,PCollectionView<?>> sideInputMapping)

Creates a DoFnInfo for the given DoFn.

withFn

public DoFnInfo<InputT,OutputT> withFn(DoFn<InputT,OutputT> newFn)

getDoFn

public DoFn<InputT,OutputT> getDoFn()

Returns the embedded function.

getWindowingStrategy

public WindowingStrategy<?,?> getWindowingStrategy()

getSideInputViews

public java.lang.Iterable<PCollectionView<?>> getSideInputViews()

getInputCoder

public Coder<InputT> getInputCoder()

getOutputCoders

public java.util.Map<TupleTag<?>,Coder<?>> getOutputCoders()

getMainOutput

public TupleTag<OutputT> getMainOutput()

getDoFnSchemaInformation

public DoFnSchemaInformation getDoFnSchemaInformation()

getSideInputMapping

public java.util.Map<java.lang.String,PCollectionView<?>> getSideInputMapping()