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

Class OrderedEventProcessorResult<KeyT,ResultT,EventT>

java.lang.Object

org.apache.beam.sdk.extensions.ordered.OrderedEventProcessorResult<KeyT,ResultT,EventT>

Type Parameters:

KeyT -

ResultT -

All Implemented Interfaces:

POutput

public class OrderedEventProcessorResult<KeyT,ResultT,EventT>
extends Object
implements POutput

The result of the ordered processing. Three PCollections are returned:

output - the key/value of the mutated states

unprocessedEvents - the key/value of the events that failed to be processed and the failure reason

processingStatuses - the key/value of the status of processing for a particular key

In case of global sequence processing, the result also contains PCollectionView of the latest contiguous sequence range

Method Summary

Modifier and Type	Method	Description
Map<TupleTag<?>,PValue>	expand()	Expands this POutput into a list of its component output PValues.
void	finishSpecifyingOutput(String transformName, PInput input, PTransform<?,?> transform)	As part of applying the producing PTransform, finalizes this output to make it ready for being used as an input and for running.
Pipeline	getPipeline()	Returns the owning Pipeline of this POutput.
PCollectionView<Iterable<ContiguousSequenceRange>>	latestContiguousRange()
PCollection<KV<KeyT,ResultT>>	output()
PCollection<KV<KeyT,OrderedProcessingStatus>>	processingStatuses()
PCollection<KV<KeyT,KV<Long,UnprocessedEvent<EventT>>>>	unprocessedEvents()

Methods inherited from class java.lang.Object

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

Method Details

getPipeline

public Pipeline getPipeline()

Description copied from interface: POutput

Returns the owning Pipeline of this POutput.

Specified by:

getPipeline in interface POutput

expand

public Map<TupleTag<?>,PValue> expand()

Description copied from interface: POutput

Expands this POutput into a list of its component output PValues.

• A PValue expands to itself.
• A tuple or list of PValues (such as PCollectionTuple or PCollectionList) expands to its component PValue PValues.

Not intended to be invoked directly by user code.

Specified by:

expand in interface POutput

finishSpecifyingOutput

public void finishSpecifyingOutput(String transformName,
 PInput input,
 PTransform<?,?> transform)

Description copied from interface: POutput

As part of applying the producing PTransform, finalizes this output to make it ready for being used as an input and for running.

This includes ensuring that all PCollections have Coders specified or defaulted.

Automatically invoked whenever this POutput is output, after POutput.finishSpecifyingOutput(String, PInput, PTransform) has been called on each component PValue returned by POutput.expand().

Specified by:

finishSpecifyingOutput in interface POutput

processingStatuses

public PCollection<KV<KeyT,OrderedProcessingStatus>> processingStatuses()

Returns:

processing status for a particular key. The elements will have the timestamp of the instant the status was emitted.

output

public PCollection<KV<KeyT,ResultT>> output()

Returns:

processed states keyed by the original key

unprocessedEvents

public PCollection<KV<KeyT,KV<Long,UnprocessedEvent<EventT>>>> unprocessedEvents()

Returns:

events which failed to process, including the reasons for failure.

latestContiguousRange

@Nullable
public PCollectionView<Iterable<ContiguousSequenceRange>> latestContiguousRange()

Returns:

a view to a calculated side input with the last contiguous range. Note: an iterator is returned instead of a single value. Use ContiguousSequenceRange.largestRange(Iterable) to get the largest range.