AbstractRuntimeUDFContext (flink-core 1.6.1 API)

java.lang.Object
- org.apache.flink.api.common.functions.util.AbstractRuntimeUDFContext

All Implemented Interfaces:

RuntimeContext

Direct Known Subclasses:

RuntimeUDFContext
```
@Internal
public abstract class AbstractRuntimeUDFContext
extends Object
implements RuntimeContext
```
A standalone implementation of the RuntimeContext, created by runtime UDF operators.

Constructor Summary

Constructors
Constructor and Description
`AbstractRuntimeUDFContext(TaskInfo taskInfo, ClassLoader userCodeClassLoader, ExecutionConfig executionConfig, Map<String,Accumulator<?,?>> accumulators, Map<String,Future<Path>> cpTasks, org.apache.flink.metrics.MetricGroup metrics)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`<V,A extends Serializable> void`	`addAccumulator(String name, Accumulator<V,A> accumulator)` Add this accumulator.
`<V,A extends Serializable> Accumulator<V,A>`	`getAccumulator(String name)` Get an existing accumulator object.
`<IN,ACC,OUT> AggregatingState<IN,OUT>`	`getAggregatingState(AggregatingStateDescriptor<IN,ACC,OUT> stateProperties)` Gets a handle to the system's key/value aggregating state.
`Map<String,Accumulator<?,?>>`	`getAllAccumulators()` Returns a map of all registered accumulators for this task.
`String`	`getAllocationIDAsString()`
`int`	`getAttemptNumber()` Gets the attempt number of this parallel subtask.
`DistributedCache`	`getDistributedCache()` Returns the `DistributedCache` to get the local temporary file copies of files otherwise not locally accessible.
`DoubleCounter`	`getDoubleCounter(String name)` Convenience function to create a counter object for doubles.
`ExecutionConfig`	`getExecutionConfig()` Returns the `ExecutionConfig` for the currently executing job.
`<T,ACC> FoldingState<T,ACC>`	`getFoldingState(FoldingStateDescriptor<T,ACC> stateProperties)` Deprecated.
`Histogram`	`getHistogram(String name)` Convenience function to create a counter object for histograms.
`int`	`getIndexOfThisSubtask()` Gets the number of this parallel subtask.
`IntCounter`	`getIntCounter(String name)` Convenience function to create a counter object for integers.
`<T> ListState<T>`	`getListState(ListStateDescriptor<T> stateProperties)` Gets a handle to the system's key/value list state.
`LongCounter`	`getLongCounter(String name)` Convenience function to create a counter object for longs.
`<UK,UV> MapState<UK,UV>`	`getMapState(MapStateDescriptor<UK,UV> stateProperties)` Gets a handle to the system's key/value map state.
`int`	`getMaxNumberOfParallelSubtasks()` Gets the number of max-parallelism with which the parallel task runs.
`org.apache.flink.metrics.MetricGroup`	`getMetricGroup()` Returns the metric group for this parallel subtask.
`int`	`getNumberOfParallelSubtasks()` Gets the parallelism with which the parallel task runs.
`<T> ReducingState<T>`	`getReducingState(ReducingStateDescriptor<T> stateProperties)` Gets a handle to the system's key/value reducing state.
`<T> ValueState<T>`	`getState(ValueStateDescriptor<T> stateProperties)` Gets a handle to the system's key/value state.
`String`	`getTaskName()` Returns the name of the task in which the UDF runs, as assigned during plan construction.
`String`	`getTaskNameWithSubtasks()` Returns the name of the task, appended with the subtask indicator, such as "MyTask (3/6)", where 3 would be (`RuntimeContext.getIndexOfThisSubtask()` + 1), and 6 would be `RuntimeContext.getNumberOfParallelSubtasks()`.
`ClassLoader`	`getUserCodeClassLoader()` Gets the ClassLoader to load classes that were are not in system's classpath, but are part of the jar file of a user job.

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.functions.RuntimeContext
getBroadcastVariable, getBroadcastVariableWithInitializer, hasBroadcastVariable

- Constructor Detail
  - AbstractRuntimeUDFContext
```
public AbstractRuntimeUDFContext(TaskInfo taskInfo,
                                 ClassLoader userCodeClassLoader,
                                 ExecutionConfig executionConfig,
                                 Map<String,Accumulator<?,?>> accumulators,
                                 Map<String,Future<Path>> cpTasks,
                                 org.apache.flink.metrics.MetricGroup metrics)
