org.apache.flink.streaming.api.operators.async.queue

Class StreamRecordQueueEntry<OUT>

java.lang.Object

org.apache.flink.streaming.api.operators.async.queue.StreamElementQueueEntry<Collection<OUT>>

org.apache.flink.streaming.api.operators.async.queue.StreamRecordQueueEntry<OUT>

Type Parameters:

OUT - Type of the asynchronous collection result

All Implemented Interfaces:

ResultFuture<OUT>, AsyncCollectionResult<OUT>, AsyncResult

@Internal
public class StreamRecordQueueEntry<OUT>
extends StreamElementQueueEntry<Collection<OUT>>
implements AsyncCollectionResult<OUT>, ResultFuture<OUT>

StreamElementQueueEntry implementation for StreamRecord. This class also acts as the ResultFuture implementation which is given to the AsyncFunction. The async function completes this class with a collection of results.

Constructor Summary

Constructors

Constructor and Description
StreamRecordQueueEntry(StreamRecord<?> streamRecord)

Method Summary

Modifier and Type	Method and Description
void	complete(Collection<OUT> result) Completes the result future with a collection of result objects.
void	completeExceptionally(Throwable error) Completes the result future exceptionally with an exception.
Collection<OUT>	get() Return the asynchronous result collection.
protected CompletableFuture<Collection<OUT>>	getFuture()
long	getTimestamp()
boolean	hasTimestamp()

Methods inherited from class org.apache.flink.streaming.api.operators.async.queue.StreamElementQueueEntry

asResultCollection, asWatermark, getStreamElement, isDone, isResultCollection, isWatermark, onComplete

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.flink.streaming.api.operators.async.queue.AsyncResult

asResultCollection, asWatermark, isResultCollection, isWatermark

Constructor Detail

StreamRecordQueueEntry

public StreamRecordQueueEntry(StreamRecord<?> streamRecord)

Method Detail

hasTimestamp

public boolean hasTimestamp()

Specified by:

hasTimestamp in interface AsyncCollectionResult<OUT>

getTimestamp

public long getTimestamp()

Specified by:

getTimestamp in interface AsyncCollectionResult<OUT>

get

public Collection<OUT> get()
                    throws Exception

Description copied from interface: AsyncCollectionResult

Return the asynchronous result collection.

Specified by:

get in interface AsyncCollectionResult<OUT>

Returns:

the asynchronous result collection

Throws:

Exception - if the asynchronous result collection could not be completed

getFuture

protected CompletableFuture<Collection<OUT>> getFuture()

Specified by:

getFuture in class StreamElementQueueEntry<Collection<OUT>>

complete

public void complete(Collection<OUT> result)

Description copied from interface: ResultFuture

Completes the result future with a collection of result objects.

Note that it should be called for exactly one time in the user code. Calling this function for multiple times will cause data lose.

Put all results in a Collection and then emit output.

Specified by:

complete in interface ResultFuture<OUT>

Parameters:

result - A list of results.

completeExceptionally

public void completeExceptionally(Throwable error)

Description copied from interface: ResultFuture

Completes the result future exceptionally with an exception.

Specified by:

completeExceptionally in interface ResultFuture<OUT>

Parameters:

error - A Throwable object.