ExecutionVertex (Flink : Runtime 1.20.1 API)

java.lang.Object
- org.apache.flink.runtime.executiongraph.ExecutionVertex

All Implemented Interfaces:

org.apache.flink.api.common.Archiveable<ArchivedExecutionVertex>, AccessExecutionVertex

Direct Known Subclasses:

SpeculativeExecutionVertex
```
public class ExecutionVertex
extends Object
implements AccessExecutionVertex, org.apache.flink.api.common.Archiveable<ArchivedExecutionVertex>
```
The ExecutionVertex is a parallel subtask of the execution. It may be executed once, or several times, each of which time it spawns an Execution.

Field Summary

Fields
Modifier and Type Field and Description

static long NUM_BYTES_UNKNOWN

Fields
Modifier and Type	Field and Description
`static long`	`NUM_BYTES_UNKNOWN`

Constructor Summary

Constructors
Constructor and Description
`ExecutionVertex(ExecutionJobVertex jobVertex, int subTaskIndex, IntermediateResult[] producedDataSets, org.apache.flink.api.common.time.Time timeout, long createTimestamp, int executionHistorySizeLimit, int initialAttemptCount)` Creates an ExecutionVertex.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addConsumedPartitionGroup(ConsumedPartitionGroup consumedPartitions)`
`ArchivedExecutionVertex`	`archive()`
`CompletableFuture<?>`	`cancel()` Cancels this ExecutionVertex.
`void`	`deploy()`
`void`	`deployToSlot(LogicalSlot slot)`
`void`	`fail(Throwable t)`
`Optional<AllocationID>`	`findLastAllocation()`
`Optional<TaskManagerLocation>`	`findLastLocation()` Gets the location that an execution of this vertex was assigned to.
`List<IntermediateResultPartition>`	`finishPartitionsIfNeeded()` Mark partition finished if needed.
`List<ConsumedPartitionGroup>`	`getAllConsumedPartitionGroups()`
`ConsumedPartitionGroup`	`getConsumedPartitionGroup(int input)`
`LogicalSlot`	`getCurrentAssignedResource()`
`TaskManagerLocation`	`getCurrentAssignedResourceLocation()` Returns the `TaskManagerLocation` for this execution vertex.
`Execution`	`getCurrentExecution(int attemptNumber)`
`Execution`	`getCurrentExecutionAttempt()` Returns the current execution for this execution vertex.
`Collection<Execution>`	`getCurrentExecutions()` Returns the current executions for this execution vertex.
`CompletableFuture<TaskManagerLocation>`	`getCurrentTaskManagerLocationFuture()`
`InternalExecutionGraphAccessor`	`getExecutionGraphAccessor()`
`ExecutionHistory`	`getExecutionHistory()` Returns the execution history.
`ExecutionState`	`getExecutionState()` Returns the current `ExecutionState` for this execution vertex.
`ExecutionVertexInputInfo`	`getExecutionVertexInputInfo(IntermediateDataSetID resultId)`
`Optional<ErrorInfo>`	`getFailureInfo()` Returns the exception that caused the job to fail.
`ExecutionVertexID`	`getID()`
`long`	`getInputBytes()`
`org.apache.flink.api.common.JobID`	`getJobId()`
`ExecutionJobVertex`	`getJobVertex()`
`JobVertexID`	`getJobvertexId()`
`int`	`getMaxParallelism()`
`Optional<org.apache.flink.core.io.InputSplit>`	`getNextInputSplit(String host, int attemptNumber)`
`int`	`getNumberOfInputs()`
`int`	`getParallelSubtaskIndex()` Returns the subtask index of this execution vertex.
`Execution`	`getPartitionProducer()`
`Optional<TaskManagerLocation>`	`getPreferredLocationBasedOnState()` Gets the preferred location to execute the current task execution attempt, based on the state that the execution attempt will resume.
`Map<IntermediateResultPartitionID,IntermediateResultPartition>`	`getProducedPartitions()`
`ResourceProfile`	`getResourceProfile()`
`long`	`getStateTimestamp(ExecutionState state)` Returns the timestamp for the given `ExecutionState`.
`String`	`getTaskName()`
`String`	`getTaskNameWithSubtaskIndex()` Creates a simple name representation in the style 'taskname (x/y)', where 'taskname' is the name as returned by `getTaskName()`, 'x' is the parallel subtask index as returned by `getParallelSubtaskIndex()+ 1`, and 'y' is the total number of tasks, as returned by `getTotalNumberOfParallelSubtasks()`.
`int`	`getTotalNumberOfParallelSubtasks()`
`void`	`markFailed(Throwable t)` This method marks the task as failed, but will make no attempt to remove task execution from the task manager.
`void`	`resetForNewExecution()` Archives the current Execution and creates a new Execution for this vertex.
`void`	`setInputBytes(long inputBytes)`
`CompletableFuture<?>`	`suspend()`
`String`	`toString()`
`void`	`tryAssignResource(LogicalSlot slot)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - NUM_BYTES_UNKNOWN
```
public static final long NUM_BYTES_UNKNOWN
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ExecutionVertex
```
@VisibleForTesting
public ExecutionVertex(ExecutionJobVertex jobVertex,
                                          int subTaskIndex,
                                          IntermediateResult[] producedDataSets,
                                          org.apache.flink.api.common.time.Time timeout,
                                          long createTimestamp,
                                          int executionHistorySizeLimit,
                                          int initialAttemptCount)
