org.apache.flink.runtime.executiongraph

Class ExecutionVertex

java.lang.Object

org.apache.flink.runtime.executiongraph.ExecutionVertex

public final class ExecutionVertex
extends Object

An execution vertex represents an instance of a task in a Nephele job. An execution vertex is initially created from a job vertex and always belongs to exactly one group vertex. It is possible to duplicate execution vertices in order to distribute a task to several different task managers and process the task in parallel.

This class is thread-safe.

Constructor Summary

Constructors

Constructor and Description
ExecutionVertex(ExecutionGraph executionGraph, ExecutionGroupVertex groupVertex, int numberOfOutputGates, int numberOfInputGates) Create a new execution vertex and instantiates its environment.

Method Summary

Methods

Modifier and Type	Method and Description
TaskCancelResult	cancelTask() Cancels and removes the task represented by this vertex from the instance it is currently running on.
boolean	compareAndUpdateExecutionState(ExecutionState expected, ExecutionState update)
TaskDeploymentDescriptor	constructDeploymentDescriptor() Constructs a new task deployment descriptor for this vertex.
boolean	decrementRetriesLeftAndCheck() Decrements the number of retries left and checks whether another attempt to run the task is possible.
ExecutionVertex	duplicateVertex(boolean preserveVertexID) Returns a duplicate of this execution vertex.
AllocatedResource	getAllocatedResource() Returns the allocated resources assigned to this execution vertex.
AllocationID	getAllocationID() Returns the allocation ID which identifies the resources used by this vertex within the assigned instance.
ExecutionGraph	getExecutionGraph() Returns the ExecutionGraph this vertex belongs to.
ExecutionPipeline	getExecutionPipeline() Returns the ExecutionPipeline this vertex is part of.
ExecutionState	getExecutionState() Returns this execution vertex's current execution status.
ExecutionGroupVertex	getGroupVertex() Returns the group vertex this execution vertex belongs to.
ExecutionVertexID	getID() Returns the ID of this execution vertex.
int	getIndexInVertexGroup() Returns the index of this vertex in the vertex group.
ExecutionGate	getInputGate(int index) Returns the input gate with the given index.
String	getName() Returns the name of the execution vertex.
int	getNumberOfInputGates() Returns the number of input gates attached to this vertex.
int	getNumberOfOutputGates() Returns the number of output gates attached to this vertex.
int	getNumberOfPredecessors() Returns the number of predecessors, i.e.
int	getNumberOfSuccessors() Returns the number of successors, i.e.
ExecutionGate	getOutputGate(int index) Returns the output gate with the given index.
ExecutionVertex	getPredecessor(int index)
ExecutionVertex	getSuccessor(int index)
boolean	hasRetriesLeft() Deprecated.
boolean	isInputVertex() Checks if this vertex is an input vertex in its stage, i.e.
boolean	isOutputVertex() Checks if this vertex is an output vertex in its stage, i.e.
TaskKillResult	killTask() Kills and removes the task represented by this vertex from the instance it is currently running on.
void	registerExecutionListener(ExecutionListener executionListener) Registers the ExecutionListener object for this vertex.
void	registerVertexAssignmentListener(VertexAssignmentListener vertexAssignmentListener) Registers the VertexAssignmentListener object for this vertex.
void	setAllocatedResource(AllocatedResource allocatedResource) Assigns the execution vertex with an AllocatedResource.
ExecutionVertex	splitVertex() Returns a duplicate of this execution vertex.
TaskSubmissionResult	startTask() Deploys and starts the task represented by this vertex on the assigned instance.
String	toString()
void	unregisterExecutionListener(ExecutionListener executionListener) Unregisters the ExecutionListener object for this vertex.
void	unregisterVertexAssignmentListener(VertexAssignmentListener vertexAssignmentListener) Unregisters the VertexAssignmentListener object for this vertex.
ExecutionState	updateExecutionState(ExecutionState newExecutionState) Updates the vertex's current execution state.
ExecutionState	updateExecutionState(ExecutionState newExecutionState, String optionalMessage) Updates the vertex's current execution state.
void	updateExecutionStateAsynchronously(ExecutionState newExecutionState) Updates the vertex's current execution state through the job's executor service.
void	updateExecutionStateAsynchronously(ExecutionState newExecutionState, String optionalMessage) Updates the vertex's current execution state through the job's executor service.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExecutionVertex

