Package org.apache.flink.runtime.executiongraph

Class ArchivedExecutionGraph

java.lang.Object

org.apache.flink.runtime.executiongraph.ArchivedExecutionGraph

All Implemented Interfaces:

Serializable, AccessExecutionGraph, JobStatusProvider

public class ArchivedExecutionGraph
extends Object
implements AccessExecutionGraph, Serializable

An archived execution graph represents a serializable form of an ExecutionGraph.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor

Description

ArchivedExecutionGraph(org.apache.flink.api.common.JobID jobID, String jobName, Map<JobVertexID,ArchivedExecutionJobVertex> tasks, List<ArchivedExecutionJobVertex> verticesInCreationOrder, long[] stateTimestamps, org.apache.flink.api.common.JobStatus state, JobType jobType, ErrorInfo failureCause, JobPlanInfo.Plan plan, StringifiedAccumulatorResult[] archivedUserAccumulators, Map<String,org.apache.flink.util.SerializedValue<org.apache.flink.util.OptionalFailure<Object>>> serializedUserAccumulators, org.apache.flink.api.common.ArchivedExecutionConfig executionConfig, boolean isStoppable, CheckpointCoordinatorConfiguration jobCheckpointingConfiguration, CheckpointStatsSnapshot checkpointStatsSnapshot, String stateBackendName, String checkpointStorageName, org.apache.flink.util.TernaryBoolean stateChangelogEnabled, String changelogStorageName, String streamGraphJson, int pendingOperatorCount)

Method Summary

Modifier and Type	Method	Description
static ArchivedExecutionGraph	createFrom(ExecutionGraph executionGraph)	Create a ArchivedExecutionGraph from the given ExecutionGraph.
static ArchivedExecutionGraph	createFrom(ExecutionGraph executionGraph, org.apache.flink.api.common.JobStatus statusOverride)	Create a ArchivedExecutionGraph from the given ExecutionGraph.
static ArchivedExecutionGraph	createSparseArchivedExecutionGraph(org.apache.flink.api.common.JobID jobId, String jobName, org.apache.flink.api.common.JobStatus jobStatus, JobType jobType, Throwable throwable, JobCheckpointingSettings checkpointingSettings, long initializationTimestamp)	Create a sparse ArchivedExecutionGraph for a job.
static ArchivedExecutionGraph	createSparseArchivedExecutionGraphWithJobVertices(org.apache.flink.api.common.JobID jobId, String jobName, org.apache.flink.api.common.JobStatus jobStatus, JobType jobType, Throwable throwable, JobCheckpointingSettings checkpointingSettings, long initializationTimestamp, Iterable<JobVertex> jobVertices, VertexParallelismStore initialParallelismStore)
StringifiedAccumulatorResult[]	getAccumulatorResultsStringified()	Returns the aggregated user-defined accumulators as strings.
Map<String,org.apache.flink.util.SerializedValue<org.apache.flink.util.OptionalFailure<Object>>>	getAccumulatorsSerialized()	Returns a map containing the serialized values of user-defined accumulators.
Iterable<ArchivedExecutionVertex>	getAllExecutionVertices()	Returns an iterable containing all execution vertices for this execution graph.
Map<JobVertexID,AccessExecutionJobVertex>	getAllVertices()	Returns a map containing all job vertices for this execution graph.
org.apache.flink.api.common.ArchivedExecutionConfig	getArchivedExecutionConfig()	Returns the ArchivedExecutionConfig for this execution graph.
Optional<String>	getChangelogStorageName()	Returns the changelog storage name for this ExecutionGraph.
CheckpointCoordinatorConfiguration	getCheckpointCoordinatorConfiguration()	Returns the CheckpointCoordinatorConfiguration or null if checkpointing is disabled.
CheckpointStatsSnapshot	getCheckpointStatsSnapshot()	Returns a snapshot of the checkpoint statistics or null if checkpointing is disabled.
Optional<String>	getCheckpointStorageName()	Returns the checkpoint storage name for this ExecutionGraph.
ErrorInfo	getFailureInfo()	Returns the exception that caused the job to fail.
org.apache.flink.api.common.JobID	getJobID()	Returns the JobID for this execution graph.
String	getJobName()	Returns the job name for the execution graph.
JobType	getJobType()	Returns the JobType for this execution graph.
ArchivedExecutionJobVertex	getJobVertex(JobVertexID id)	Returns the job vertex for the given JobVertexID.
int	getPendingOperatorCount()	Retrieves the count of pending operators waiting to be transferred to job vertices in the adaptive execution of batch jobs.
JobPlanInfo.Plan	getPlan()	Returns the job plan as a JobPlanInfo.Plan.
org.apache.flink.api.common.JobStatus	getState()	Returns the current JobStatus for this execution graph.
Optional<String>	getStateBackendName()	Returns the state backend name for this ExecutionGraph.
long	getStatusTimestamp(org.apache.flink.api.common.JobStatus status)	Returns the timestamp for the given JobStatus.
String	getStreamGraphJson()	Returns the stream graph as a JSON string.
Iterable<ArchivedExecutionJobVertex>	getVerticesTopologically()	Returns an iterable containing all job vertices for this execution graph in the order they were created.
org.apache.flink.util.TernaryBoolean	isChangelogStateBackendEnabled()	Returns whether the state changelog is enabled for this ExecutionGraph.
boolean	isStoppable()	Returns whether the job for this execution graph is stoppable.