```
    Creates an ExecutionVertex.
    
    Parameters:
    
    timeout - The RPC timeout to use for deploy / cancel calls
    
    createTimestamp - The timestamp for the vertex creation, used to initialize the first Execution with.
    
    executionHistorySizeLimit - The maximum number of historical Executions (= execution attempts) to keep.
    
    initialAttemptCount - The attempt number of the first execution of this vertex.
- Method Detail
  - getExecutionVertexInputInfo
```
public ExecutionVertexInputInfo getExecutionVertexInputInfo(IntermediateDataSetID resultId)
```
  - setInputBytes
```
public void setInputBytes(long inputBytes)
```
  - getInputBytes
```
public long getInputBytes()
```
  - getPartitionProducer
```
public Execution getPartitionProducer()
```
  - getJobId
```
public org.apache.flink.api.common.JobID getJobId()
```
  - getJobVertex
```
public ExecutionJobVertex getJobVertex()
```
  - getJobvertexId
```
public JobVertexID getJobvertexId()
```
  - getTaskName
```
public String getTaskName()
```
  - getTaskNameWithSubtaskIndex
```
public String getTaskNameWithSubtaskIndex()
```
    Creates a simple name representation in the style 'taskname (x/y)', where 'taskname' is the name as returned by getTaskName(), 'x' is the parallel subtask index as returned by getParallelSubtaskIndex()+ 1, and 'y' is the total number of tasks, as returned by getTotalNumberOfParallelSubtasks().
    
    Specified by:
    
    getTaskNameWithSubtaskIndex in interface AccessExecutionVertex
    
    Returns:
    
    A simple name representation in the form 'myTask (2/7)'
  - getTotalNumberOfParallelSubtasks
```
public int getTotalNumberOfParallelSubtasks()
```
  - getMaxParallelism
```
public int getMaxParallelism()
```
  - getResourceProfile
```
public ResourceProfile getResourceProfile()
```
  - getParallelSubtaskIndex
```
public int getParallelSubtaskIndex()
```
    Description copied from interface: AccessExecutionVertex
    
    Returns the subtask index of this execution vertex.
    
    Specified by:
    
    getParallelSubtaskIndex in interface AccessExecutionVertex
    
    Returns:
    
    subtask index of this execution vertex.
  - getID
```
public ExecutionVertexID getID()
```
  - getNumberOfInputs
```
public int getNumberOfInputs()
```
  - getAllConsumedPartitionGroups
```
public List<ConsumedPartitionGroup> getAllConsumedPartitionGroups()
```
  - getConsumedPartitionGroup
```
public ConsumedPartitionGroup getConsumedPartitionGroup(int input)
```
  - getNextInputSplit
```
public Optional<org.apache.flink.core.io.InputSplit> getNextInputSplit(String host,
                                                                       int attemptNumber)