public ExecutionVertex(ExecutionGraph executionGraph,
               ExecutionGroupVertex groupVertex,
               int numberOfOutputGates,
               int numberOfInputGates)

Create a new execution vertex and instantiates its environment.

Parameters:

executionGraph - the execution graph the new vertex belongs to

groupVertex - the group vertex the new vertex belongs to

numberOfOutputGates - the number of output gates attached to this vertex

numberOfInputGates - the number of input gates attached to this vertex

Method Detail

getGroupVertex

public ExecutionGroupVertex getGroupVertex()

Returns the group vertex this execution vertex belongs to.

Returns:

the group vertex this execution vertex belongs to

getName

public String getName()

Returns the name of the execution vertex.

Returns:

the name of the execution vertex

duplicateVertex

public ExecutionVertex duplicateVertex(boolean preserveVertexID)

Returns a duplicate of this execution vertex.

Parameters:

preserveVertexID - true to copy the vertex's ID to the duplicated vertex, false to create a new ID

Returns:

a duplicate of this execution vertex

splitVertex

public ExecutionVertex splitVertex()

Returns a duplicate of this execution vertex. The duplicated vertex receives a new vertex ID.

Returns:

a duplicate of this execution vertex.

getExecutionState

public ExecutionState getExecutionState()

Returns this execution vertex's current execution status.

Returns:

this execution vertex's current execution status

updateExecutionStateAsynchronously

public void updateExecutionStateAsynchronously(ExecutionState newExecutionState,
                                      String optionalMessage)

Updates the vertex's current execution state through the job's executor service.

Parameters:

newExecutionState - the new execution state

optionalMessage - an optional message related to the state change

updateExecutionStateAsynchronously

public void updateExecutionStateAsynchronously(ExecutionState newExecutionState)

Updates the vertex's current execution state through the job's executor service.

Parameters:

newExecutionState - the new execution state

updateExecutionState

public ExecutionState updateExecutionState(ExecutionState newExecutionState)

Updates the vertex's current execution state.

Parameters:

newExecutionState - the new execution state

updateExecutionState

public ExecutionState updateExecutionState(ExecutionState newExecutionState,
                                  String optionalMessage)

Updates the vertex's current execution state.

Parameters:

newExecutionState - the new execution state

optionalMessage - an optional message related to the state change

compareAndUpdateExecutionState

public boolean compareAndUpdateExecutionState(ExecutionState expected,
                                     ExecutionState update)

setAllocatedResource

public void setAllocatedResource(AllocatedResource allocatedResource)

Assigns the execution vertex with an AllocatedResource.

Parameters:

allocatedResource - the resources which are supposed to be allocated to this vertex

getAllocatedResource

public AllocatedResource getAllocatedResource()

Returns the allocated resources assigned to this execution vertex.

Returns:

the allocated resources assigned to this execution vertex

getAllocationID

public AllocationID getAllocationID()

Returns the allocation ID which identifies the resources used by this vertex within the assigned instance.

Returns:

the allocation ID which identifies the resources used by this vertex within the assigned instance or null if the instance is still assigned to a DummyInstance.

getID

public ExecutionVertexID getID()

Returns the ID of this execution vertex.

Returns:

the ID of this execution vertex

getNumberOfPredecessors

public int getNumberOfPredecessors()

Returns the number of predecessors, i.e. the number of vertices which connect to this vertex.

Returns:

the number of predecessors

getNumberOfSuccessors

public int getNumberOfSuccessors()

Returns the number of successors, i.e. the number of vertices this vertex is connected to.

Returns:

the number of successors

getPredecessor

public ExecutionVertex getPredecessor(int index)

getSuccessor

public ExecutionVertex getSuccessor(int index)

isInputVertex

public boolean isInputVertex()

Checks if this vertex is an input vertex in its stage, i.e. has either no incoming connections or only incoming connections to group vertices in a lower stage.