Methods inherited from class java.lang.Object

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

Constructor Detail

ArchivedExecutionGraph

public ArchivedExecutionGraph(org.apache.flink.api.common.JobID jobID,
                              String jobName,
                              Map<JobVertexID,ArchivedExecutionJobVertex> tasks,
                              List<ArchivedExecutionJobVertex> verticesInCreationOrder,
                              long[] stateTimestamps,
                              org.apache.flink.api.common.JobStatus state,
                              @Nullable
                              JobType jobType,
                              @Nullable
                              ErrorInfo failureCause,
                              JobPlanInfo.Plan plan,
                              StringifiedAccumulatorResult[] archivedUserAccumulators,
                              Map<String,org.apache.flink.util.SerializedValue<org.apache.flink.util.OptionalFailure<Object>>> serializedUserAccumulators,
                              org.apache.flink.api.common.ArchivedExecutionConfig executionConfig,
                              boolean isStoppable,
                              @Nullable
                              CheckpointCoordinatorConfiguration jobCheckpointingConfiguration,
                              @Nullable
                              CheckpointStatsSnapshot checkpointStatsSnapshot,
                              @Nullable
                              String stateBackendName,
                              @Nullable
                              String checkpointStorageName,
                              @Nullable
                              org.apache.flink.util.TernaryBoolean stateChangelogEnabled,
                              @Nullable
                              String changelogStorageName,
                              @Nullable
                              String streamGraphJson,
                              int pendingOperatorCount)

Method Detail

getPlan

public JobPlanInfo.Plan getPlan()

Description copied from interface: AccessExecutionGraph

Returns the job plan as a JobPlanInfo.Plan.

Specified by:

getPlan in interface AccessExecutionGraph

Returns:

job plan as a JobPlanInfo.Plan

getStreamGraphJson

public String getStreamGraphJson()

Description copied from interface: AccessExecutionGraph

Returns the stream graph as a JSON string.

Specified by:

getStreamGraphJson in interface AccessExecutionGraph

Returns:

stream graph as a JSON string, or null if the job is submitted with a JobGraph or if it's a streaming job.

getJobID

public org.apache.flink.api.common.JobID getJobID()

Description copied from interface: AccessExecutionGraph

Returns the JobID for this execution graph.

Specified by:

getJobID in interface AccessExecutionGraph

Returns:

job ID for this execution graph

getJobName

public String getJobName()

Description copied from interface: AccessExecutionGraph

Returns the job name for the execution graph.

Specified by:

getJobName in interface AccessExecutionGraph

Returns:

job name for this execution graph

getState

public org.apache.flink.api.common.JobStatus getState()

Description copied from interface: AccessExecutionGraph

Returns the current JobStatus for this execution graph.

Specified by:

