org.apache.flink.streaming.runtime.tasks

Class StreamTaskState

java.lang.Object

org.apache.flink.streaming.runtime.tasks.StreamTaskState

All Implemented Interfaces:

Serializable

@Internal
public class StreamTaskState
extends Object
implements Serializable

The state checkpointed by a AbstractStreamOperator. This state consists of any combination of those three:

• The state of the stream operator, if it implements the Checkpointed interface.
• The state of the user function, if it implements the Checkpointed interface.
• The key/value state of the operator, if it executes on a KeyedDataStream.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
StreamTaskState()

Method Summary

Modifier and Type	Method and Description
void	discardState() Discards all the contained states and sets them to null.
StateHandle<Serializable>	getFunctionState()
HashMap<String,KvStateSnapshot<?,?,?,?,?>>	getKvStates()
StateHandle<?>	getOperatorState()
boolean	isEmpty() Checks if this state object actually contains any state, or if all of the state fields are null.
void	setFunctionState(StateHandle<Serializable> functionState)
void	setKvStates(HashMap<String,KvStateSnapshot<?,?,?,?,?>> kvStates)
void	setOperatorState(StateHandle<?> operatorState)

Methods inherited from class java.lang.Object

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

Constructor Detail

StreamTaskState

public StreamTaskState()

Method Detail

getOperatorState

public StateHandle<?> getOperatorState()

setOperatorState

public void setOperatorState(StateHandle<?> operatorState)

getFunctionState

public StateHandle<Serializable> getFunctionState()

setFunctionState

public void setFunctionState(StateHandle<Serializable> functionState)

getKvStates

public HashMap<String,KvStateSnapshot<?,?,?,?,?>> getKvStates()

setKvStates

public void setKvStates(HashMap<String,KvStateSnapshot<?,?,?,?,?>> kvStates)

isEmpty

public boolean isEmpty()

Checks if this state object actually contains any state, or if all of the state fields are null.

Returns:

True, if all state is null, false if at least one state is not null.

discardState

public void discardState()
                  throws Exception

Discards all the contained states and sets them to null.

Throws:

Exception - Forwards exceptions that occur when releasing the state handles and snapshots.