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

Class OrderedProcessingStatus

java.lang.Object

org.apache.beam.sdk.extensions.ordered.OrderedProcessingStatus

@DefaultSchema(org.apache.beam.sdk.schemas.AutoValueSchema.class)
public abstract class OrderedProcessingStatus
extends java.lang.Object

Indicates the status of ordered processing for a particular key.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OrderedProcessingStatus.Builder

Constructor Summary

Constructors

Constructor	Description
OrderedProcessingStatus()

Method Summary

Modifier and Type	Method	Description
static OrderedProcessingStatus	create(java.lang.Long lastProcessedSequence, long numberOfBufferedEvents, java.lang.Long earliestBufferedSequence, java.lang.Long latestBufferedSequence, long numberOfReceivedEvents, long resultCount, long duplicateCount, boolean lastEventReceived, ContiguousSequenceRange lastContiguousRange)
boolean	equals(java.lang.Object obj)
abstract long	getDuplicateCount()	Returns number of duplicate events which were output in OrderedEventProcessorResult.unprocessedEvents() PCollection.
abstract java.lang.Long	getEarliestBufferedSequence()	Returns earliest buffered sequence.
abstract ContiguousSequenceRange	getLastContiguousSequenceRange()
abstract java.lang.Long	getLastProcessedSequence()	Returns last sequence processed.
abstract java.lang.Long	getLatestBufferedSequence()	Returns latest buffered sequence.
abstract long	getNumberOfBufferedEvents()	Returns number of events received out of sequence and buffered.
abstract long	getNumberOfReceivedEvents()	Returns total number of events received for the given key and window.
abstract long	getResultCount()	Returns number of output results produced.
abstract org.joda.time.Instant	getStatusDate()	Returns timestamp of when the status was produced.
int	hashCode()
abstract boolean	isLastEventReceived()	Returns indicator that the last event for the given key and window has been received.

Methods inherited from class java.lang.Object

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

Constructor Detail

OrderedProcessingStatus

public OrderedProcessingStatus()

Method Detail

create

public static OrderedProcessingStatus create(@Nullable
                                             java.lang.Long lastProcessedSequence,
                                             long numberOfBufferedEvents,
                                             @Nullable
                                             java.lang.Long earliestBufferedSequence,
                                             @Nullable
                                             java.lang.Long latestBufferedSequence,
                                             long numberOfReceivedEvents,
                                             long resultCount,
                                             long duplicateCount,
                                             boolean lastEventReceived,
                                             @Nullable
                                             ContiguousSequenceRange lastContiguousRange)

getLastProcessedSequence

@Nullable
public abstract java.lang.Long getLastProcessedSequence()

Returns last sequence processed. If null is returned - no elements for the given key and window have been processed yet.

getNumberOfBufferedEvents

public abstract long getNumberOfBufferedEvents()

Returns number of events received out of sequence and buffered.

getEarliestBufferedSequence

@Nullable
public abstract java.lang.Long getEarliestBufferedSequence()

Returns earliest buffered sequence. If null is returned - there are no buffered events.

getLatestBufferedSequence

@Nullable
public abstract java.lang.Long getLatestBufferedSequence()

Returns latest buffered sequence. If null is returned - there are no buffered events.

getNumberOfReceivedEvents

public abstract long getNumberOfReceivedEvents()

Returns total number of events received for the given key and window.

getDuplicateCount

public abstract long getDuplicateCount()

Returns number of duplicate events which were output in OrderedEventProcessorResult.unprocessedEvents() PCollection.

getResultCount

public abstract long getResultCount()

Returns number of output results produced.

isLastEventReceived

public abstract boolean isLastEventReceived()

Returns indicator that the last event for the given key and window has been received. It doesn't necessarily mean that all the events for the given key and window have been processed. Use getNumberOfBufferedEvents() == 0 and this indicator as the sign that the processing is complete.

getStatusDate

public abstract org.joda.time.Instant getStatusDate()

Returns timestamp of when the status was produced. It is not related to the event's timestamp.

getLastContiguousSequenceRange

@Nullable
public abstract ContiguousSequenceRange getLastContiguousSequenceRange()

equals

public final boolean equals(@Nullable
                            java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public final int hashCode()

Overrides:

hashCode in class java.lang.Object