public class DirectoryKeyedStateHandle extends Object implements KeyedStateHandle
DirectoryStateHandle
and a KeyGroupRange
.Constructor and Description |
---|
DirectoryKeyedStateHandle(DirectoryStateHandle directoryStateHandle,
KeyGroupRange keyGroupRange) |
Modifier and Type | Method and Description |
---|---|
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) |
long |
getCheckpointedSize()
Returns the persisted data size during checkpoint execution in bytes.
|
DirectoryStateHandle |
getDirectoryStateHandle() |
KeyedStateHandle |
getIntersection(KeyGroupRange otherKeyGroupRange)
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.
|
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() |
void |
registerSharedStates(SharedStateRegistry stateRegistry,
long checkpointID)
Register both newly created and already referenced shared states in the given
SharedStateRegistry . |
String |
toString() |
public DirectoryKeyedStateHandle(@Nonnull DirectoryStateHandle directoryStateHandle, @Nonnull KeyGroupRange keyGroupRange)
@Nonnull public DirectoryStateHandle getDirectoryStateHandle()
@Nonnull public KeyGroupRange getKeyGroupRange()
KeyedStateHandle
getKeyGroupRange
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 KeyedStateHandle getIntersection(KeyGroupRange otherKeyGroupRange)
KeyedStateHandle
getIntersection
in interface KeyedStateHandle
otherKeyGroupRange
- 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 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.Copyright © 2014–2024 The Apache Software Foundation. All rights reserved.