```
- Method Detail
  - getExecutionConfig
```
public ExecutionConfig getExecutionConfig()
```
    Description copied from interface: RuntimeContext
    
    Returns the ExecutionConfig for the currently executing job.
    
    Specified by:
    
    getExecutionConfig in interface RuntimeContext
  - getTaskName
```
public String getTaskName()
```
    Description copied from interface: RuntimeContext
    
    Returns the name of the task in which the UDF runs, as assigned during plan construction.
    
    Specified by:
    
    getTaskName in interface RuntimeContext
    
    Returns:
    
    The name of the task in which the UDF runs.
  - getNumberOfParallelSubtasks
```
public int getNumberOfParallelSubtasks()
```
    Description copied from interface: RuntimeContext
    
    Gets the parallelism with which the parallel task runs.
    
    Specified by:
    
    getNumberOfParallelSubtasks in interface RuntimeContext
    
    Returns:
    
    The parallelism with which the parallel task runs.
  - getMaxNumberOfParallelSubtasks
```
public int getMaxNumberOfParallelSubtasks()
```
    Description copied from interface: RuntimeContext
    
    Gets the number of max-parallelism with which the parallel task runs.
    
    Specified by:
    
    getMaxNumberOfParallelSubtasks in interface RuntimeContext
    
    Returns:
    
    The max-parallelism with which the parallel task runs.
  - getIndexOfThisSubtask
```
public int getIndexOfThisSubtask()
```
    Description copied from interface: RuntimeContext
    
    Gets the number of this parallel subtask. The numbering starts from 0 and goes up to parallelism-1 (parallelism as returned by RuntimeContext.getNumberOfParallelSubtasks()).
    
    Specified by:
    
    getIndexOfThisSubtask in interface RuntimeContext
    
    Returns:
    
    The index of the parallel subtask.
  - getMetricGroup
```
public org.apache.flink.metrics.MetricGroup getMetricGroup()
```
    Description copied from interface: RuntimeContext
    
    Returns the metric group for this parallel subtask.
    
    Specified by:
    
    getMetricGroup in interface RuntimeContext
    
    Returns:
    
    The metric group for this parallel subtask.
  - getAttemptNumber
```
public int getAttemptNumber()
```
    Description copied from interface: RuntimeContext
    
    Gets the attempt number of this parallel subtask. First attempt is numbered 0.
    
    Specified by:
    
    getAttemptNumber in interface RuntimeContext
    
    Returns:
    
    Attempt number of the subtask.
  - getTaskNameWithSubtasks
```
public String getTaskNameWithSubtasks()
```
    Description copied from interface: RuntimeContext
    
    Returns the name of the task, appended with the subtask indicator, such as "MyTask (3/6)", where 3 would be (RuntimeContext.getIndexOfThisSubtask() + 1), and 6 would be RuntimeContext.getNumberOfParallelSubtasks().
    
    Specified by:
    
    getTaskNameWithSubtasks in interface RuntimeContext
    
    Returns:
    
    The name of the task, with subtask indicator.
  - getIntCounter
```
public IntCounter getIntCounter(String name)
```
    Description copied from interface: RuntimeContext
    
    Convenience function to create a counter object for integers.
    
    Specified by:
    
    getIntCounter in interface RuntimeContext
  - getLongCounter
```
public LongCounter getLongCounter(String name)
```
    Description copied from interface: RuntimeContext
    
    Convenience function to create a counter object for longs.
    
    Specified by:
    
    getLongCounter in interface RuntimeContext
  - getHistogram
```
public Histogram getHistogram(String name)
```
    Description copied from interface: RuntimeContext
    
    Convenience function to create a counter object for histograms.
    
    Specified by:
    
    getHistogram in interface RuntimeContext
  - getDoubleCounter
```
public DoubleCounter getDoubleCounter(String name)
```
    Description copied from interface: RuntimeContext
    
    Convenience function to create a counter object for doubles.
    
    Specified by:
    
    getDoubleCounter in interface RuntimeContext
  - addAccumulator
```
public <V,A extends Serializable> void addAccumulator(String name,
                                                      Accumulator<V,A> accumulator)
