public interface CheckpointStorageCoordinatorView
CheckpointStorageLocation
to which an individual checkpoint or
savepoint is stored.
Methods of this interface act as an administration role in checkpoint coordinator.
Modifier and Type | Method and Description |
---|---|
boolean |
hasDefaultSavepointLocation()
Checks whether the storage has a default savepoint location configured.
|
void |
initializeBaseLocationsForCheckpoint()
Initializes the necessary prerequisites for storage locations of checkpoints.
|
CheckpointStorageLocation |
initializeLocationForCheckpoint(long checkpointId)
Initializes a storage location for new checkpoint with the given ID.
|
CheckpointStorageLocation |
initializeLocationForSavepoint(long checkpointId,
String externalLocationPointer)
Initializes a storage location for new savepoint with the given ID.
|
CompletedCheckpointStorageLocation |
resolveCheckpoint(String externalPointer)
Resolves the given pointer to a checkpoint/savepoint into a checkpoint location.
|
boolean |
supportsHighlyAvailableStorage()
Checks whether this backend supports highly available storage of data.
|
boolean supportsHighlyAvailableStorage()
Some state backends may not support highly-available durable storage, with default settings, which makes them suitable for zero-config prototyping, but not for actual production setups.
boolean hasDefaultSavepointLocation()
CompletedCheckpointStorageLocation resolveCheckpoint(String externalPointer) throws IOException
If the state backend cannot understand the format of the pointer (for example because it
was created by a different state backend) this method should throw an IOException
.
externalPointer
- The external checkpoint pointer to resolve.IOException
- Thrown, if the state backend does not understand the pointer, or if the
pointer could not be resolved due to an I/O error.void initializeBaseLocationsForCheckpoint() throws IOException
For file-based checkpoint storage, this method would initialize essential base checkpoint
directories on checkpoint coordinator side and should be executed before calling initializeLocationForCheckpoint(long)
.
IOException
- Thrown, if these base storage locations cannot be initialized due to an
I/O exception.CheckpointStorageLocation initializeLocationForCheckpoint(long checkpointId) throws IOException
The returned storage location can be used to write the checkpoint data and metadata to and to obtain the pointers for the location(s) where the actual checkpoint data should be stored.
checkpointId
- The ID (logical timestamp) of the checkpoint that should be persisted.IOException
- Thrown if the storage location cannot be initialized due to an I/O
exception.CheckpointStorageLocation initializeLocationForSavepoint(long checkpointId, @Nullable String externalLocationPointer) throws IOException
If an external location pointer is passed, the savepoint storage location will be
initialized at the location of that pointer. If the external location pointer is null, the
default savepoint location will be used. If no default savepoint location is configured, this
will throw an exception. Whether a default savepoint location is configured can be checked
via hasDefaultSavepointLocation()
.
checkpointId
- The ID (logical timestamp) of the savepoint's checkpoint.externalLocationPointer
- Optionally, a pointer to the location where the savepoint
should be stored. May be null.IOException
- Thrown if the storage location cannot be initialized due to an I/O
exception.Copyright © 2014–2024 The Apache Software Foundation. All rights reserved.