AccessExecutionGraph (Flink : 1.16-SNAPSHOT API)

All Superinterfaces:

JobStatusProvider

All Known Subinterfaces:

ExecutionGraph

All Known Implementing Classes:

ArchivedExecutionGraph, DefaultExecutionGraph
```
public interface AccessExecutionGraph
extends JobStatusProvider
```
Common interface for the runtime DefaultExecutionGraph and ArchivedExecutionGraph.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`StringifiedAccumulatorResult[]`	`getAccumulatorResultsStringified()` Returns the aggregated user-defined accumulators as strings.
`Map<String,SerializedValue<OptionalFailure<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.
`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.
`JobID`	`getJobID()` Returns the `JobID` for this execution graph.
`String`	`getJobName()` Returns the job name for the 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.
`Optional<String>`	`getStateBackendName()` Returns the state backend name for this ExecutionGraph.
`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.
`TernaryBoolean`	`isChangelogStateBackendEnabled()` Returns whether the state changelog is enabled for this ExecutionGraph.
`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 the execution graph.
    
    Returns:
    
    job name for this execution graph
  - getState
```
JobStatus getState()
```
    Returns the current JobStatus for this execution graph.
    
    Specified by:
    
    getState in interface JobStatusProvider
    
    Returns:
    
    job status for this execution graph
  - getFailureInfo
```
@Nullable
ErrorInfo getFailureInfo()
```
    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, or null
  - getJobVertex
```
@Nullable
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 created
  - 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.
    
    Specified by:
    
    getStatusTimestamp in interface JobStatusProvider
    
    Parameters:
    
    status - status for which the timestamp should be returned
    
    Returns:
    
    timestamp for the given job status
  - getCheckpointCoordinatorConfiguration
```
@Nullable
CheckpointCoordinatorConfiguration getCheckpointCoordinatorConfiguration()
```
    Returns the CheckpointCoordinatorConfiguration or null if checkpointing is disabled.
    
    Returns:
    
    JobCheckpointingConfiguration for this execution graph
  - getCheckpointStatsSnapshot
```
@Nullable
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
```
@Nullable
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<OptionalFailure<Object>>> getAccumulatorsSerialized()
```
    Returns a map containing the serialized values of user-defined accumulators.
    
    Returns:
    
    map containing serialized values of user-defined accumulators
  - getStateBackendName
```
Optional<String> getStateBackendName()
```
    Returns the state backend name for this ExecutionGraph.
    
    Returns:
    
    The state backend name, or an empty Optional in the case of batch jobs
  - getCheckpointStorageName
```
Optional<String> getCheckpointStorageName()
```
    Returns the checkpoint storage name for this ExecutionGraph.
    
    Returns:
    
    The checkpoint storage name, or an empty Optional in the case of batch jobs
  - isChangelogStateBackendEnabled
```
TernaryBoolean isChangelogStateBackendEnabled()
```
    Returns whether the state changelog is enabled for this ExecutionGraph.
    
    Returns:
    
    true, if state changelog enabled, false otherwise.
  - getChangelogStorageName
```
Optional<String> getChangelogStorageName()
```
    Returns the changelog storage name for this ExecutionGraph.
    
    Returns:
    
    The changelog storage name, or an empty Optional in the case of batch jobs

Back to Flink Website

Interface AccessExecutionGraph

Method Summary

Method Detail

getJsonPlan

getJobID

getJobName

getState

getFailureInfo

getJobVertex

getAllVertices

getVerticesTopologically

getAllExecutionVertices

getStatusTimestamp

getCheckpointCoordinatorConfiguration

getCheckpointStatsSnapshot

getArchivedExecutionConfig

isStoppable

getAccumulatorResultsStringified

getAccumulatorsSerialized

getStateBackendName

getCheckpointStorageName

isChangelogStateBackendEnabled

getChangelogStorageName

Back to Flink Website