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:

RuntimeContext

public class StreamingRuntimeContext
extends AbstractRuntimeUDFContext

Implementation of the RuntimeContext, for streaming operators.

Constructor Summary

Constructors

Constructor and Description
StreamingRuntimeContext(AbstractStreamOperator<?> operator, Environment env, Map<String,Accumulator<?,?>> accumulators)

Method Summary

Methods

Modifier and Type	Method and Description
<RT> List<RT>	getBroadcastVariable(String name)
<T,C> C	getBroadcastVariableWithInitializer(String name, BroadcastVariableInitializer<T,C> initializer)
long	getBufferTimeout() Returns the buffer timeout of the job
CheckpointingMode	getCheckpointMode() Returns the checkpointing mode
InputSplitProvider	getInputSplitProvider() Returns the input split provider associated with the operator.
<S> OperatorState<S>	getKeyValueState(String name, Class<S> stateType, S defaultState)
<S> OperatorState<S>	getKeyValueState(String name, TypeInformation<S> stateType, S defaultState)
boolean	isCheckpointingEnabled() Returns true if checkpointing is enabled for the running job.
void	registerTimer(long time, Triggerable target) Register a timer callback.

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

addAccumulator, getAccumulator, getAllAccumulators, getDistributedCache, getDoubleCounter, getExecutionConfig, getHistogram, getIndexOfThisSubtask, getIntCounter, getLongCounter, getNumberOfParallelSubtasks, getTaskName, 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,
                       Environment env,
                       Map<String,Accumulator<?,?>> accumulators)

Method Detail

getInputSplitProvider

public InputSplitProvider getInputSplitProvider()

Returns the input split provider associated with the operator.

Returns:

The input split provider.

registerTimer

public void 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.

getBroadcastVariable

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

getBroadcastVariableWithInitializer

public <T,C> C getBroadcastVariableWithInitializer(String name,
                                          BroadcastVariableInitializer<T,C> initializer)

getKeyValueState

public <S> OperatorState<S> getKeyValueState(String name,
                                    Class<S> stateType,
                                    S defaultState)

Specified by:

getKeyValueState in interface RuntimeContext

Overrides:

getKeyValueState in class AbstractRuntimeUDFContext

getKeyValueState

public <S> OperatorState<S> getKeyValueState(String name,
                                    TypeInformation<S> stateType,
                                    S defaultState)

Specified by:

getKeyValueState in interface RuntimeContext

Overrides:

getKeyValueState in class 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)