org.apache.flink.runtime.history

Class FsJobArchivist

java.lang.Object

org.apache.flink.runtime.history.FsJobArchivist

public class FsJobArchivist
extends Object

Utility class for writing an archive file to a FileSystem and reading it back.

Method Summary

Modifier and Type	Method and Description
static Path	archiveJob(Path rootPath, AccessExecutionGraph graph) Deprecated. only kept for legacy reasons
static Path	archiveJob(Path rootPath, JobID jobId, Collection<ArchivedJson> jsonToArchive) Writes the given AccessExecutionGraph to the FileSystem pointed to by JobManagerOptions.ARCHIVE_DIR.
static Collection<ArchivedJson>	getArchivedJsons(Path file) Reads the given archive file and returns a Collection of contained ArchivedJson.

Methods inherited from class java.lang.Object

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

Method Detail

archiveJob

@Deprecated
public static Path archiveJob(Path rootPath,
                                          AccessExecutionGraph graph)
                                   throws IOException

Deprecated. only kept for legacy reasons

Writes the given AccessExecutionGraph to the FileSystem pointed to by JobManagerOptions.ARCHIVE_DIR.

Parameters:

rootPath - directory to which the archive should be written to

graph - graph to archive

Returns:

path to where the archive was written, or null if no archive was created

Throws:

IOException

archiveJob

public static Path archiveJob(Path rootPath,
                              JobID jobId,
                              Collection<ArchivedJson> jsonToArchive)
                       throws IOException

Writes the given AccessExecutionGraph to the FileSystem pointed to by JobManagerOptions.ARCHIVE_DIR.

Parameters:

rootPath - directory to which the archive should be written to

jobId - job id

jsonToArchive - collection of json-path pairs to that should be archived

Returns:

path to where the archive was written, or null if no archive was created

Throws:

IOException

getArchivedJsons

public static Collection<ArchivedJson> getArchivedJsons(Path file)
                                                 throws IOException

Reads the given archive file and returns a Collection of contained ArchivedJson.

Parameters:

file - archive to extract

Returns:

collection of archived jsons

Throws:

IOException - if the file can't be opened, read or doesn't contain valid json