StateRequestType (Flink : Runtime 1.20.1 API)

java.lang.Object
- java.lang.Enum<StateRequestType>
- - org.apache.flink.runtime.asyncprocessing.StateRequestType

All Implemented Interfaces:

Serializable, Comparable<StateRequestType>
```
public enum StateRequestType
extends Enum<StateRequestType>
```
The type of processing request for State from **users' perspective**. Each interface of State and its sub-interfaces will have a corresponding enum entry.
TODO: Serialization and Deserialization.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`AGGREGATING_ADD` Add element to aggregating state by `AppendingState.asyncAdd(Object)`.
`AGGREGATING_GET` Get value from aggregating state by `AppendingState.asyncGet()`.
`CLEAR` Clear the current partition of the state, `State.asyncClear()`.
`ITERATOR_LOADING` Continuously load elements for one iterator.
`LIST_ADD` Add value to list state, `AppendingState.asyncAdd(Object)`.
`LIST_ADD_ALL` Add multiple value to list of current partition, `ListState.asyncAddAll(List)`.
`LIST_GET` Get from list state, `AppendingState.asyncGet()`.
`LIST_UPDATE` Put a list to current partition, `ListState.asyncUpdate(List)`.
`MAP_CONTAINS` Check key existence of current partition, `MapState.asyncContains(Object)`}.
`MAP_GET` Get a value by a key from current partition, `MapState.asyncGet(Object)`.
`MAP_IS_EMPTY` Check the existence of any key-value mapping within current partition, `MapState.asyncIsEmpty()`.
`MAP_ITER` Get an iterator of key-value mapping within current partition, `MapState.asyncEntries()`.
`MAP_ITER_KEY` Get an iterator of keys within current partition, `MapState.asyncKeys()`.
`MAP_ITER_VALUE` Get an iterator of values within current partition, `MapState.asyncKeys()`.
`MAP_PUT` Update a key-value pair of current partition, `MapState.asyncPut(Object, Object)`.
`MAP_PUT_ALL` Update multiple key-value pairs of current partition, `MapState.asyncPutAll(Map)`.
`MAP_REMOVE` Remove a key-value mapping within current partition, `MapState.asyncRemove(Object)`.
`REDUCING_ADD` Add element into reducing state, `AppendingState.asyncAdd(Object)`.
`REDUCING_GET` Get from reducing state, `AppendingState.asyncGet()`.
`SYNC_POINT` A sync point with AEC, does nothing with state, checking if the key is occupied by others and blocking if needed.
`VALUE_GET` Get value from current partition, `ValueState.asyncValue()`.
`VALUE_UPDATE` Update value to current partition, `ValueState.asyncUpdate(Object)`.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static StateRequestType`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static StateRequestType[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - SYNC_POINT
```
public static final StateRequestType SYNC_POINT
```
    A sync point with AEC, does nothing with state, checking if the key is occupied by others and blocking if needed. This is a special one that only created by the runtime framework without visibility to users.
  - CLEAR
```
public static final StateRequestType CLEAR
```
    Clear the current partition of the state, State.asyncClear().
  - VALUE_GET
```
public static final StateRequestType VALUE_GET
```
    Get value from current partition, ValueState.asyncValue().
  - VALUE_UPDATE
```
public static final StateRequestType VALUE_UPDATE
```
    Update value to current partition, ValueState.asyncUpdate(Object).
  - LIST_GET
```
public static final StateRequestType LIST_GET
```
    Get from list state, AppendingState.asyncGet().
  - LIST_ADD
```
public static final StateRequestType LIST_ADD
```
    Add value to list state, AppendingState.asyncAdd(Object).
  - LIST_UPDATE
```
public static final StateRequestType LIST_UPDATE
```
    Put a list to current partition, ListState.asyncUpdate(List).
  - LIST_ADD_ALL
```
public static final StateRequestType LIST_ADD_ALL
```
    Add multiple value to list of current partition, ListState.asyncAddAll(List).
  - MAP_GET
```
public static final StateRequestType MAP_GET
```
    Get a value by a key from current partition, MapState.asyncGet(Object).
  - MAP_CONTAINS
```
public static final StateRequestType MAP_CONTAINS
```
    Check key existence of current partition, MapState.asyncContains(Object)}.
  - MAP_PUT
```
public static final StateRequestType MAP_PUT
```
    Update a key-value pair of current partition, MapState.asyncPut(Object, Object).
  - MAP_PUT_ALL
```
public static final StateRequestType MAP_PUT_ALL
```
    Update multiple key-value pairs of current partition, MapState.asyncPutAll(Map).
  - MAP_ITER
```
public static final StateRequestType MAP_ITER
```
    Get an iterator of key-value mapping within current partition, MapState.asyncEntries().
  - MAP_ITER_KEY
```
public static final StateRequestType MAP_ITER_KEY
```
    Get an iterator of keys within current partition, MapState.asyncKeys().
  - MAP_ITER_VALUE
```
public static final StateRequestType MAP_ITER_VALUE
```
    Get an iterator of values within current partition, MapState.asyncKeys().
  - MAP_REMOVE
```
public static final StateRequestType MAP_REMOVE
```
    Remove a key-value mapping within current partition, MapState.asyncRemove(Object).
  - MAP_IS_EMPTY
```
public static final StateRequestType MAP_IS_EMPTY
```
    Check the existence of any key-value mapping within current partition, MapState.asyncIsEmpty().
  - ITERATOR_LOADING
```
public static final StateRequestType ITERATOR_LOADING
```
    Continuously load elements for one iterator.
  - REDUCING_GET
```
public static final StateRequestType REDUCING_GET
```
    Get from reducing state, AppendingState.asyncGet().
  - REDUCING_ADD
```
public static final StateRequestType REDUCING_ADD
```
    Add element into reducing state, AppendingState.asyncAdd(Object).
  - AGGREGATING_GET
```
public static final StateRequestType AGGREGATING_GET
```
    Get value from aggregating state by AppendingState.asyncGet().
  - AGGREGATING_ADD
```
public static final StateRequestType AGGREGATING_ADD
```
    Add element to aggregating state by AppendingState.asyncAdd(Object).
- Method Detail
  - values
```
public static StateRequestType[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (StateRequestType c : StateRequestType.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static StateRequestType valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null

Enum StateRequestType

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

SYNC_POINT

CLEAR

VALUE_GET

VALUE_UPDATE

LIST_GET

LIST_ADD

LIST_UPDATE

LIST_ADD_ALL

MAP_GET

MAP_CONTAINS

MAP_PUT

MAP_PUT_ALL

MAP_ITER

MAP_ITER_KEY

MAP_ITER_VALUE

MAP_REMOVE

MAP_IS_EMPTY

ITERATOR_LOADING

REDUCING_GET

REDUCING_ADD

AGGREGATING_GET

AGGREGATING_ADD

Method Detail

values

valueOf