org.apache.flink.runtime.executiongraph

Class ExecutionStage

java.lang.Object

org.apache.flink.runtime.executiongraph.ExecutionStage

public final class ExecutionStage
extends Object

An execution stage contains all execution group vertices (and as a result all execution vertices) which must run at the same time. The execution of a job progresses in terms of stages, i.e. the next stage of a job can only start to execute if the execution of its preceding stage is complete.

This class is thread-safe.

Constructor Summary

Constructors

Constructor and Description
ExecutionStage(ExecutionGraph executionGraph, int stageNum) Constructs a new execution stage and assigns the given stage number to it.

Method Summary

Methods

Modifier and Type	Method and Description
void	addStageMember(ExecutionGroupVertex groupVertex) Adds a new execution group vertex to this stage if it is not already included.
ExecutionGraph	getExecutionGraph() Returns the execution graph that this stage belongs to.
ExecutionVertex	getInputExecutionVertex(int index) Returns the output execution vertex with the given index or null if no such vertex exists.
int	getMaxNumberSubtasks()
int	getNumberOfInputExecutionVertices() Returns the number of input execution vertices in this stage, i.e.
int	getNumberOfOutputExecutionVertices() Returns the number of output execution vertices in this stage, i.e.
int	getNumberOfStageMembers() Returns the number of group vertices this execution stage includes.
ExecutionVertex	getOutputExecutionVertex(int index) Returns the input execution vertex with the given index or null if no such vertex exists.
int	getRequiredSlots()
ExecutionGroupVertex	getStageMember(int index) Returns the stage member internally stored at index index.
int	getStageNumber() Returns the number of this execution stage.
void	removeStageMember(ExecutionGroupVertex groupVertex) Removes the specified group vertex from the execution stage.
void	setStageNumber(int stageNum) Sets the number of this execution stage.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExecutionStage

public ExecutionStage(ExecutionGraph executionGraph,
              int stageNum)

Constructs a new execution stage and assigns the given stage number to it.

Parameters:

executionGraph - the executionGraph that this stage belongs to

stageNum - the number of this execution stage

Method Detail

setStageNumber

public void setStageNumber(int stageNum)

Sets the number of this execution stage.

Parameters:

stageNum - the new number of this execution stage

getStageNumber

public int getStageNumber()

Returns the number of this execution stage.

Returns:

the number of this execution stage

addStageMember

public void addStageMember(ExecutionGroupVertex groupVertex)

Adds a new execution group vertex to this stage if it is not already included.

Parameters:

groupVertex - the new execution group vertex to include

removeStageMember

public void removeStageMember(ExecutionGroupVertex groupVertex)

Removes the specified group vertex from the execution stage.

Parameters:

groupVertex - the group vertex to remove from the stage

getNumberOfStageMembers

public int getNumberOfStageMembers()

Returns the number of group vertices this execution stage includes.

Returns:

the number of group vertices this execution stage includes

getStageMember

public ExecutionGroupVertex getStageMember(int index)

Returns the stage member internally stored at index index.

Parameters:

index - the index of the group vertex to return

Returns:

the stage member internally stored at the specified index or null if no group vertex exists with such an index

getNumberOfInputExecutionVertices

public int getNumberOfInputExecutionVertices()

Returns the number of input execution vertices in this stage, i.e. the number of execution vertices which are connected to vertices in a lower stage or have no input channels.

Returns:

the number of input vertices in this stage

getNumberOfOutputExecutionVertices

public int getNumberOfOutputExecutionVertices()

Returns the number of output execution vertices in this stage, i.e. the number of execution vertices which are connected to vertices in a higher stage or have no output channels.

Returns:

the number of output vertices in this stage

getInputExecutionVertex

public ExecutionVertex getInputExecutionVertex(int index)

Returns the output execution vertex with the given index or null if no such vertex exists.

Parameters:

index - the index of the vertex to be selected.

Returns:

the output execution vertex with the given index or null if no such vertex exists

getOutputExecutionVertex

public ExecutionVertex getOutputExecutionVertex(int index)

Returns the input execution vertex with the given index or null if no such vertex exists.

Parameters:

index - the index of the vertex to be selected.

Returns:

the input execution vertex with the given index or null if no such vertex exists

getExecutionGraph

public ExecutionGraph getExecutionGraph()

Returns the execution graph that this stage belongs to.

Returns:

the execution graph that this stage belongs to

getMaxNumberSubtasks

public int getMaxNumberSubtasks()

getRequiredSlots

public int getRequiredSlots()