org.apache.flink.streaming.runtime.tasks

Class StreamTaskState

java.lang.Object

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

All Implemented Interfaces:

Closeable, Serializable, AutoCloseable

@Internal
public class StreamTaskState
extends Object
implements Serializable, Closeable

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	close()
void	discardState() Discards all the contained states and sets them to null.
org.apache.flink.runtime.state.StateHandle<Serializable>	getFunctionState()
HashMap<String,org.apache.flink.runtime.state.KvStateSnapshot<?,?,?,?,?>>	getKvStates()
org.apache.flink.runtime.state.StateHandle<?>	getOperatorState()
boolean	isEmpty() Checks if this state object actually contains any state, or if all of the state fields are null.
void	setFunctionState(org.apache.flink.runtime.state.StateHandle<Serializable> functionState)
void	setKvStates(HashMap<String,org.apache.flink.runtime.state.KvStateSnapshot<?,?,?,?,?>> kvStates)
void	setOperatorState(org.apache.flink.runtime.state.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 org.apache.flink.runtime.state.StateHandle<?> getOperatorState()

setOperatorState

public void setOperatorState(org.apache.flink.runtime.state.StateHandle<?> operatorState)

getFunctionState

public org.apache.flink.runtime.state.StateHandle<Serializable> getFunctionState()

setFunctionState

public void setFunctionState(org.apache.flink.runtime.state.StateHandle<Serializable> functionState)

getKvStates

public HashMap<String,org.apache.flink.runtime.state.KvStateSnapshot<?,?,?,?,?>> getKvStates()

setKvStates

public void setKvStates(HashMap<String,org.apache.flink.runtime.state.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.

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException