public class OperatorSubtaskState extends Object implements CompositeStateHandle
OperatorSubtaskStates from all parallel tasks that physically execute parallelized, physical
instances of the operator.
The full state of the logical operator is represented by OperatorState which consists
of OperatorSubtaskStates.
Typically, we expect all collections in this class to be of size 0 or 1, because there is up to one state handle produced per state type (e.g. managed-keyed, raw-operator, ...). In particular, this holds when taking a snapshot. The purpose of having the state handles in collections is that this class is also reused in restoring state. Under normal circumstances, the expected size of each collection is still 0 or 1, except for scale-down. In scale-down, one operator subtask can become responsible for the state of multiple previous subtasks. The collections can then store all the state handles that are relevant to build up the new subtask state.
| Modifier and Type | Class and Description |
|---|---|
static class |
OperatorSubtaskState.Builder
The builder for a new
OperatorSubtaskState which can be obtained by builder(). |
StateObject.StateObjectLocation, StateObject.StateObjectSizeStatsCollectorclone, finalize, getClass, notify, notifyAll, wait, wait, waitcollectSizeStatspublic StateObjectCollection<OperatorStateHandle> getManagedOperatorState()
public StateObjectCollection<OperatorStateHandle> getRawOperatorState()
public StateObjectCollection<KeyedStateHandle> getManagedKeyedState()
public StateObjectCollection<KeyedStateHandle> getRawKeyedState()
public StateObjectCollection<InputChannelStateHandle> getInputChannelState()
public StateObjectCollection<ResultSubpartitionStateHandle> getResultSubpartitionState()
public InflightDataRescalingDescriptor getInputRescalingDescriptor()
public InflightDataRescalingDescriptor getOutputRescalingDescriptor()
public List<StateObject> getDiscardables()
public void discardState()
StateObjectdiscardState in interface StateObjectpublic void registerSharedStates(SharedStateRegistry sharedStateRegistry, long checkpointID)
CompositeStateHandleSharedStateRegistry. 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.
registerSharedStates in interface CompositeStateHandlesharedStateRegistry - The registry where shared states are registered.public long getCheckpointedSize()
CompositeStateHandleStateObject.getStateSize(). If the size is unknown, this method would return same
result as StateObject.getStateSize().getCheckpointedSize in interface CompositeStateHandlepublic long getStateSize()
StateObject0.
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.
getStateSize in interface StateObjectpublic boolean isFinished()
public boolean hasState()
public OperatorSubtaskState.Builder toBuilder()
public static OperatorSubtaskState.Builder builder()
Copyright © 2014–2024 The Apache Software Foundation. All rights reserved.