```
    Description copied from interface: RuntimeContext
    
    Add this accumulator. Throws an exception if the accumulator already exists in the same Task. Note that the Accumulator name must have an unique name across the Flink job. Otherwise you will get an error when incompatible accumulators from different Tasks are combined at the JobManager upon job completion.
    
    Specified by:
    
    addAccumulator in interface RuntimeContext
  - getAccumulator
```
public <V,A extends Serializable> Accumulator<V,A> getAccumulator(String name)
```
    Description copied from interface: RuntimeContext
    
    Get an existing accumulator object. The accumulator must have been added previously in this local runtime context. Throws an exception if the accumulator does not exist or if the accumulator exists, but with different type.
    
    Specified by:
    
    getAccumulator in interface RuntimeContext
  - getAllAccumulators
```
public Map<String,Accumulator<?,?>> getAllAccumulators()
```
    Description copied from interface: RuntimeContext
    
    Returns a map of all registered accumulators for this task. The returned map must not be modified.
    
    Specified by:
    
    getAllAccumulators in interface RuntimeContext
  - getUserCodeClassLoader
```
public ClassLoader getUserCodeClassLoader()
```
    Description copied from interface: RuntimeContext
    
    Gets the ClassLoader to load classes that were are not in system's classpath, but are part of the jar file of a user job.
    
    Specified by:
    
    getUserCodeClassLoader in interface RuntimeContext
    
    Returns:
    
    The ClassLoader for user code classes.
  - getDistributedCache
```
public DistributedCache getDistributedCache()
```
    Description copied from interface: RuntimeContext
    
    Returns the DistributedCache to get the local temporary file copies of files otherwise not locally accessible.
    
    Specified by:
    
    getDistributedCache in interface RuntimeContext
    
    Returns:
    
    The distributed cache of the worker executing this instance.
  - getState
```
@PublicEvolving
public <T> ValueState<T> getState(ValueStateDescriptor<T> stateProperties)
```
    Description copied from interface: RuntimeContext
    Gets a handle to the system's key/value state. The key/value state is only accessible if the function is executed on a KeyedStream. On each access, the state exposes the value for the key of the element currently processed by the function. Each function may have multiple partitioned states, addressed with different names.
    Because the scope of each value is the key of the currently processed element, and the elements are distributed by the Flink runtime, the system can transparently scale out and redistribute the state and KeyedStream.
    The following code example shows how to implement a continuous counter that counts how many times elements of a certain key occur, and emits an updated count for that element on each occurrence.
```
 DataStream<MyType> stream = ...;
 KeyedStream<MyType> keyedStream = stream.keyBy("id");

 keyedStream.map(new RichMapFunction<MyType, Tuple2<MyType, Long>>() {

     private ValueState<Long> state;

     public void open(Configuration cfg) {
         state = getRuntimeContext().getState(
                 new ValueStateDescriptor<Long>("count", LongSerializer.INSTANCE, 0L));
     }

     public Tuple2<MyType, Long> map(MyType value) {
         long count = state.value() + 1;
         state.update(value);
         return new Tuple2<>(value, count);
     }
 });
 
