Package org.apache.beam.sdk.extensions.ordered.combiner

Class DefaultSequenceCombiner<EventKeyT,EventT,StateT extends MutableState<EventT,?>>

java.lang.Object

org.apache.beam.sdk.transforms.Combine.CombineFn<TimestampedValue<KV<EventKeyT,KV<Long,EventT>>>,SequenceRangeAccumulator,ContiguousSequenceRange>

org.apache.beam.sdk.extensions.ordered.combiner.DefaultSequenceCombiner<EventKeyT,EventT,StateT>

Type Parameters:

EventKeyT - type of key

EventT - type of event

StateT - type of state

All Implemented Interfaces:

Serializable, CombineFnBase.GlobalCombineFn<TimestampedValue<KV<EventKeyT,KV<Long,EventT>>>,SequenceRangeAccumulator,ContiguousSequenceRange>, HasDisplayData

public class DefaultSequenceCombiner<EventKeyT,EventT,StateT extends MutableState<EventT,?>>
extends Combine.CombineFn<TimestampedValue<KV<EventKeyT,KV<Long,EventT>>>,SequenceRangeAccumulator,ContiguousSequenceRange>

Default global sequence combiner.

Produces the largest ContiguousSequenceRange of contiguous longs which starts from the initial event identified by

invalid reference

EventExaminer#isInitialEvent(long, EventT)

.

This combiner currently doesn't use

invalid reference

EventExaminer#isLastEvent(long, EventT)

.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
DefaultSequenceCombiner(EventExaminer<EventT,StateT> eventExaminer)

Method Summary

Modifier and Type	Method	Description
SequenceRangeAccumulator	addInput(SequenceRangeAccumulator accum, TimestampedValue<KV<EventKeyT,KV<Long,EventT>>> event)	Adds the given input value to the given accumulator, returning the new accumulator value.
SequenceRangeAccumulator	createAccumulator()	Returns a new, mutable accumulator value, representing the accumulation of zero input values.
ContiguousSequenceRange	extractOutput(SequenceRangeAccumulator accum)	Returns the output value that is the result of combining all the input values represented by the given accumulator.
TypeVariable<?>	getAccumTVariable()	Returns the TypeVariable of AccumT.
@UnknownKeyFor @NonNull @Initialized Coder<SequenceRangeAccumulator>	getAccumulatorCoder(@UnknownKeyFor @NonNull @Initialized CoderRegistry registry, @UnknownKeyFor @NonNull @Initialized Coder<TimestampedValue<KV<EventKeyT,KV<Long,EventT>>>> inputCoder)	Returns the Coder to use for accumulator AccumT values, or null if it is not able to be inferred.
Coder<ContiguousSequenceRange>	getDefaultOutputCoder(CoderRegistry registry, Coder<TimestampedValue<KV<EventKeyT,KV<Long,EventT>>>> inputCoder)	Returns the Coder to use by default for output OutputT values, or null if it is not able to be inferred.
String	getIncompatibleGlobalWindowErrorMessage()	Returns the error message for not supported default values in Combine.globally().
TypeVariable<?>	getInputTVariable()	Returns the TypeVariable of InputT.
TypeVariable<?>	getOutputTVariable()	Returns the TypeVariable of OutputT.
SequenceRangeAccumulator	mergeAccumulators(Iterable<SequenceRangeAccumulator> accumulators)	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.

Methods inherited from class org.apache.beam.sdk.transforms.Combine.CombineFn

apply, compact, defaultValue, getInputType, getOutputType

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultSequenceCombiner

public DefaultSequenceCombiner(EventExaminer<EventT,StateT> eventExaminer)

Method Details

createAccumulator

public SequenceRangeAccumulator createAccumulator()

Description copied from class: Combine.CombineFn

Returns a new, mutable accumulator value, representing the accumulation of zero input values.

Specified by:

createAccumulator in class Combine.CombineFn<TimestampedValue<KV<EventKeyT,KV<Long,EventT>>>,SequenceRangeAccumulator,ContiguousSequenceRange>

