org.apache.flink.streaming.api.operators

Class StreamingRuntimeContext

java.lang.Object

org.apache.flink.api.common.functions.util.AbstractRuntimeUDFContext

org.apache.flink.streaming.api.operators.StreamingRuntimeContext

All Implemented Interfaces:

org.apache.flink.api.common.functions.RuntimeContext

@PublicEvolving
public class StreamingRuntimeContext
extends org.apache.flink.api.common.functions.util.AbstractRuntimeUDFContext

Implementation of the RuntimeContext, for streaming operators.

Constructor Summary

Constructors

Constructor and Description
StreamingRuntimeContext(AbstractStreamOperator<?> operator, org.apache.flink.runtime.execution.Environment env, Map<String,org.apache.flink.api.common.accumulators.Accumulator<?,?>> accumulators)

Method Summary

Modifier and Type	Method and Description
<RT> List<RT>	getBroadcastVariable(String name)
<T,C> C	getBroadcastVariableWithInitializer(String name, org.apache.flink.api.common.functions.BroadcastVariableInitializer<T,C> initializer)
long	getBufferTimeout() Returns the buffer timeout of the job
CheckpointingMode	getCheckpointMode() Returns the checkpointing mode
long	getCurrentProcessingTime() Returns the current processing time as defined by the task's TimeServiceProvider
org.apache.flink.runtime.jobgraph.tasks.InputSplitProvider	getInputSplitProvider() Returns the input split provider associated with the operator.
<S> org.apache.flink.api.common.state.OperatorState<S>	getKeyValueState(String name, Class<S> stateType, S defaultState) Deprecated.
<S> org.apache.flink.api.common.state.OperatorState<S>	getKeyValueState(String name, org.apache.flink.api.common.typeinfo.TypeInformation<S> stateType, S defaultState) Deprecated.
<T> org.apache.flink.api.common.state.ListState<T>	getListState(org.apache.flink.api.common.state.ListStateDescriptor<T> stateProperties)
<T> org.apache.flink.api.common.state.ReducingState<T>	getReducingState(org.apache.flink.api.common.state.ReducingStateDescriptor<T> stateProperties)
<T> org.apache.flink.api.common.state.ValueState<T>	getState(org.apache.flink.api.common.state.ValueStateDescriptor<T> stateProperties)
boolean	hasBroadcastVariable(String name)
boolean	isCheckpointingEnabled() Returns true if checkpointing is enabled for the running job.
ScheduledFuture<?>	registerTimer(long time, Triggerable target) Register a timer callback.

Methods inherited from class org.apache.flink.api.common.functions.util.AbstractRuntimeUDFContext

addAccumulator, getAccumulator, getAllAccumulators, getAttemptNumber, getDistributedCache, getDoubleCounter, getExecutionConfig, getHistogram, getIndexOfThisSubtask, getIntCounter, getLongCounter, getMetricGroup, getNumberOfParallelSubtasks, getTaskName, getTaskNameWithSubtasks, getUserCodeClassLoader

Methods inherited from class java.lang.Object

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

Constructor Detail

StreamingRuntimeContext

public StreamingRuntimeContext(AbstractStreamOperator<?> operator,
                               org.apache.flink.runtime.execution.Environment env,
                               Map<String,org.apache.flink.api.common.accumulators.Accumulator<?,?>> accumulators)

Method Detail

getInputSplitProvider

public org.apache.flink.runtime.jobgraph.tasks.InputSplitProvider getInputSplitProvider()

Returns the input split provider associated with the operator.

Returns:

The input split provider.

registerTimer

public ScheduledFuture<?> registerTimer(long time,
                                        Triggerable target)

Register a timer callback. At the specified time the Triggerable will be invoked. This call is guaranteed to not happen concurrently with method calls on the operator.

Parameters:

time - The absolute time in milliseconds.

target - The target to be triggered.

getCurrentProcessingTime

public long getCurrentProcessingTime()

Returns the current processing time as defined by the task's TimeServiceProvider

hasBroadcastVariable

public boolean hasBroadcastVariable(String name)

getBroadcastVariable

public <RT> List<RT> getBroadcastVariable(String name)

getBroadcastVariableWithInitializer

public <T,C> C getBroadcastVariableWithInitializer(String name,
                                                   org.apache.flink.api.common.functions.BroadcastVariableInitializer<T,C> initializer)

getState

public <T> org.apache.flink.api.common.state.ValueState<T> getState(org.apache.flink.api.common.state.ValueStateDescriptor<T> stateProperties)

Specified by:

getState in interface org.apache.flink.api.common.functions.RuntimeContext

Overrides:

getState in class org.apache.flink.api.common.functions.util.AbstractRuntimeUDFContext

getListState

public <T> org.apache.flink.api.common.state.ListState<T> getListState(org.apache.flink.api.common.state.ListStateDescriptor<T> stateProperties)

Specified by:

getListState in interface org.apache.flink.api.common.functions.RuntimeContext

Overrides:

getListState in class org.apache.flink.api.common.functions.util.AbstractRuntimeUDFContext

getReducingState

public <T> org.apache.flink.api.common.state.ReducingState<T> getReducingState(org.apache.flink.api.common.state.ReducingStateDescriptor<T> stateProperties)

Specified by:

getReducingState in interface org.apache.flink.api.common.functions.RuntimeContext

Overrides:

getReducingState in class org.apache.flink.api.common.functions.util.AbstractRuntimeUDFContext

getKeyValueState

@Deprecated
public <S> org.apache.flink.api.common.state.OperatorState<S> getKeyValueState(String name,
                                                                                           Class<S> stateType,
                                                                                           S defaultState)

Deprecated.

Specified by:

getKeyValueState in interface org.apache.flink.api.common.functions.RuntimeContext

Overrides:

getKeyValueState in class org.apache.flink.api.common.functions.util.AbstractRuntimeUDFContext

getKeyValueState

@Deprecated
public <S> org.apache.flink.api.common.state.OperatorState<S> getKeyValueState(String name,
                                                                                           org.apache.flink.api.common.typeinfo.TypeInformation<S> stateType,
                                                                                           S defaultState)

Deprecated.

Specified by:

getKeyValueState in interface org.apache.flink.api.common.functions.RuntimeContext

Overrides:

getKeyValueState in class org.apache.flink.api.common.functions.util.AbstractRuntimeUDFContext

isCheckpointingEnabled

public boolean isCheckpointingEnabled()

Returns true if checkpointing is enabled for the running job.

Returns:

true if checkpointing is enabled.

getCheckpointMode

public CheckpointingMode getCheckpointMode()

Returns the checkpointing mode

Returns:

checkpointing mode

getBufferTimeout

public long getBufferTimeout()

Returns the buffer timeout of the job

Returns:

buffer timeout (in milliseconds)