getState in interface AccessExecutionGraph

Specified by:

getState in interface JobStatusProvider

Returns:

job status for this execution graph

getJobType

public JobType getJobType()

Description copied from interface: AccessExecutionGraph

Returns the JobType for this execution graph.

Specified by:

getJobType in interface AccessExecutionGraph

Returns:

job type for this execution graph. It may be null when an exception occurs.

getFailureInfo

@Nullable
public ErrorInfo getFailureInfo()

Description copied from interface: AccessExecutionGraph

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

Specified by:

getFailureInfo in interface AccessExecutionGraph

Returns:

failure causing exception, or null

getJobVertex

public ArchivedExecutionJobVertex getJobVertex(JobVertexID id)

Description copied from interface: AccessExecutionGraph

Returns the job vertex for the given JobVertexID.

Specified by:

getJobVertex in interface AccessExecutionGraph

Parameters:

id - id of job vertex to be returned

Returns:

job vertex for the given id, or null

getAllVertices

public Map<JobVertexID,AccessExecutionJobVertex> getAllVertices()

Description copied from interface: AccessExecutionGraph

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

Specified by:

getAllVertices in interface AccessExecutionGraph

Returns:

map containing all job vertices for this execution graph

getVerticesTopologically

public Iterable<ArchivedExecutionJobVertex> getVerticesTopologically()

Description copied from interface: AccessExecutionGraph

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

Specified by:

getVerticesTopologically in interface AccessExecutionGraph

Returns:

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

getAllExecutionVertices

public Iterable<ArchivedExecutionVertex> getAllExecutionVertices()

Description copied from interface: AccessExecutionGraph

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

Specified by:

getAllExecutionVertices in interface AccessExecutionGraph

Returns:

iterable containing all execution vertices for this execution graph

getStatusTimestamp

public long getStatusTimestamp(org.apache.flink.api.common.JobStatus status)

Description copied from interface: AccessExecutionGraph

Returns the timestamp for the given JobStatus.

Specified by:

getStatusTimestamp in interface AccessExecutionGraph

Specified by:

getStatusTimestamp in interface JobStatusProvider

Parameters:

status - status for which the timestamp should be returned

Returns:

timestamp for the given job status

getCheckpointCoordinatorConfiguration

public CheckpointCoordinatorConfiguration getCheckpointCoordinatorConfiguration()

Description copied from interface: AccessExecutionGraph

Returns the CheckpointCoordinatorConfiguration or null if checkpointing is disabled.

Specified by:

getCheckpointCoordinatorConfiguration in interface AccessExecutionGraph

Returns:

JobCheckpointingConfiguration for this execution graph

getCheckpointStatsSnapshot

public CheckpointStatsSnapshot getCheckpointStatsSnapshot()

Description copied from interface: AccessExecutionGraph

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

Specified by:

getCheckpointStatsSnapshot in interface AccessExecutionGraph

Returns:

Snapshot of the checkpoint statistics for this execution graph

getArchivedExecutionConfig

public org.apache.flink.api.common.ArchivedExecutionConfig getArchivedExecutionConfig()

Description copied from interface: AccessExecutionGraph

Returns the ArchivedExecutionConfig for this execution graph.

Specified by:

getArchivedExecutionConfig in interface AccessExecutionGraph

Returns:

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

isStoppable

public boolean isStoppable()

Description copied from interface: AccessExecutionGraph

Returns whether the job for this execution graph is stoppable.

Specified by:

isStoppable in interface AccessExecutionGraph

Returns:

true, if all sources tasks are stoppable, false otherwise

getAccumulatorResultsStringified

public StringifiedAccumulatorResult[] getAccumulatorResultsStringified()

Description copied from interface: AccessExecutionGraph

Returns the aggregated user-defined accumulators as strings.

Specified by:

getAccumulatorResultsStringified in interface AccessExecutionGraph

Returns:

aggregated user-defined accumulators as strings.

getAccumulatorsSerialized

public Map<String,org.apache.flink.util.SerializedValue<org.apache.flink.util.OptionalFailure<Object>>> getAccumulatorsSerialized()

