Class CombineWithContext.CombineFnWithContext<InputT,AccumT,OutputT>
- java.lang.Object
-
- org.apache.beam.sdk.transforms.CombineWithContext.CombineFnWithContext<InputT,AccumT,OutputT>
-
- All Implemented Interfaces:
java.io.Serializable
,CombineFnBase.GlobalCombineFn<InputT,AccumT,OutputT>
,CombineWithContext.RequiresContextInternal
,HasDisplayData
- Direct Known Subclasses:
CombineFns.ComposedCombineFnWithContext
- Enclosing class:
- CombineWithContext
public abstract static class CombineWithContext.CombineFnWithContext<InputT,AccumT,OutputT> extends java.lang.Object implements CombineWithContext.RequiresContextInternal
A combine function that has access toPipelineOptions
and side inputs throughCombineWithContext.Context
.See the equivalent
Combine.CombineFn
for details about combine functions.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description CombineFnWithContext()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract AccumT
addInput(AccumT accumulator, InputT input, CombineWithContext.Context c)
Adds the given input value to the given accumulator, returning the new accumulator value.OutputT
apply(java.lang.Iterable<? extends InputT> inputs, CombineWithContext.Context c)
Applies thisCombineFnWithContext
to a collection of input values to produce a combined output value.AccumT
compact(AccumT accumulator, CombineWithContext.Context c)
Returns an accumulator that represents the same logical value as the input accumulator, but may have a more compact representation.abstract AccumT
createAccumulator(CombineWithContext.Context c)
Returns a new, mutable accumulator value, representing the accumulation of zero input values.OutputT
defaultValue()
Returns the default value when there are no values added to the accumulator.abstract OutputT
extractOutput(AccumT 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<AccumT>
getAccumulatorCoder(CoderRegistry registry, Coder<InputT> inputCoder)
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
.abstract AccumT
mergeAccumulators(java.lang.Iterable<AccumT> 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.
-
-
-
Method Detail
-
createAccumulator
public abstract AccumT createAccumulator(CombineWithContext.Context c)
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
.
-
addInput
public abstract AccumT addInput(AccumT accumulator, InputT input, CombineWithContext.Context c)
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
.
-
mergeAccumulators
public abstract AccumT mergeAccumulators(java.lang.Iterable<AccumT> accumulators, CombineWithContext.Context c)
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
.
-
extractOutput
public abstract OutputT extractOutput(AccumT accumulator, CombineWithContext.Context c)
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
.
-
compact
public AccumT compact(AccumT accumulator, CombineWithContext.Context c)
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
.
-
apply
public OutputT apply(java.lang.Iterable<? extends InputT> inputs, CombineWithContext.Context c)
Applies thisCombineFnWithContext
to a collection of input values to produce a combined output value.
-
defaultValue
public OutputT defaultValue()
Description copied from interface:CombineFnBase.GlobalCombineFn
Returns the default value when there are no values added to the accumulator.- Specified by:
defaultValue
in interfaceCombineFnBase.GlobalCombineFn<InputT,AccumT,OutputT>
-
getAccumulatorCoder
public Coder<AccumT> getAccumulatorCoder(CoderRegistry registry, Coder<InputT> inputCoder) 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<InputT,AccumT,OutputT>
- Throws:
CannotProvideCoderException
-
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
.
-
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
-
-