Package 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, org.apache.flink.api.common.state.CheckpointListener, Input<IN>, KeyContext, KeyContextHandler, OneInputStreamOperator<IN,IN>, StreamOperator<IN>, StreamOperatorStateHandler.CheckpointedStreamOperator, YieldingOperator<IN>

@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	Description
protected final String	registrationName	Name under which the queryable state is registered.
protected org.apache.flink.api.common.state.ValueState<IN>	state	The state instance created on open.
protected final org.apache.flink.api.common.state.StateDescriptor<? extends org.apache.flink.api.common.state.ValueState<IN>,?>	stateDescriptor	State descriptor for the queryable state instance.

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

combinedWatermark, config, lastRecordAttributes1, lastRecordAttributes2, latencyStats, LOG, metrics, output, processingTimeService, stateHandler, stateKeySelector1, stateKeySelector2, timeServiceManager

Constructor Summary

Constructors

Constructor	Description
QueryableValueStateOperator(String registrationName, org.apache.flink.api.common.state.StateDescriptor<org.apache.flink.api.common.state.ValueState<IN>,IN> stateDescriptor)

Method Summary

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

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

beforeInitializeStateHandler, close, finish, getContainingTask, getCurrentKey, getExecutionConfig, getInternalTimerService, getKeyedStateBackend, getKeyedStateStore, getMetricGroup, getOperatorConfig, getOperatorID, getOperatorName, getOperatorStateBackend, getOrCreateKeyedState, getPartitionedState, getPartitionedState, getProcessingTimeService, getRuntimeContext, getStateKeySelector1, getStateKeySelector2, getTimeServiceManager, getUserCodeClassloader, hasKeyContext1, hasKeyContext2, initializeState, initializeState, isAsyncStateProcessingEnabled, isUsingCustomRawKeyedState, notifyCheckpointAborted, notifyCheckpointComplete, prepareSnapshotPreBarrier, processLatencyMarker, processLatencyMarker1, processLatencyMarker2, processRecordAttributes, processRecordAttributes1, processRecordAttributes2, processWatermark, processWatermark, processWatermark1, processWatermark1, processWatermark2, processWatermark2, processWatermarkStatus, processWatermarkStatus, processWatermarkStatus1, processWatermarkStatus2, reportOrForwardLatencyMarker, setCurrentKey, setKeyContextElement1, setKeyContextElement2, setMailboxExecutor, setProcessingTimeService, setup, snapshotState, snapshotState, useSplittableTimers

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.api.common.state.CheckpointListener

notifyCheckpointAborted, notifyCheckpointComplete

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

processLatencyMarker, processRecordAttributes, processWatermark, processWatermark, processWatermarkStatus

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

getCurrentKey, setCurrentKey

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

hasKeyContext

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

setKeyContextElement

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

close, finish, getMetricGroup, getOperatorAttributes, getOperatorID, initializeState, prepareSnapshotPreBarrier, setKeyContextElement1, setKeyContextElement2, snapshotState

Field Details

stateDescriptor

protected final org.apache.flink.api.common.state.StateDescriptor<? extends org.apache.flink.api.common.state.ValueState<IN>,?> stateDescriptor

State descriptor for the queryable state instance.

registrationName

protected final String registrationName

Name under which the queryable state is registered.

state

protected transient org.apache.flink.api.common.state.ValueState<IN> 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 Details

QueryableValueStateOperator

public QueryableValueStateOperator(String registrationName,
 org.apache.flink.api.common.state.StateDescriptor<org.apache.flink.api.common.state.ValueState<IN>,IN> stateDescriptor)

Method Details

processElement

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

Description copied from interface: Input

Processes one element that arrived on this input of the MultipleInputStreamOperator. 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<S extends org.apache.flink.api.common.state.State>

Overrides:

open in class AbstractStreamOperator<IN>

Throws:

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