org.apache.flink.runtime.state

Interface CompletedCheckpointStorageLocation

All Superinterfaces:

Serializable

All Known Implementing Classes:

FsCompletedCheckpointStorageLocation

public interface CompletedCheckpointStorageLocation
extends Serializable

The CompletedCheckpointStorageLocation describes the storage aspect of a completed checkpoint. It can be used to obtain access to the metadata, get a reference pointer to the checkpoint, or to dispose the storage location.

Method Summary

Modifier and Type	Method and Description
void	disposeStorageLocation() Disposes the storage location.
String	getExternalPointer() Gets the external pointer to the checkpoint.
StreamStateHandle	getMetadataHandle() Gets the state handle to the checkpoint's metadata.

Method Detail

getExternalPointer

String getExternalPointer()

Gets the external pointer to the checkpoint. The pointer can be used to resume a program from the savepoint or checkpoint, and is typically passed as a command line argument, an HTTP request parameter, or stored in a system like ZooKeeper.

getMetadataHandle

StreamStateHandle getMetadataHandle()

Gets the state handle to the checkpoint's metadata.

disposeStorageLocation

void disposeStorageLocation()
                     throws IOException

Disposes the storage location. This method should be called after all state objects have been released. It typically disposes the base structure of the checkpoint storage, like the checkpoint directory.

Throws:

IOException