Class CombineFns.ComposedCombineFnWithContext<DataT>
- java.lang.Object
-
- org.apache.beam.sdk.transforms.CombineWithContext.CombineFnWithContext<DataT,java.lang.Object[],CombineFns.CoCombineResult>
-
- org.apache.beam.sdk.transforms.CombineFns.ComposedCombineFnWithContext<DataT>
-
- All Implemented Interfaces:
java.io.Serializable
,CombineFnBase.GlobalCombineFn<DataT,java.lang.Object[],CombineFns.CoCombineResult>
,CombineWithContext.RequiresContextInternal
,HasDisplayData
- Enclosing class:
- CombineFns
public static class CombineFns.ComposedCombineFnWithContext<DataT> extends CombineWithContext.CombineFnWithContext<DataT,java.lang.Object[],CombineFns.CoCombineResult>
A composedCombineWithContext.CombineFnWithContext
that applies multipleCombineFnWithContexts
.For each
CombineWithContext.CombineFnWithContext
it extracts inputs fromDataT
with theextractInputFn
and combines them, and then it outputs each combined value with aTupleTag
to aCombineFns.CoCombineResult
.- See Also:
- Serialized Form
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Object[]
addInput(java.lang.Object[] accumulator, DataT value, CombineWithContext.Context c)
Adds the given input value to the given accumulator, returning the new accumulator value.java.lang.Object[]
compact(java.lang.Object[] accumulator, CombineWithContext.Context c)
Returns an accumulator that represents the same logical value as the input accumulator, but may have a more compact representation.java.lang.Object[]
createAccumulator(CombineWithContext.Context c)
Returns a new, mutable accumulator value, representing the accumulation of zero input values.CombineFns.CoCombineResult
extractOutput(java.lang.Object[] accumulator, CombineWithContext.Context c)
Returns the output value that is the result of combining all the input values represented by the given accumulator.java.lang.reflect.TypeVariable<?>
getAccumTVariable()
Returns theTypeVariable
ofAccumT
.Coder<java.lang.Object[]>
getAccumulatorCoder(CoderRegistry registry, Coder<DataT> dataCoder)
Returns theCoder
to use for accumulatorAccumT
values, or null if it is not able to be inferred.Coder<OutputT>
getDefaultOutputCoder(CoderRegistry registry, Coder<InputT> inputCoder)
Returns theCoder
to use by default for outputOutputT
values, or null if it is not able to be inferred.java.lang.String
getIncompatibleGlobalWindowErrorMessage()
Returns the error message for not supported default values in Combine.globally().java.lang.reflect.TypeVariable<?>
getInputTVariable()
Returns theTypeVariable
ofInputT
.java.lang.reflect.TypeVariable<?>
getOutputTVariable()
Returns theTypeVariable
ofOutputT
.java.lang.Object[]
mergeAccumulators(java.lang.Iterable<java.lang.Object[]> accumulators, CombineWithContext.Context c)
Returns an accumulator representing the accumulation of all the input values accumulated in the merging accumulators.void
populateDisplayData(DisplayData.Builder builder)
Register display data for the given transform or component.<InputT,OutputT>
CombineFns.ComposedCombineFnWithContext<DataT>with(SimpleFunction<DataT,InputT> extractInputFn, Coder<InputT> combineInputCoder, CombineFnBase.GlobalCombineFn<InputT,?,OutputT> globalCombineFn, TupleTag<OutputT> outputTag)
Returns aCombineFns.ComposedCombineFnWithContext
with an additionalCombineFnBase.GlobalCombineFn
.<InputT,OutputT>
CombineFns.ComposedCombineFnWithContext<DataT>with(SimpleFunction<DataT,InputT> extractInputFn, CombineFnBase.GlobalCombineFn<InputT,?,OutputT> globalCombineFn, TupleTag<OutputT> outputTag)
Returns aCombineFns.ComposedCombineFnWithContext
with an additionalCombineFnBase.GlobalCombineFn
.-
Methods inherited from class org.apache.beam.sdk.transforms.CombineWithContext.CombineFnWithContext
apply, defaultValue
-
-
-
-
Method Detail
-
with
public <InputT,OutputT> CombineFns.ComposedCombineFnWithContext<DataT> with(SimpleFunction<DataT,InputT> extractInputFn, CombineFnBase.GlobalCombineFn<InputT,?,OutputT> globalCombineFn, TupleTag<OutputT> outputTag)
Returns aCombineFns.ComposedCombineFnWithContext
with an additionalCombineFnBase.GlobalCombineFn
.
-
with
public <InputT,OutputT> CombineFns.ComposedCombineFnWithContext<DataT> with(SimpleFunction<DataT,InputT> extractInputFn, Coder<InputT> combineInputCoder, CombineFnBase.GlobalCombineFn<InputT,?,OutputT> globalCombineFn, TupleTag<OutputT> outputTag)
Returns aCombineFns.ComposedCombineFnWithContext
with an additionalCombineFnBase.GlobalCombineFn
.
-
createAccumulator
public java.lang.Object[] createAccumulator(CombineWithContext.Context c)
Description copied from class:CombineWithContext.CombineFnWithContext
Returns a new, mutable accumulator value, representing the accumulation of zero input values.It is equivalent to
Combine.CombineFn.createAccumulator()
, but it has additional access toCombineWithContext.Context
.- Specified by:
createAccumulator
in classCombineWithContext.CombineFnWithContext<DataT,java.lang.Object[],CombineFns.CoCombineResult>
-
addInput
public java.lang.Object[] addInput(java.lang.Object[] accumulator, DataT value, CombineWithContext.Context c)
Description copied from class:CombineWithContext.CombineFnWithContext
Adds the given input value to the given accumulator, returning the new accumulator value.It is equivalent to
Combine.CombineFn.addInput(AccumT, InputT)
, but it has additional access toCombineWithContext.Context
.- Specified by:
addInput
in classCombineWithContext.CombineFnWithContext<DataT,java.lang.Object[],CombineFns.CoCombineResult>
-
mergeAccumulators
public java.lang.Object[] mergeAccumulators(java.lang.Iterable<java.lang.Object[]> accumulators, CombineWithContext.Context c)
Description copied from class:CombineWithContext.CombineFnWithContext
Returns an accumulator representing the accumulation of all the input values accumulated in the merging accumulators.It is equivalent to
Combine.CombineFn.mergeAccumulators(java.lang.Iterable<AccumT>)
, but it has additional access toCombineWithContext.Context
.- Specified by:
mergeAccumulators
in classCombineWithContext.CombineFnWithContext<DataT,java.lang.Object[],CombineFns.CoCombineResult>
-
extractOutput
public CombineFns.CoCombineResult extractOutput(java.lang.Object[] accumulator, CombineWithContext.Context c)
Description copied from class:CombineWithContext.CombineFnWithContext
Returns the output value that is the result of combining all the input values represented by the given accumulator.It is equivalent to
Combine.CombineFn.extractOutput(AccumT)
, but it has additional access toCombineWithContext.Context
.- Specified by:
extractOutput
in classCombineWithContext.CombineFnWithContext<DataT,java.lang.Object[],CombineFns.CoCombineResult>
-
compact
public java.lang.Object[] compact(java.lang.Object[] accumulator, CombineWithContext.Context c)
Description copied from class:CombineWithContext.CombineFnWithContext
Returns an accumulator that represents the same logical value as the input accumulator, but may have a more compact representation.It is equivalent to
Combine.CombineFn.compact(AccumT)
, but it has additional access toCombineWithContext.Context
.- Overrides:
compact
in classCombineWithContext.CombineFnWithContext<DataT,java.lang.Object[],CombineFns.CoCombineResult>
-
getAccumulatorCoder
public Coder<java.lang.Object[]> getAccumulatorCoder(CoderRegistry registry, Coder<DataT> dataCoder) throws CannotProvideCoderException
Description copied from interface:CombineFnBase.GlobalCombineFn
Returns theCoder
to use for accumulatorAccumT
values, or null if it is not able to be inferred.By default, uses the knowledge of the
Coder
being used forInputT
values and the enclosingPipeline
'sCoderRegistry
to try to infer the Coder forAccumT
values.This is the Coder used to send data through a communication-intensive shuffle step, so a compact and efficient representation may have significant performance benefits.
- Specified by:
getAccumulatorCoder
in interfaceCombineFnBase.GlobalCombineFn<DataT,java.lang.Object[],CombineFns.CoCombineResult>
- Throws:
CannotProvideCoderException
-
populateDisplayData
public void populateDisplayData(DisplayData.Builder builder)
Register display data for the given transform or component.populateDisplayData(DisplayData.Builder)
is invoked by Pipeline runners to collect display data viaDisplayData.from(HasDisplayData)
. Implementations may callsuper.populateDisplayData(builder)
in order to register display data in the current namespace, but should otherwise usesubcomponent.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 interfaceHasDisplayData
- Parameters:
builder
- The builder to populate with display data.- See Also:
HasDisplayData
-
getDefaultOutputCoder
public Coder<OutputT> getDefaultOutputCoder(CoderRegistry registry, Coder<InputT> inputCoder) throws CannotProvideCoderException
Description copied from interface:CombineFnBase.GlobalCombineFn
Returns theCoder
to use by default for outputOutputT
values, or null if it is not able to be inferred.By default, uses the knowledge of the
Coder
being used for inputInputT
values and the enclosingPipeline
'sCoderRegistry
to try to infer the Coder forOutputT
values.- Specified by:
getDefaultOutputCoder
in interfaceCombineFnBase.GlobalCombineFn<InputT,AccumT,OutputT>
- Throws:
CannotProvideCoderException
-
getIncompatibleGlobalWindowErrorMessage
public java.lang.String getIncompatibleGlobalWindowErrorMessage()
Description copied from interface:CombineFnBase.GlobalCombineFn
Returns the error message for not supported default values in Combine.globally().- Specified by:
getIncompatibleGlobalWindowErrorMessage
in interfaceCombineFnBase.GlobalCombineFn<InputT,AccumT,OutputT>
-
getInputTVariable
public java.lang.reflect.TypeVariable<?> getInputTVariable()
Returns theTypeVariable
ofInputT
.
-
getAccumTVariable
public java.lang.reflect.TypeVariable<?> getAccumTVariable()
Returns theTypeVariable
ofAccumT
.
-
getOutputTVariable
public java.lang.reflect.TypeVariable<?> getOutputTVariable()
Returns theTypeVariable
ofOutputT
.
-
-