org.apache.flink.streaming.api.operators.collect

Class CollectSinkOperator<IN>

java.lang.Object

org.apache.flink.streaming.api.operators.AbstractStreamOperator<OUT>

org.apache.flink.streaming.api.operators.AbstractUdfStreamOperator<Object,SinkFunction<IN>>

org.apache.flink.streaming.api.operators.StreamSink<IN>

org.apache.flink.streaming.api.operators.collect.CollectSinkOperator<IN>

Type Parameters:

IN - type of results to be written into the sink.

All Implemented Interfaces:

Serializable, org.apache.flink.api.common.state.CheckpointListener, org.apache.flink.runtime.operators.coordination.OperatorEventHandler, Input<IN>, KeyContext, OneInputStreamOperator<IN,Object>, OutputTypeConfigurable<Object>, SetupableStreamOperator<Object>, StreamOperator<Object>, StreamOperatorStateHandler.CheckpointedStreamOperator, org.apache.flink.util.Disposable

public class CollectSinkOperator<IN>
extends StreamSink<IN>
implements org.apache.flink.runtime.operators.coordination.OperatorEventHandler

A StreamSink that collects query results and sends them back to the client.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.apache.flink.streaming.api.operators.AbstractUdfStreamOperator

userFunction

Fields inherited from class org.apache.flink.streaming.api.operators.AbstractStreamOperator

chainingStrategy, config, latencyStats, LOG, metrics, output, processingTimeService

Constructor Summary

Constructors

Constructor and Description
CollectSinkOperator(org.apache.flink.api.common.typeutils.TypeSerializer<IN> serializer, long maxBytesPerBatch, String accumulatorName)

Method Summary

Modifier and Type	Method and Description
void	close() This method is called after all records have been added to the operators via the methods Input.processElement(StreamRecord), or TwoInputStreamOperator.processElement1(StreamRecord) and TwoInputStreamOperator.processElement2(StreamRecord).
CompletableFuture<org.apache.flink.runtime.jobgraph.OperatorID>	getOperatorIdFuture()
void	handleOperatorEvent(org.apache.flink.runtime.operators.coordination.OperatorEvent evt)

Methods inherited from class org.apache.flink.streaming.api.operators.StreamSink

open, processElement, processWatermark, reportOrForwardLatencyMarker

Methods inherited from class org.apache.flink.streaming.api.operators.AbstractUdfStreamOperator

dispose, getUserFunction, getUserFunctionParameters, initializeState, notifyCheckpointAborted, notifyCheckpointComplete, setOutputType, setup, snapshotState

Methods inherited from class org.apache.flink.streaming.api.operators.AbstractStreamOperator

getChainingStrategy, getContainingTask, getCurrentKey, getExecutionConfig, getInternalTimerService, getKeyedStateBackend, getKeyedStateStore, getMetricGroup, getOperatorConfig, getOperatorID, getOperatorName, getOperatorStateBackend, getOrCreateKeyedState, getPartitionedState, getPartitionedState, getProcessingTimeService, getRuntimeContext, getTimeServiceManager, getUserCodeClassloader, initializeState, isUsingCustomRawKeyedState, prepareSnapshotPreBarrier, processLatencyMarker, processLatencyMarker1, processLatencyMarker2, processWatermark1, processWatermark2, setChainingStrategy, setCurrentKey, setKeyContextElement1, setKeyContextElement2, setProcessingTimeService, snapshotState

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.OneInputStreamOperator

setKeyContextElement

Methods inherited from interface org.apache.flink.streaming.api.operators.StreamOperator

dispose, getMetricGroup, getOperatorID, initializeState, prepareSnapshotPreBarrier, setKeyContextElement1, setKeyContextElement2, snapshotState

Methods inherited from interface org.apache.flink.api.common.state.CheckpointListener

notifyCheckpointAborted, notifyCheckpointComplete

Methods inherited from interface org.apache.flink.streaming.api.operators.KeyContext

getCurrentKey, setCurrentKey

Methods inherited from interface org.apache.flink.streaming.api.operators.Input

processLatencyMarker

Constructor Detail

CollectSinkOperator

public CollectSinkOperator(org.apache.flink.api.common.typeutils.TypeSerializer<IN> serializer,
                           long maxBytesPerBatch,
                           String accumulatorName)

Method Detail

handleOperatorEvent

public void handleOperatorEvent(org.apache.flink.runtime.operators.coordination.OperatorEvent evt)

Specified by:

handleOperatorEvent in interface org.apache.flink.runtime.operators.coordination.OperatorEventHandler

close

public void close()
           throws Exception

Description copied from class: AbstractStreamOperator

This method is called after all records have been added to the operators via the methods Input.processElement(StreamRecord), or TwoInputStreamOperator.processElement1(StreamRecord) and TwoInputStreamOperator.processElement2(StreamRecord).

The method is expected to flush all remaining buffered data. Exceptions during this flushing of buffered should be propagated, in order to cause the operation to be recognized asa failed, because the last data items are not processed properly.

Specified by:

close in interface StreamOperator<Object>

Overrides:

close in class AbstractUdfStreamOperator<Object,SinkFunction<IN>>

Throws:

Exception - An exception in this method causes the operator to fail.

getOperatorIdFuture

public CompletableFuture<org.apache.flink.runtime.jobgraph.OperatorID> getOperatorIdFuture()