Package org.apache.flink.runtime.checkpoint

Class OperatorState

java.lang.Object
org.apache.flink.runtime.checkpoint.OperatorState
All Implemented Interfaces:
Serializable, CompositeStateHandle, StateObject
Direct Known Subclasses:
FullyFinishedOperatorState
public class OperatorState extends Object implements CompositeStateHandle
Simple container class which contains the raw/managed operator state and key-group state handles from all subtasks of an operator and therefore represents the complete state of a logical operator.
See Also:

  • Constructor Details

    • OperatorState

      public OperatorState(@Nullable String operatorName, @Nullable String operatorUid, OperatorID operatorID, int parallelism, int maxParallelism)

  • Method Details

    • getOperatorName

      public Optional<String> getOperatorName()

    • setOperatorName

      public void setOperatorName(String operatorName)

    • getOperatorUid

      public Optional<String> getOperatorUid()

    • setOperatorUid

      public void setOperatorUid(String operatorUid)

    • getOperatorID

      public OperatorID getOperatorID()

    • isFullyFinished

      public boolean isFullyFinished()

    • putState

      public void putState(int subtaskIndex, OperatorSubtaskState subtaskState)

    • getState

      public OperatorSubtaskState getState(int subtaskIndex)

    • setCoordinatorState

      public void setCoordinatorState(@Nullable ByteStreamStateHandle coordinatorState)

    • getCoordinatorState

      @Nullable public ByteStreamStateHandle getCoordinatorState()

    • getSubtaskStates

      public Map<Integer,OperatorSubtaskState> getSubtaskStates()

    • getStates

      public Collection<OperatorSubtaskState> getStates()

    • getNumberCollectedStates

      public int getNumberCollectedStates()

    • getParallelism

      public int getParallelism()

    • getMaxParallelism

      public int getMaxParallelism()

    • copyWithNewIDs

      public OperatorState copyWithNewIDs(@Nullable String newOperatorUid, OperatorID newOperatorId)

    • copyAndDiscardInFlightData

      public OperatorState copyAndDiscardInFlightData()

    • getDiscardables

      public List<StateObject> getDiscardables()

    • discardState

      public void discardState() throws Exception
      Description copied from interface: StateObject
      Discards the state referred to and solemnly owned by this handle, to free up resources in the persistent storage. This method is called when the state represented by this object will not be used anymore.
      Specified by:
      discardState in interface StateObject
      Throws:
      Exception

    • registerSharedStates

      public void registerSharedStates(SharedStateRegistry sharedStateRegistry, long checkpointID)
      Description copied from interface: CompositeStateHandle
      Register both newly created and already referenced shared states in the given SharedStateRegistry. This method is called when the checkpoint successfully completes or is recovered from failures.

      After this is completed, newly created shared state is considered as published is no longer owned by this handle. This means that it should no longer be deleted as part of calls to StateObject.discardState(). Instead, StateObject.discardState() will trigger an unregistration from the registry.

      Specified by:
      registerSharedStates in interface CompositeStateHandle
      Parameters:
      sharedStateRegistry - The registry where shared states are registered.

    • hasSubtaskStates

      public boolean hasSubtaskStates()

    • getStateSize

      public long getStateSize()
      Description copied from interface: StateObject
      Returns the size of the state in bytes. If the size is not known, this method should return 0.

      The values produced by this method are only used for informational purposes and for metrics/monitoring. If this method returns wrong values, the checkpoints and recovery will still behave correctly. However, efficiency may be impacted (wrong space pre-allocation) and functionality that depends on metrics (like monitoring) will be impacted.

      Note for implementors: This method should not perform any I/O operations while obtaining the state size (hence it does not declare throwing an IOException). Instead, the state size should be stored in the state object, or should be computable from the state stored in this object. The reason is that this method is called frequently by several parts of the checkpointing and issuing I/O requests from this method accumulates a heavy I/O load on the storage system at higher scale.

      Specified by:
      getStateSize in interface StateObject
      Returns:
      Size of the state in bytes.

    • collectSizeStats

      public void collectSizeStats(StateObject.StateObjectSizeStatsCollector collector)
      Description copied from interface: StateObject
      Collects statistics about state size and location from the state object.
      Specified by:
      collectSizeStats in interface StateObject
      Parameters:
      collector - the statistics collector.

    • getCheckpointedSize

      public long getCheckpointedSize()
      Description copied from interface: CompositeStateHandle
      Returns the persisted data size during checkpoint execution in bytes. If incremental checkpoint is enabled, this value represents the incremental persisted data size, and usually smaller than StateObject.getStateSize(). If the size is unknown, this method would return same result as StateObject.getStateSize().
      Specified by:
      getCheckpointedSize in interface CompositeStateHandle
      Returns:
      The persisted data size during checkpoint execution in bytes.

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object