Class Combine.IterableCombineFn<V>
- java.lang.Object
-
- org.apache.beam.sdk.transforms.Combine.CombineFn<V,java.util.List<V>,V>
-
- org.apache.beam.sdk.transforms.Combine.IterableCombineFn<V>
-
- All Implemented Interfaces:
java.io.Serializable
,CombineFnBase.GlobalCombineFn<V,java.util.List<V>,V>
,HasDisplayData
,NameUtils.NameOverride
- Direct Known Subclasses:
Combine.SimpleCombineFn
- Enclosing class:
- Combine
public static class Combine.IterableCombineFn<V> extends Combine.CombineFn<V,java.util.List<V>,V> implements NameUtils.NameOverride
Converts aSerializableFunction
fromIterable<V>
s toV
s into a simpleCombine.CombineFn
overV
s.Used in the implementation of convenience methods like
Combine.globally(SerializableFunction)
,Combine.perKey(SerializableFunction)
, andCombine.groupedValues(SerializableFunction)
.- See Also:
- Serialized Form
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.List<V>
addInput(java.util.List<V> accumulator, V input)
Adds the given input value to the given accumulator, returning the new accumulator value.java.util.List<V>
compact(java.util.List<V> accumulator)
Returns an accumulator that represents the same logical value as the input accumulator, but may have a more compact representation.java.util.List<V>
createAccumulator()
Returns a new, mutable accumulator value, representing the accumulation of zero input values.V
extractOutput(java.util.List<V> accumulator)
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.String
getNameOverride()
Return the name to use for this instance.java.lang.reflect.TypeVariable<?>
getOutputTVariable()
Returns theTypeVariable
ofOutputT
.java.util.List<V>
mergeAccumulators(java.lang.Iterable<java.util.List<V>> accumulators)
Returns an accumulator representing the accumulation of all the input values accumulated in the merging accumulators.static <V> Combine.IterableCombineFn<V>
of(SerializableFunction<java.lang.Iterable<V>,V> combiner)
Returns aCombineFn
that uses the givenSerializableFunction
to combine values.static <V> Combine.IterableCombineFn<V>
of(SerializableFunction<java.lang.Iterable<V>,V> combiner, int bufferSize)
Returns aCombineFn
that uses the givenSerializableFunction
to combine values, attempting to buffer at leastbufferSize
values between invocations.void
populateDisplayData(DisplayData.Builder builder)
Register display data for the given transform or component.-
Methods inherited from class org.apache.beam.sdk.transforms.Combine.CombineFn
apply, defaultValue, getInputType, getOutputType
-
-
-
-
Method Detail
-
of
public static <V> Combine.IterableCombineFn<V> of(SerializableFunction<java.lang.Iterable<V>,V> combiner)
Returns aCombineFn
that uses the givenSerializableFunction
to combine values.
-
of
public static <V> Combine.IterableCombineFn<V> of(SerializableFunction<java.lang.Iterable<V>,V> combiner, int bufferSize)
Returns aCombineFn
that uses the givenSerializableFunction
to combine values, attempting to buffer at leastbufferSize
values between invocations.
-
createAccumulator
public java.util.List<V> createAccumulator()
Description copied from class:Combine.CombineFn
Returns a new, mutable accumulator value, representing the accumulation of zero input values.- Specified by:
createAccumulator
in classCombine.CombineFn<V,java.util.List<V>,V>
-
addInput
public java.util.List<V> addInput(java.util.List<V> accumulator, V input)
Description copied from class:Combine.CombineFn
Adds the given input value to the given accumulator, returning the new accumulator value.- Specified by:
addInput
in classCombine.CombineFn<V,java.util.List<V>,V>
- Parameters:
accumulator
- may be modified and returned for efficiencyinput
- should not be mutated
-
mergeAccumulators
public java.util.List<V> mergeAccumulators(java.lang.Iterable<java.util.List<V>> accumulators)
Description copied from class:Combine.CombineFn
Returns an accumulator representing the accumulation of all the input values accumulated in the merging accumulators.- Specified by:
mergeAccumulators
in classCombine.CombineFn<V,java.util.List<V>,V>
- Parameters:
accumulators
- only the first accumulator may be modified and returned for efficiency; the other accumulators should not be mutated, because they may be shared with other code and mutating them could lead to incorrect results or data corruption.
-
extractOutput
public V extractOutput(java.util.List<V> accumulator)
Description copied from class:Combine.CombineFn
Returns the output value that is the result of combining all the input values represented by the given accumulator.- Specified by:
extractOutput
in classCombine.CombineFn<V,java.util.List<V>,V>
- Parameters:
accumulator
- can be modified for efficiency
-
compact
public java.util.List<V> compact(java.util.List<V> accumulator)
Description copied from class:Combine.CombineFn
Returns an accumulator that represents the same logical value as the input accumulator, but may have a more compact representation.For most CombineFns this would be a no-op, but should be overridden by CombineFns that (for example) buffer up elements and combine them in batches.
For efficiency, the input accumulator may be modified and returned.
By default returns the original accumulator.
- Overrides:
compact
in classCombine.CombineFn<V,java.util.List<V>,V>
-
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
-
getNameOverride
public java.lang.String getNameOverride()
Description copied from interface:NameUtils.NameOverride
Return the name to use for this instance.- Specified by:
getNameOverride
in interfaceNameUtils.NameOverride
-
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
.
-
-