public class SnapshotResult<T extends StateObject> extends Object implements StateObject
TaskLocalStateStoreImpl
.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.
|
static <T extends StateObject> |
empty() |
T |
getJobManagerOwnedSnapshot() |
long |
getStateSize()
Returns the size of the state in bytes.
|
T |
getTaskLocalSnapshot() |
static <T extends StateObject> |
of(T jobManagerState) |
static <T extends StateObject> |
withLocalState(T jobManagerState,
T localState) |
public T getJobManagerOwnedSnapshot()
public T getTaskLocalSnapshot()
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 static <T extends StateObject> SnapshotResult<T> empty()
public static <T extends StateObject> SnapshotResult<T> of(@Nullable T jobManagerState)
public static <T extends StateObject> SnapshotResult<T> withLocalState(@Nonnull T jobManagerState, @Nonnull T localState)
Copyright © 2014–2019 The Apache Software Foundation. All rights reserved.