org.apache.flink.streaming.api.functions.query

Class QueryableValueStateOperator<IN>

java.lang.Object

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

org.apache.flink.streaming.api.functions.query.QueryableValueStateOperator<IN>

Type Parameters:

IN - Input type

All Implemented Interfaces:

Serializable, CheckpointListener, KeyContext, OneInputStreamOperator<IN,IN>, SetupableStreamOperator<IN>, StreamOperator<IN>, StreamOperatorStateHandler.CheckpointedStreamOperator, Disposable

@Internal
public class QueryableValueStateOperator<IN>
extends AbstractStreamOperator<IN>

Internal operator handling queryable ValueState instances.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	registrationName Name under which the queryable state is registered.
protected S	state The state instance created on open.
protected StateDescriptor<? extends S,?>	stateDescriptor State descriptor for the queryable state instance.

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

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

Constructor Summary

Constructors

Constructor and Description
QueryableValueStateOperator(String registrationName, StateDescriptor<ValueState<IN>,IN> stateDescriptor)

Method Summary

Modifier and Type	Method and Description
void	open() This method is called immediately before any elements are processed, it should contain the operator's initialization logic, e.g.
void	processElement(StreamRecord<IN> element) Processes one element that arrived at this operator.

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

close, dispose, getChainingStrategy, getContainingTask, getCurrentKey, getExecutionConfig, getInternalTimerService, getKeyedStateBackend, getKeyedStateStore, getMetricGroup, getOperatorConfig, getOperatorID, getOperatorName, getOperatorStateBackend, getOrCreateKeyedState, getPartitionedState, getPartitionedState, getProcessingTimeService, getRuntimeContext, getTimeServiceManager, getUserCodeClassloader, initializeState, initializeState, isUsingCustomRawKeyedState, notifyCheckpointAborted, notifyCheckpointComplete, numEventTimeTimers, numProcessingTimeTimers, prepareSnapshotPreBarrier, processLatencyMarker, processLatencyMarker1, processLatencyMarker2, processWatermark, processWatermark1, processWatermark2, reportOrForwardLatencyMarker, setChainingStrategy, setCurrentKey, setKeyContextElement1, setKeyContextElement2, setProcessingTimeService, setup, snapshotState, 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

processLatencyMarker, processWatermark

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

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

Methods inherited from interface org.apache.flink.runtime.state.CheckpointListener

notifyCheckpointAborted, notifyCheckpointComplete

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

getCurrentKey, setCurrentKey

Field Detail

stateDescriptor

protected final StateDescriptor<? extends S extends State,?> stateDescriptor

State descriptor for the queryable state instance.

registrationName

protected final String registrationName

Name under which the queryable state is registered.

state

protected transient S extends State state

The state instance created on open. This is updated by the subclasses of this class, because the state update interface depends on the state type (e.g. AppendingState#add(IN) vs. ValueState#update(OUT)).

Constructor Detail

QueryableValueStateOperator

public QueryableValueStateOperator(String registrationName,
                                   StateDescriptor<ValueState<IN>,IN> stateDescriptor)

Method Detail

processElement

public void processElement(StreamRecord<IN> element)
                    throws Exception

Description copied from interface: OneInputStreamOperator

Processes one element that arrived at this operator. This method is guaranteed to not be called concurrently with other methods of the operator.

Throws:

Exception

open

public void open()
          throws Exception

Description copied from class: AbstractStreamOperator

This method is called immediately before any elements are processed, it should contain the operator's initialization logic, e.g. state initialization.

The default implementation does nothing.

Specified by:

open in interface StreamOperator<IN>

Overrides:

open in class AbstractStreamOperator<IN>

Throws:

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