```
    Specified by:
    
    getState in interface RuntimeContext
    
    Type Parameters:
    
    T - The type of value stored in the state.
    
    Parameters:
    
    stateProperties - The descriptor defining the properties of the stats.
    
    Returns:
    
    The partitioned state object.
  - getListState
```
@PublicEvolving
public <T> ListState<T> getListState(ListStateDescriptor<T> stateProperties)
```
    Description copied from interface: RuntimeContext
    Gets a handle to the system's key/value list state. This state is similar to the state accessed via RuntimeContext.getState(ValueStateDescriptor), but is optimized for state that holds lists. One can add elements to the list, or retrieve the list as a whole.
    This state is only accessible if the function is executed on a KeyedStream.
```
 DataStream<MyType> stream = ...;
 KeyedStream<MyType> keyedStream = stream.keyBy("id");

 keyedStream.map(new RichFlatMapFunction<MyType, List<MyType>>() {

     private ListState<MyType> state;

     public void open(Configuration cfg) {
         state = getRuntimeContext().getListState(
                 new ListStateDescriptor<>("myState", MyType.class));
     }

     public void flatMap(MyType value, Collector<MyType> out) {
         if (value.isDivider()) {
             for (MyType t : state.get()) {
                 out.collect(t);
             }
         } else {
             state.add(value);
         }
     }
 });
 
```
    Specified by:
    
    getListState in interface RuntimeContext
    
    Type Parameters:
    
    T - The type of value stored in the state.
    
    Parameters:
    
    stateProperties - The descriptor defining the properties of the stats.
    
    Returns:
    
    The partitioned state object.
  - getReducingState
```
@PublicEvolving
public <T> ReducingState<T> getReducingState(ReducingStateDescriptor<T> stateProperties)
```
    Description copied from interface: RuntimeContext
    Gets a handle to the system's key/value reducing state. This state is similar to the state accessed via RuntimeContext.getState(ValueStateDescriptor), but is optimized for state that aggregates values.
    This state is only accessible if the function is executed on a KeyedStream.
```
 DataStream<MyType> stream = ...;
 KeyedStream<MyType> keyedStream = stream.keyBy("id");

 keyedStream.map(new RichMapFunction<MyType, List<MyType>>() {

     private ReducingState<Long> state;

     public void open(Configuration cfg) {
         state = getRuntimeContext().getReducingState(
                 new ReducingStateDescriptor<>("sum", (a, b) -> a + b, Long.class));
     }

     public Tuple2<MyType, Long> map(MyType value) {
         state.add(value.count());
         return new Tuple2<>(value, state.get());
     }
 });

 
```
    Specified by:
    
    getReducingState in interface RuntimeContext
    
    Type Parameters:
    
    T - The type of value stored in the state.
    
    Parameters:
    
    stateProperties - The descriptor defining the properties of the stats.
    
    Returns:
    
    The partitioned state object.
  - getAggregatingState
```
@PublicEvolving
public <IN,ACC,OUT> AggregatingState<IN,OUT> getAggregatingState(AggregatingStateDescriptor<IN,ACC,OUT> stateProperties)
```
    Description copied from interface: RuntimeContext
    Gets a handle to the system's key/value aggregating state. This state is similar to the state accessed via RuntimeContext.getState(ValueStateDescriptor), but is optimized for state that aggregates values with different types.
    This state is only accessible if the function is executed on a KeyedStream.
```
 DataStream<MyType> stream = ...;
 KeyedStream<MyType> keyedStream = stream.keyBy("id");
 AggregateFunction<...> aggregateFunction = ...

 keyedStream.map(new RichMapFunction<MyType, List<MyType>>() {

     private AggregatingState<MyType, Long> state;

     public void open(Configuration cfg) {
         state = getRuntimeContext().getAggregatingState(
                 new AggregatingStateDescriptor<>("sum", aggregateFunction, Long.class));
     }

     public Tuple2<MyType, Long> map(MyType value) {
         state.add(value);
         return new Tuple2<>(value, state.get());
     }
 });

 
