public class IncrementalRemoteKeyedStateHandle extends Object implements IncrementalKeyedStateHandle
The states contained in an incremental snapshot include:
SharedStateRegistry
, all referenced
shared state handles are only placeholders, so that we do not send state handles twice from
which we know that they already exist on the checkpoint coordinator.
SharedStateRegistry
, so that all placeholder state handles to
previously existing state are replaced with the originals.
IMPORTANT: This class currently overrides equals and hash code only for testing purposes. They should not be called from production code. This means this class is also not suited to serve as a key, e.g. in hash maps.
IncrementalKeyedStateHandle.HandleAndLocalPath
Modifier and Type | Field and Description |
---|---|
static long |
UNKNOWN_CHECKPOINTED_SIZE |
Modifier | Constructor and Description |
---|---|
|
IncrementalRemoteKeyedStateHandle(UUID backendIdentifier,
KeyGroupRange keyGroupRange,
long checkpointId,
List<IncrementalKeyedStateHandle.HandleAndLocalPath> sharedState,
List<IncrementalKeyedStateHandle.HandleAndLocalPath> privateState,
StreamStateHandle metaStateHandle) |
|
IncrementalRemoteKeyedStateHandle(UUID backendIdentifier,
KeyGroupRange keyGroupRange,
long checkpointId,
List<IncrementalKeyedStateHandle.HandleAndLocalPath> sharedState,
List<IncrementalKeyedStateHandle.HandleAndLocalPath> privateState,
StreamStateHandle metaStateHandle,
long persistedSizeOfThisCheckpoint) |
protected |
IncrementalRemoteKeyedStateHandle(UUID backendIdentifier,
KeyGroupRange keyGroupRange,
long checkpointId,
List<IncrementalKeyedStateHandle.HandleAndLocalPath> sharedState,
List<IncrementalKeyedStateHandle.HandleAndLocalPath> privateState,
StreamStateHandle metaStateHandle,
long persistedSizeOfThisCheckpoint,
StateHandleID stateHandleId) |
Modifier and Type | Method and Description |
---|---|
SharedStateRegistryKey |
createSharedStateRegistryKey(StreamStateHandle handle)
Create a unique key based on physical id to register one of our shared state handles.
|
void |
discardState()
Discards the state referred to and solemnly owned by this handle, to free up resources in the
persistent storage.
|
boolean |
equals(Object o)
This method is should only be called in tests!
|
UUID |
getBackendIdentifier()
Returns the identifier of the state backend from which this handle was created.
|
long |
getCheckpointedSize()
Returns the persisted data size during checkpoint execution in bytes.
|
long |
getCheckpointId()
Returns the ID of the checkpoint for which the handle was created or used.
|
KeyedStateHandle |
getIntersection(KeyGroupRange keyGroupRange)
Returns a state over a range that is the intersection between this handle's key-group range
and the provided key-group range.
|
KeyGroupRange |
getKeyGroupRange()
Returns the range of the key groups contained in the state.
|
StreamStateHandle |
getMetaStateHandle() |
List<IncrementalKeyedStateHandle.HandleAndLocalPath> |
getPrivateState() |
List<IncrementalKeyedStateHandle.HandleAndLocalPath> |
getSharedState() |
List<IncrementalKeyedStateHandle.HandleAndLocalPath> |
getSharedStateHandles()
Returns a list of all shared states and the corresponding localPath in the backend at the
time this was created.
|
SharedStateRegistry |
getSharedStateRegistry() |
StateHandleID |
getStateHandleId()
Returns a unique state handle id to distinguish with other keyed state handles.
|
long |
getStateSize()
Returns the size of the state in bytes.
|
int |
hashCode()
This method should only be called in tests!
|
CheckpointBoundKeyedStateHandle |
rebound(long checkpointId)
Returns a new
CheckpointBoundKeyedStateHandle Rebounding checkpoint id to a specific
checkpoint id. |
void |
registerSharedStates(SharedStateRegistry stateRegistry,
long checkpointID)
Register both newly created and already referenced shared states in the given
SharedStateRegistry . |
static IncrementalRemoteKeyedStateHandle |
restore(UUID backendIdentifier,
KeyGroupRange keyGroupRange,
long checkpointId,
List<IncrementalKeyedStateHandle.HandleAndLocalPath> sharedState,
List<IncrementalKeyedStateHandle.HandleAndLocalPath> privateState,
StreamStateHandle metaStateHandle,
long persistedSizeOfThisCheckpoint,
StateHandleID stateHandleId) |
String |
toString() |
public static final long UNKNOWN_CHECKPOINTED_SIZE
@VisibleForTesting public IncrementalRemoteKeyedStateHandle(UUID backendIdentifier, KeyGroupRange keyGroupRange, long checkpointId, List<IncrementalKeyedStateHandle.HandleAndLocalPath> sharedState, List<IncrementalKeyedStateHandle.HandleAndLocalPath> privateState, StreamStateHandle metaStateHandle)
public IncrementalRemoteKeyedStateHandle(UUID backendIdentifier, KeyGroupRange keyGroupRange, long checkpointId, List<IncrementalKeyedStateHandle.HandleAndLocalPath> sharedState, List<IncrementalKeyedStateHandle.HandleAndLocalPath> privateState, StreamStateHandle metaStateHandle, long persistedSizeOfThisCheckpoint)
protected IncrementalRemoteKeyedStateHandle(UUID backendIdentifier, KeyGroupRange keyGroupRange, long checkpointId, List<IncrementalKeyedStateHandle.HandleAndLocalPath> sharedState, List<IncrementalKeyedStateHandle.HandleAndLocalPath> privateState, StreamStateHandle metaStateHandle, long persistedSizeOfThisCheckpoint, StateHandleID stateHandleId)
public static IncrementalRemoteKeyedStateHandle restore(UUID backendIdentifier, KeyGroupRange keyGroupRange, long checkpointId, List<IncrementalKeyedStateHandle.HandleAndLocalPath> sharedState, List<IncrementalKeyedStateHandle.HandleAndLocalPath> privateState, StreamStateHandle metaStateHandle, long persistedSizeOfThisCheckpoint, StateHandleID stateHandleId)
public KeyGroupRange getKeyGroupRange()
KeyedStateHandle
getKeyGroupRange
in interface KeyedStateHandle
public long getCheckpointId()
CheckpointBoundKeyedStateHandle
getCheckpointId
in interface CheckpointBoundKeyedStateHandle
public CheckpointBoundKeyedStateHandle rebound(long checkpointId)
CheckpointBoundKeyedStateHandle
CheckpointBoundKeyedStateHandle
Rebounding checkpoint id to a specific
checkpoint id.rebound
in interface CheckpointBoundKeyedStateHandle
checkpointId
- rebounded checkpoint id.public List<IncrementalKeyedStateHandle.HandleAndLocalPath> getSharedState()
public List<IncrementalKeyedStateHandle.HandleAndLocalPath> getPrivateState()
public StreamStateHandle getMetaStateHandle()
@Nonnull public UUID getBackendIdentifier()
IncrementalKeyedStateHandle
getBackendIdentifier
in interface IncrementalKeyedStateHandle
@Nonnull public List<IncrementalKeyedStateHandle.HandleAndLocalPath> getSharedStateHandles()
IncrementalKeyedStateHandle
getSharedStateHandles
in interface IncrementalKeyedStateHandle
public SharedStateRegistry getSharedStateRegistry()
public KeyedStateHandle getIntersection(KeyGroupRange keyGroupRange)
KeyedStateHandle
getIntersection
in interface KeyedStateHandle
keyGroupRange
- The key group range to intersect with, will return null if the
intersection of this handle's key-group and the provided key-group is empty.public StateHandleID getStateHandleId()
KeyedStateHandle
ChangelogStateBackendHandle
, it should persist this state handle id when serializing of
checkpoint and deserialize it back to ensure the state handle id is constant.
getStateHandleId
in interface KeyedStateHandle
public void discardState() throws Exception
StateObject
discardState
in interface StateObject
Exception
public long getStateSize()
StateObject
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.
getStateSize
in interface StateObject
public long getCheckpointedSize()
CompositeStateHandle
StateObject.getStateSize()
. If the size is unknown, this method would return same
result as StateObject.getStateSize()
.getCheckpointedSize
in interface CompositeStateHandle
public void registerSharedStates(SharedStateRegistry stateRegistry, long checkpointID)
CompositeStateHandle
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.
registerSharedStates
in interface CompositeStateHandle
stateRegistry
- The registry where shared states are registered.@VisibleForTesting public SharedStateRegistryKey createSharedStateRegistryKey(StreamStateHandle handle)
@VisibleForTesting public boolean equals(Object o)
@VisibleForTesting public int hashCode()
Copyright © 2014–2024 The Apache Software Foundation. All rights reserved.