org.apache.flink.runtime.executiongraph

Interface AccessExecutionGraph

All Known Implementing Classes:

ArchivedExecutionGraph, ExecutionGraph

public interface AccessExecutionGraph

Common interface for the runtime ExecutionGraph and ArchivedExecutionGraph.

Method Summary

Methods

Modifier and Type	Method and Description
StringifiedAccumulatorResult[]	getAccumulatorResultsStringified() Returns the aggregated user-defined accumulators as strings.
Map<String,SerializedValue<Object>>	getAccumulatorsSerialized() Returns a map containing the serialized values of user-defined accumulators.
Iterable<? extends AccessExecutionVertex>	getAllExecutionVertices() Returns an iterable containing all execution vertices for this execution graph.
Map<JobVertexID,? extends AccessExecutionJobVertex>	getAllVertices() Returns a map containing all job vertices for this execution graph.
ArchivedExecutionConfig	getArchivedExecutionConfig() Returns the ArchivedExecutionConfig for this execution graph.
CheckpointCoordinator	getCheckpointCoordinator() Returns the CheckpointCoordinator for this execution graph.
CheckpointStatsSnapshot	getCheckpointStatsSnapshot() Returns a snapshot of the checkpoint statistics or null if checkpointing is disabled.
String	getFailureCauseAsString() Returns the exception that caused the job to fail.
JobCheckpointingSettings	getJobCheckpointingSettings() Returns the JobCheckpointingSettings or null if checkpointing is disabled.
JobID	getJobID() Returns the JobID for this execution graph.
String	getJobName() Returns the job name for thie execution graph.
AccessExecutionJobVertex	getJobVertex(JobVertexID id) Returns the job vertex for the given JobVertexID.
String	getJsonPlan() Returns the job plan as a JSON string.
JobStatus	getState() Returns the current JobStatus for this execution graph.
long	getStatusTimestamp(JobStatus status) Returns the timestamp for the given JobStatus
Iterable<? extends AccessExecutionJobVertex>	getVerticesTopologically() Returns an iterable containing all job vertices for this execution graph in the order they were created.
boolean	isArchived() Returns whether this execution graph was archived.
boolean	isStoppable() Returns whether the job for this execution graph is stoppable.

Method Detail

getJsonPlan

String getJsonPlan()

Returns the job plan as a JSON string.

Returns:

job plan as a JSON string

getJobID

JobID getJobID()

Returns the JobID for this execution graph.

Returns:

job ID for this execution graph

getJobName

String getJobName()

Returns the job name for thie execution graph.

Returns:

job name for this execution graph

getState

JobStatus getState()

Returns the current JobStatus for this execution graph.

Returns:

job status for this execution graph

getFailureCauseAsString

String getFailureCauseAsString()

Returns the exception that caused the job to fail. This is the first root exception that was not recoverable and triggered job failure.

Returns:

failure causing exception as a string, or "(null)"

getJobVertex

AccessExecutionJobVertex getJobVertex(JobVertexID id)

Returns the job vertex for the given JobVertexID.

Parameters:

id - id of job vertex to be returned

Returns:

job vertex for the given id, or null

getAllVertices

Map<JobVertexID,? extends AccessExecutionJobVertex> getAllVertices()

Returns a map containing all job vertices for this execution graph.

Returns:

map containing all job vertices for this execution graph

getVerticesTopologically

Iterable<? extends AccessExecutionJobVertex> getVerticesTopologically()

Returns an iterable containing all job vertices for this execution graph in the order they were created.

Returns:

iterable containing all job vertices for this execution graph in the order they were creater

getAllExecutionVertices

Iterable<? extends AccessExecutionVertex> getAllExecutionVertices()

Returns an iterable containing all execution vertices for this execution graph.

Returns:

iterable containing all execution vertices for this execution graph

getStatusTimestamp

long getStatusTimestamp(JobStatus status)

Returns the timestamp for the given JobStatus

Parameters:

status - status for which the timestamp should be returned

Returns:

timestamp for the given job status

getCheckpointCoordinator

CheckpointCoordinator getCheckpointCoordinator()

Returns the CheckpointCoordinator for this execution graph.

Returns:

CheckpointCoordinator for this execution graph or null if none is available.

getJobCheckpointingSettings

JobCheckpointingSettings getJobCheckpointingSettings()

Returns the JobCheckpointingSettings or null if checkpointing is disabled.

Returns:

JobSnapshottingSettings for this execution graph

getCheckpointStatsSnapshot

CheckpointStatsSnapshot getCheckpointStatsSnapshot()

Returns a snapshot of the checkpoint statistics or null if checkpointing is disabled.

Returns:

Snapshot of the checkpoint statistics for this execution graph

getArchivedExecutionConfig

ArchivedExecutionConfig getArchivedExecutionConfig()

Returns the ArchivedExecutionConfig for this execution graph.

Returns:

execution config summary for this execution graph, or null in case of errors

isStoppable

boolean isStoppable()

Returns whether the job for this execution graph is stoppable.

Returns:

true, if all sources tasks are stoppable, false otherwise

getAccumulatorResultsStringified

StringifiedAccumulatorResult[] getAccumulatorResultsStringified()

Returns the aggregated user-defined accumulators as strings.

Returns:

aggregated user-defined accumulators as strings.

getAccumulatorsSerialized

Map<String,SerializedValue<Object>> getAccumulatorsSerialized()
                                                              throws IOException

Returns a map containing the serialized values of user-defined accumulators.

Returns:

map containing serialized values of user-defined accumulators

Throws:

IOException - indicates that the serialization has failed

isArchived

boolean isArchived()

Returns whether this execution graph was archived.

Returns:

true, if the execution graph was archived, false otherwise