addInput

public SequenceRangeAccumulator addInput(SequenceRangeAccumulator accum,
 TimestampedValue<KV<EventKeyT,KV<Long,EventT>>> event)

Description copied from class: Combine.CombineFn

Adds the given input value to the given accumulator, returning the new accumulator value.

Specified by:

addInput in class Combine.CombineFn<TimestampedValue<KV<EventKeyT,KV<Long,EventT>>>,SequenceRangeAccumulator,ContiguousSequenceRange>

Parameters:

accum - may be modified and returned for efficiency

event - should not be mutated

mergeAccumulators

public SequenceRangeAccumulator mergeAccumulators(Iterable<SequenceRangeAccumulator> 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 class Combine.CombineFn<TimestampedValue<KV<EventKeyT,KV<Long,EventT>>>,SequenceRangeAccumulator,ContiguousSequenceRange>

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 ContiguousSequenceRange extractOutput(SequenceRangeAccumulator accum)

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 class Combine.CombineFn<TimestampedValue<KV<EventKeyT,KV<Long,EventT>>>,SequenceRangeAccumulator,ContiguousSequenceRange>

Parameters:

accum - can be modified for efficiency

getAccumulatorCoder

public @UnknownKeyFor @NonNull @Initialized Coder<SequenceRangeAccumulator> getAccumulatorCoder(@UnknownKeyFor @NonNull @Initialized CoderRegistry registry,
 @UnknownKeyFor @NonNull @Initialized Coder<TimestampedValue<KV<EventKeyT,KV<Long,EventT>>>> inputCoder)
                                                                                         throws @UnknownKeyFor @NonNull @Initialized CannotProvideCoderException

Description copied from interface: CombineFnBase.GlobalCombineFn

Returns the Coder to use for accumulator AccumT values, or null if it is not able to be inferred.

By default, uses the knowledge of the Coder being used for InputT values and the enclosing Pipeline's CoderRegistry to try to infer the Coder for AccumT 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 interface CombineFnBase.GlobalCombineFn<EventKeyT,EventT,StateT extends MutableState<EventT,?>>

Throws:

@UnknownKeyFor @NonNull @Initialized CannotProvideCoderException

getDefaultOutputCoder

public Coder<ContiguousSequenceRange> getDefaultOutputCoder(CoderRegistry registry,
 Coder<TimestampedValue<KV<EventKeyT,KV<Long,EventT>>>> inputCoder)
                                                     throws CannotProvideCoderException

Description copied from interface: CombineFnBase.GlobalCombineFn

Returns the Coder to use by default for output OutputT values, or null if it is not able to be inferred.

By default, uses the knowledge of the Coder being used for input InputT values and the enclosing Pipeline's CoderRegistry to try to infer the Coder for OutputT values.

Specified by:

getDefaultOutputCoder in interface CombineFnBase.GlobalCombineFn<InputT,AccumT,OutputT>

Throws:

CannotProvideCoderException

getIncompatibleGlobalWindowErrorMessage

public String getIncompatibleGlobalWindowErrorMessage()

Description copied from interface: CombineFnBase.GlobalCombineFn

Returns the error message for not supported default values in Combine.globally().

Specified by:

getIncompatibleGlobalWindowErrorMessage in interface CombineFnBase.GlobalCombineFn<InputT,AccumT,OutputT>

getInputTVariable

public TypeVariable<?> getInputTVariable()

Returns the TypeVariable of InputT.

getAccumTVariable

public TypeVariable<?> getAccumTVariable()

Returns the TypeVariable of AccumT.

getOutputTVariable

public TypeVariable<?> getOutputTVariable()

Returns the TypeVariable of OutputT.

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 via DisplayData.from(HasDisplayData). Implementations may call super.populateDisplayData(builder) in order to register display data in the current namespace, but should otherwise use subcomponent.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 interface HasDisplayData

Parameters:

builder - The builder to populate with display data.

See Also:

• HasDisplayData