Package org.apache.flink.runtime.state.filesystem

Class FsCheckpointStorageLocation

java.lang.Object

org.apache.flink.runtime.state.filesystem.FsCheckpointStreamFactory

org.apache.flink.runtime.state.filesystem.FsCheckpointStorageLocation

All Implemented Interfaces:

CheckpointStorageLocation, CheckpointStreamFactory

Direct Known Subclasses:

FsMergingCheckpointStorageLocation

public class FsCheckpointStorageLocation
extends FsCheckpointStreamFactory
implements CheckpointStorageLocation

A storage location for checkpoints on a file system.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.flink.runtime.state.filesystem.FsCheckpointStreamFactory

FsCheckpointStreamFactory.FsCheckpointStateOutputStream

Field Summary

Fields inherited from class org.apache.flink.runtime.state.filesystem.FsCheckpointStreamFactory

MAX_FILE_STATE_THRESHOLD

Constructor Summary

Constructors

Constructor	Description
FsCheckpointStorageLocation(FileSystem fileSystem, Path checkpointDir, Path sharedStateDir, Path taskOwnedStateDir, CheckpointStorageLocationReference reference, int fileStateSizeThreshold, int writeBufferSize)

Method Summary

Modifier and Type	Method	Description
CheckpointMetadataOutputStream	createMetadataOutputStream()	Creates the output stream to persist the checkpoint metadata to.
void	disposeOnFailure()	Disposes the checkpoint location in case the checkpoint has failed.
Path	getCheckpointDirectory()
CheckpointStorageLocationReference	getLocationReference()	Gets a reference to the storage location.
Path	getMetadataFilePath()
Path	getSharedStateDirectory()
Path	getTaskOwnedStateDirectory()
String	toString()

Methods inherited from class org.apache.flink.runtime.state.filesystem.FsCheckpointStreamFactory

canFastDuplicate, createCheckpointStateOutputStream, duplicate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.flink.runtime.state.CheckpointStreamFactory

canFastDuplicate, couldReuseStateHandle, createCheckpointStateOutputStream, duplicate, reusePreviousStateHandle

Constructor Detail

FsCheckpointStorageLocation

public FsCheckpointStorageLocation(FileSystem fileSystem,
                                   Path checkpointDir,
                                   Path sharedStateDir,
                                   Path taskOwnedStateDir,
                                   CheckpointStorageLocationReference reference,
                                   int fileStateSizeThreshold,
                                   int writeBufferSize)

Method Detail

getCheckpointDirectory

public Path getCheckpointDirectory()

getSharedStateDirectory

public Path getSharedStateDirectory()

getTaskOwnedStateDirectory

public Path getTaskOwnedStateDirectory()

getMetadataFilePath

public Path getMetadataFilePath()

createMetadataOutputStream

public CheckpointMetadataOutputStream createMetadataOutputStream()
                                                          throws IOException

Description copied from interface: CheckpointStorageLocation

Creates the output stream to persist the checkpoint metadata to.

Specified by:

createMetadataOutputStream in interface CheckpointStorageLocation

Returns:

The output stream to persist the checkpoint metadata to.

Throws:

IOException - Thrown, if the stream cannot be opened due to an I/O error.

disposeOnFailure

public void disposeOnFailure()
                      throws IOException

Description copied from interface: CheckpointStorageLocation

Disposes the checkpoint location in case the checkpoint has failed. This method disposes all the data at that location, not just the data written by the particular node or process that calls this method.

Specified by:

disposeOnFailure in interface CheckpointStorageLocation

Throws:

IOException

getLocationReference

public CheckpointStorageLocationReference getLocationReference()

Description copied from interface: CheckpointStorageLocation

Gets a reference to the storage location. This reference is sent to the target storage location via checkpoint RPC messages and checkpoint barriers, in a format avoiding backend-specific classes.

If there is no custom location information that needs to be communicated, this method can simply return CheckpointStorageLocationReference.getDefault().

Specified by:

getLocationReference in interface CheckpointStorageLocation

toString

public String toString()

Overrides:

toString in class FsCheckpointStreamFactory