```
  - getCurrentExecutionAttempt
```
public Execution getCurrentExecutionAttempt()
```
    Description copied from interface: AccessExecutionVertex
    
    Returns the current execution for this execution vertex.
    
    Specified by:
    
    getCurrentExecutionAttempt in interface AccessExecutionVertex
    
    Returns:
    
    current execution
  - getCurrentExecutions
```
public Collection<Execution> getCurrentExecutions()
```
    Description copied from interface: AccessExecutionVertex
    
    Returns the current executions for this execution vertex. The returned collection must contain the current execution attempt.
    
    Specified by:
    
    getCurrentExecutions in interface AccessExecutionVertex
    
    Returns:
    
    current executions
  - getCurrentExecution
```
public Execution getCurrentExecution(int attemptNumber)
```
  - getExecutionState
```
public ExecutionState getExecutionState()
```
    Description copied from interface: AccessExecutionVertex
    
    Returns the current ExecutionState for this execution vertex.
    
    Specified by:
    
    getExecutionState in interface AccessExecutionVertex
    
    Returns:
    
    execution state for this execution vertex
  - getStateTimestamp
```
public long getStateTimestamp(ExecutionState state)
```
    Description copied from interface: AccessExecutionVertex
    
    Returns the timestamp for the given ExecutionState.
    
    Specified by:
    
    getStateTimestamp in interface AccessExecutionVertex
    
    Parameters:
    
    state - state for which the timestamp should be returned
    
    Returns:
    
    timestamp for the given state
  - getFailureInfo
```
public Optional<ErrorInfo> getFailureInfo()
```
    Description copied from interface: AccessExecutionVertex
    
    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 AccessExecutionVertex
    
    Returns:
    
    failure exception wrapped in an Optional of ErrorInfo, or an empty Optional if no exception was caught.
  - getCurrentTaskManagerLocationFuture
```
public CompletableFuture<TaskManagerLocation> getCurrentTaskManagerLocationFuture()
```
  - getCurrentAssignedResource
```
public LogicalSlot getCurrentAssignedResource()
```
  - getCurrentAssignedResourceLocation
```
public TaskManagerLocation getCurrentAssignedResourceLocation()
```
    Description copied from interface: AccessExecutionVertex
    
    Returns the TaskManagerLocation for this execution vertex.
    
    Specified by:
    
    getCurrentAssignedResourceLocation in interface AccessExecutionVertex
    
    Returns:
    
    taskmanager location for this execution vertex.
  - getExecutionHistory
```
public ExecutionHistory getExecutionHistory()
```
    Description copied from interface: AccessExecutionVertex
    
    Returns the execution history.
    
    Specified by:
    
    getExecutionHistory in interface AccessExecutionVertex
    
    Returns:
    
    the execution history
  - findLastLocation
```
public Optional<TaskManagerLocation> findLastLocation()
```
    Gets the location that an execution of this vertex was assigned to.
    
    Returns:
    
    The last execution location, or null, if there is none, yet.
  - findLastAllocation
```
public Optional<AllocationID> findLastAllocation()
```
  - getExecutionGraphAccessor
```
public final InternalExecutionGraphAccessor getExecutionGraphAccessor()
```
  - getProducedPartitions
```
public Map<IntermediateResultPartitionID,IntermediateResultPartition> getProducedPartitions()
```
  - addConsumedPartitionGroup
```
public void addConsumedPartitionGroup(ConsumedPartitionGroup consumedPartitions)
```
  - getPreferredLocationBasedOnState
```
public Optional<TaskManagerLocation> getPreferredLocationBasedOnState()
```
    Gets the preferred location to execute the current task execution attempt, based on the state that the execution attempt will resume.
  - resetForNewExecution
```
public void resetForNewExecution()
```
    Archives the current Execution and creates a new Execution for this vertex.
  - tryAssignResource
```
public void tryAssignResource(LogicalSlot slot)
```
  - deploy
```
public void deploy()
            throws JobException
```
    Throws:
    
    JobException
  - deployToSlot
```
@VisibleForTesting
public void deployToSlot(LogicalSlot slot)
                                     throws JobException
```
    Throws:
    
    JobException
  - cancel
```
public CompletableFuture<?> cancel()
```
    Cancels this ExecutionVertex.
    
    Returns:
    
    A future that completes once the execution has reached its final state.
  - suspend
```
public CompletableFuture<?> suspend()
```
  - fail
```
public void fail(Throwable t)
```
  - markFailed
```
public void markFailed(Throwable t)
```
    This method marks the task as failed, but will make no attempt to remove task execution from the task manager. It is intended for cases where the task is known not to be deployed yet.
    
    Parameters:
    
    t - The exception that caused the task to fail.
  - finishPartitionsIfNeeded
```
@VisibleForTesting
public List<IntermediateResultPartition> finishPartitionsIfNeeded()
```
    Mark partition finished if needed.
    
    Returns:
    
    list of finished partitions.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - archive
```
public ArchivedExecutionVertex archive()
```
    Specified by:
    
    archive in interface org.apache.flink.api.common.Archiveable<ArchivedExecutionVertex>

Class ExecutionVertex

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NUM_BYTES_UNKNOWN

Constructor Detail

ExecutionVertex

Method Detail

getExecutionVertexInputInfo

setInputBytes

getInputBytes

getPartitionProducer

getJobId

getJobVertex

getJobvertexId

getTaskName

getTaskNameWithSubtaskIndex

getTotalNumberOfParallelSubtasks

getMaxParallelism

getResourceProfile

getParallelSubtaskIndex

getID

getNumberOfInputs

getAllConsumedPartitionGroups

getConsumedPartitionGroup

getNextInputSplit

getCurrentExecutionAttempt

getCurrentExecutions

getCurrentExecution

getExecutionState

getStateTimestamp

getFailureInfo

getCurrentTaskManagerLocationFuture

getCurrentAssignedResource

getCurrentAssignedResourceLocation

getExecutionHistory

findLastLocation

findLastAllocation

getExecutionGraphAccessor

getProducedPartitions

addConsumedPartitionGroup

getPreferredLocationBasedOnState

resetForNewExecution

tryAssignResource

deploy

deployToSlot

cancel

suspend

fail

markFailed

finishPartitionsIfNeeded

toString

archive