```
    Specified by:
    
    getAggregatingState in interface RuntimeContext
    
    Type Parameters:
    
    IN - The type of the values that are added to the state.
    
    ACC - The type of the accumulator (intermediate aggregation state).
    
    OUT - The type of the values that are returned from the state.
    
    Parameters:
    
    stateProperties - The descriptor defining the properties of the stats.
    
    Returns:
    
    The partitioned state object.
  - getFoldingState
```
@PublicEvolving
 @Deprecated
public <T,ACC> FoldingState<T,ACC> getFoldingState(FoldingStateDescriptor<T,ACC> stateProperties)
```
    Deprecated.
    
    Description copied from interface: RuntimeContext
    Gets a handle to the system's key/value folding state. This state is similar to the state accessed via RuntimeContext.getState(ValueStateDescriptor), but is optimized for state that aggregates values with different types.
    This state is only accessible if the function is executed on a KeyedStream.
```
 DataStream<MyType> stream = ...;
 KeyedStream<MyType> keyedStream = stream.keyBy("id");

 keyedStream.map(new RichMapFunction<MyType, List<MyType>>() {

     private FoldingState<MyType, Long> state;

     public void open(Configuration cfg) {
         state = getRuntimeContext().getFoldingState(
                 new FoldingStateDescriptor<>("sum", 0L, (a, b) -> a.count() + b, Long.class));
     }

     public Tuple2<MyType, Long> map(MyType value) {
         state.add(value);
         return new Tuple2<>(value, state.get());
     }
 });

 
```
    Specified by:
    
    getFoldingState in interface RuntimeContext
    
    Type Parameters:
    
    T - Type of the values folded in the other state
    
    ACC - Type of the value in the state
    
    Parameters:
    
    stateProperties - The descriptor defining the properties of the stats.
    
    Returns:
    
    The partitioned state object.
  - getMapState
```
@PublicEvolving
public <UK,UV> MapState<UK,UV> getMapState(MapStateDescriptor<UK,UV> stateProperties)
```
    Description copied from interface: RuntimeContext
    Gets a handle to the system's key/value map state. This state is similar to the state accessed via RuntimeContext.getState(ValueStateDescriptor), but is optimized for state that is composed of user-defined key-value pairs
    This state is only accessible if the function is executed on a KeyedStream.
```
 DataStream<MyType> stream = ...;
 KeyedStream<MyType> keyedStream = stream.keyBy("id");

 keyedStream.map(new RichMapFunction<MyType, List<MyType>>() {

     private MapState<MyType, Long> state;

     public void open(Configuration cfg) {
         state = getRuntimeContext().getMapState(
                 new MapStateDescriptor<>("sum", MyType.class, Long.class));
     }

     public Tuple2<MyType, Long> map(MyType value) {
         return new Tuple2<>(value, state.get(value));
     }
 });

 
```
    Specified by:
    
    getMapState in interface RuntimeContext
    
    Type Parameters:
    
    UK - The type of the user keys stored in the state.
    
    UV - The type of the user values stored in the state.
    
    Parameters:
    
    stateProperties - The descriptor defining the properties of the stats.
    
    Returns:
    
    The partitioned state object.
  - getAllocationIDAsString
```
@Internal
 @VisibleForTesting
public String getAllocationIDAsString()
```

Class AbstractRuntimeUDFContext

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.flink.api.common.functions.RuntimeContext

Constructor Detail

AbstractRuntimeUDFContext

Method Detail

getExecutionConfig

getTaskName

getNumberOfParallelSubtasks

getMaxNumberOfParallelSubtasks

getIndexOfThisSubtask

getMetricGroup

getAttemptNumber

getTaskNameWithSubtasks

getIntCounter

getLongCounter

getHistogram

getDoubleCounter

addAccumulator

getAccumulator

getAllAccumulators

getUserCodeClassLoader

getDistributedCache

getState

getListState

getReducingState

getAggregatingState

getFoldingState

getMapState

getAllocationIDAsString