Description copied from interface: AccessExecutionGraph

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

Specified by:

getAccumulatorsSerialized in interface AccessExecutionGraph

Returns:

map containing serialized values of user-defined accumulators

getStateBackendName

public Optional<String> getStateBackendName()

Description copied from interface: AccessExecutionGraph

Returns the state backend name for this ExecutionGraph.

Specified by:

getStateBackendName in interface AccessExecutionGraph

Returns:

The state backend name, or an empty Optional in the case of batch jobs

getCheckpointStorageName

public Optional<String> getCheckpointStorageName()

Description copied from interface: AccessExecutionGraph

Returns the checkpoint storage name for this ExecutionGraph.

Specified by:

getCheckpointStorageName in interface AccessExecutionGraph

Returns:

The checkpoint storage name, or an empty Optional in the case of batch jobs

isChangelogStateBackendEnabled

public org.apache.flink.util.TernaryBoolean isChangelogStateBackendEnabled()

Description copied from interface: AccessExecutionGraph

Returns whether the state changelog is enabled for this ExecutionGraph.

Specified by:

isChangelogStateBackendEnabled in interface AccessExecutionGraph

Returns:

true, if state changelog enabled, false otherwise.

getChangelogStorageName

public Optional<String> getChangelogStorageName()

Description copied from interface: AccessExecutionGraph

Returns the changelog storage name for this ExecutionGraph.

Specified by:

getChangelogStorageName in interface AccessExecutionGraph

Returns:

The changelog storage name, or an empty Optional in the case of batch jobs

getPendingOperatorCount

public int getPendingOperatorCount()

Description copied from interface: AccessExecutionGraph

Retrieves the count of pending operators waiting to be transferred to job vertices in the adaptive execution of batch jobs. This value will be zero if the job is submitted with a JobGraph or if it's a streaming job.

Specified by:

getPendingOperatorCount in interface AccessExecutionGraph

Returns:

the number of pending operators.

createFrom

public static ArchivedExecutionGraph createFrom(ExecutionGraph executionGraph)

Create a ArchivedExecutionGraph from the given ExecutionGraph.

Parameters:

executionGraph - to create the ArchivedExecutionGraph from

Returns:

ArchivedExecutionGraph created from the given ExecutionGraph

createFrom

public static ArchivedExecutionGraph createFrom(ExecutionGraph executionGraph,
                                                @Nullable
                                                org.apache.flink.api.common.JobStatus statusOverride)

Create a ArchivedExecutionGraph from the given ExecutionGraph.

Parameters:

executionGraph - to create the ArchivedExecutionGraph from

statusOverride - optionally overrides the JobStatus of the ExecutionGraph with a non-globally-terminal state and clears timestamps of globally-terminal states

Returns:

ArchivedExecutionGraph created from the given ExecutionGraph

createSparseArchivedExecutionGraph

public static ArchivedExecutionGraph createSparseArchivedExecutionGraph(org.apache.flink.api.common.JobID jobId,
                                                                        String jobName,
                                                                        org.apache.flink.api.common.JobStatus jobStatus,
                                                                        @Nullable
                                                                        JobType jobType,
                                                                        @Nullable
                                                                        Throwable throwable,
                                                                        @Nullable
                                                                        JobCheckpointingSettings checkpointingSettings,
                                                                        long initializationTimestamp)

Create a sparse ArchivedExecutionGraph for a job. Most fields will be empty, only job status and error-related fields are set.

createSparseArchivedExecutionGraphWithJobVertices

public static ArchivedExecutionGraph createSparseArchivedExecutionGraphWithJobVertices(org.apache.flink.api.common.JobID jobId,
                                                                                       String jobName,
                                                                                       org.apache.flink.api.common.JobStatus jobStatus,
                                                                                       JobType jobType,
                                                                                       @Nullable
                                                                                       Throwable throwable,
                                                                                       @Nullable
                                                                                       JobCheckpointingSettings checkpointingSettings,
                                                                                       long initializationTimestamp,
                                                                                       Iterable<JobVertex> jobVertices,
                                                                                       VertexParallelismStore initialParallelismStore)