Returns:

true if this vertex is an input vertex, false otherwise

isOutputVertex

public boolean isOutputVertex()

Checks if this vertex is an output vertex in its stage, i.e. has either no outgoing connections or only outgoing connections to group vertices in a higher stage.

Returns:

true if this vertex is an output vertex, false otherwise

getIndexInVertexGroup

public int getIndexInVertexGroup()

Returns the index of this vertex in the vertex group.

Returns:

the index of this vertex in the vertex group

getNumberOfOutputGates

public int getNumberOfOutputGates()

Returns the number of output gates attached to this vertex.

Returns:

the number of output gates attached to this vertex

getOutputGate

public ExecutionGate getOutputGate(int index)

Returns the output gate with the given index.

Parameters:

index - the index of the output gate to return

Returns:

the output gate with the given index

getNumberOfInputGates

public int getNumberOfInputGates()

Returns the number of input gates attached to this vertex.

Returns:

the number of input gates attached to this vertex

getInputGate

public ExecutionGate getInputGate(int index)

Returns the input gate with the given index.

Parameters:

index - the index of the input gate to return

Returns:

the input gate with the given index

startTask

public TaskSubmissionResult startTask()

Deploys and starts the task represented by this vertex on the assigned instance.

Returns:

the result of the task submission attempt

killTask

public TaskKillResult killTask()

Kills and removes the task represented by this vertex from the instance it is currently running on. If the corresponding task is not in the state RUNNING, this call will be ignored. If the call has been executed successfully, the task will change the state FAILED.

Returns:

the result of the task kill attempt

cancelTask

public TaskCancelResult cancelTask()

Cancels and removes the task represented by this vertex from the instance it is currently running on. If the task is not currently running, its execution state is simply updated to CANCELLED.

Returns:

the result of the task cancel attempt

getExecutionGraph

public ExecutionGraph getExecutionGraph()

Returns the ExecutionGraph this vertex belongs to.

Returns:

the ExecutionGraph this vertex belongs to

toString

public String toString()

Overrides:

toString in class Object

hasRetriesLeft

@Deprecated
public boolean hasRetriesLeft()

Deprecated.

Returns the task represented by this vertex has a retry attempt left in case of an execution failure.

Returns:

true if the task has a retry attempt left, false otherwise

decrementRetriesLeftAndCheck

public boolean decrementRetriesLeftAndCheck()

Decrements the number of retries left and checks whether another attempt to run the task is possible.

Returns:

trueif the task represented by this vertex can be started at least once more, false/ otherwise

registerVertexAssignmentListener

public void registerVertexAssignmentListener(VertexAssignmentListener vertexAssignmentListener)

Registers the VertexAssignmentListener object for this vertex. This object will be notified about reassignments of this vertex to another instance.

Parameters:

vertexAssignmentListener - the object to be notified about reassignments of this vertex to another instance

unregisterVertexAssignmentListener

public void unregisterVertexAssignmentListener(VertexAssignmentListener vertexAssignmentListener)

Unregisters the VertexAssignmentListener object for this vertex. This object will no longer be notified about reassignments of this vertex to another instance.

Parameters:

vertexAssignmentListener - the listener to be unregistered

registerExecutionListener

public void registerExecutionListener(ExecutionListener executionListener)

Registers the ExecutionListener object for this vertex. This object will be notified about particular events during the vertex's lifetime.

Parameters:

executionListener - the object to be notified about particular events during the vertex's lifetime

unregisterExecutionListener

public void unregisterExecutionListener(ExecutionListener executionListener)

Unregisters the ExecutionListener object for this vertex. This object will no longer be notified about particular events during the vertex's lifetime.

Parameters:

executionListener - the object to be unregistered

getExecutionPipeline

public ExecutionPipeline getExecutionPipeline()

Returns the ExecutionPipeline this vertex is part of.

Returns:

the execution pipeline this vertex is part of

constructDeploymentDescriptor

public TaskDeploymentDescriptor constructDeploymentDescriptor()

Constructs a new task deployment descriptor for this vertex.

Returns:

a new task deployment descriptor for this vertex