org.apache.flink.runtime.executiongraph

Class ExecutionGroupVertex

java.lang.Object

org.apache.flink.runtime.executiongraph.ExecutionGroupVertex

public final class ExecutionGroupVertex
extends Object

An ExecutionGroupVertex is created for every JobVertex of the initial job graph. It represents a number of execution vertices that originate from the same job vertex.

This class is thread-safe.

Constructor Summary

Constructors

Constructor and Description
ExecutionGroupVertex(String name, JobVertexID jobVertexID, ExecutionGraph executionGraph, int userDefinedNumberOfMembers, boolean userDefinedVertexToShareInstanceWith, int numberOfExecutionRetries, Configuration configuration, ExecutionSignature signature, Class<? extends AbstractInvokable> invokableClass) Constructs a new group vertex.

Method Summary

Methods

Modifier and Type	Method and Description
ExecutionGroupEdge	getBackwardEdge(int index)
List<ExecutionGroupEdge>	getBackwardEdges(ExecutionGroupVertex groupVertex)
Configuration	getConfiguration() Returns the configuration object of the original job vertex.
int	getCurrentNumberOfGroupMembers() Returns the current number of members this group vertex has.
ExecutionSignature	getExecutionSignature() Returns the execution signature of this vertex.
ExecutionStage	getExecutionStage() Returns the execution stage this group vertex is associated with.
ExecutionGroupEdge	getForwardEdge(int index)
List<ExecutionGroupEdge>	getForwardEdges(ExecutionGroupVertex groupVertex)
ExecutionVertex	getGroupMember(int pos) Returns a specific execution vertex from the list of members.
InputSplit[]	getInputSplits() Returns the input splits assigned to this group vertex.
Class<? extends InputSplit>	getInputSplitType() Returns the input split type class
JobVertexID	getJobVertexID() Returns the ID of the job vertex which is represented by this group vertex.
String	getName() Returns the name of the group vertex, usually copied from the initial job vertex.
int	getNumberOfBackwardLinks() Returns the number of backward links the current group vertex has.
int	getNumberOfForwardLinks() Returns the number of forward links the current group vertex has.
int	getStageNumber() Returns the number of the stage this group vertex belongs to.
ExecutionGroupVertex	getVertexToShareInstancesWith()
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.
Iterator<ExecutionVertex>	iterator() Returns an iterator over all members of this execution group vertex.
void	setExecutionStage(ExecutionStage executionStage) Sets the execution stage this group vertex is associated with.
void	setInputSplits(InputSplit[] inputSplits) Sets the input splits that should be assigned to this group vertex.
void	setInputSplitType(Class<? extends InputSplit> inputSplitType) Sets the input split type class

Methods inherited from class java.lang.Object

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

Constructor Detail

ExecutionGroupVertex

public ExecutionGroupVertex(String name,
                    JobVertexID jobVertexID,
                    ExecutionGraph executionGraph,
                    int userDefinedNumberOfMembers,
                    boolean userDefinedVertexToShareInstanceWith,
                    int numberOfExecutionRetries,
                    Configuration configuration,
                    ExecutionSignature signature,
                    Class<? extends AbstractInvokable> invokableClass)
                     throws Exception

Constructs a new group vertex.

Parameters:

name - the name of the group vertex

jobVertexID - the ID of the job vertex which is represented by this group vertex

executionGraph - the execution graph is group vertex belongs to

userDefinedNumberOfMembers - the user defined number of subtasks, -1 if the user did not specify the number

userDefinedVertexToShareInstanceWith - true if the user specified another vertex to share instances with, false otherwise

numberOfExecutionRetries - the number of retries in case of an error before the task represented by this vertex is considered as failed, -1 if the user did not specify the number

configuration - the vertex's configuration object

signature - the cryptographic signature of the vertex

invokableClass - the task class that is assigned to execution vertices of this group

Throws:

Exception - throws if an error occurs while instantiating the AbstractInvokable

Method Detail

getName

public String getName()

Returns the name of the group vertex, usually copied from the initial job vertex.

Returns:

the name of the group vertex.

setExecutionStage

public void setExecutionStage(ExecutionStage executionStage)

Sets the execution stage this group vertex is associated with.

Parameters:

executionStage - The new execution stage.

getExecutionStage

public ExecutionStage getExecutionStage()

Returns the execution stage this group vertex is associated with.

Returns:

The execution stage this vertex is associated with.

getGroupMember

public ExecutionVertex getGroupMember(int pos)

Returns a specific execution vertex from the list of members.

Parameters:

pos - The position of the execution vertex to be returned.

Returns:

The execution vertex at position pos of the member list, null if there is no such position.

getCurrentNumberOfGroupMembers

public int getCurrentNumberOfGroupMembers()

Returns the current number of members this group vertex has.

Returns:

the current number of members this group vertex has

getNumberOfForwardLinks

public int getNumberOfForwardLinks()

Returns the number of forward links the current group vertex has.

Returns:

the number of forward links the current group vertex has

getNumberOfBackwardLinks

public int getNumberOfBackwardLinks()

Returns the number of backward links the current group vertex has.

Returns:

the number of backward links the current group vertex has

getStageNumber

public int getStageNumber()

Returns the number of the stage this group vertex belongs to.

Returns:

the number of the stage this group vertex belongs to

setInputSplits

public void setInputSplits(InputSplit[] inputSplits)

Sets the input splits that should be assigned to this group vertex.

Parameters:

inputSplits - the input splits that shall be assigned to this group vertex

setInputSplitType

public void setInputSplitType(Class<? extends InputSplit> inputSplitType)

Sets the input split type class

Parameters:

inputSplitType - Input split type class

getInputSplits

public InputSplit[] getInputSplits()

Returns the input splits assigned to this group vertex.

Returns:

the input splits, possibly null if the group vertex does not represent an input vertex

getInputSplitType

public Class<? extends InputSplit> getInputSplitType()

Returns the input split type class

Returns:

the input split type class, possibly null if the group vertex does not represent an input vertex

getForwardEdge

public ExecutionGroupEdge getForwardEdge(int index)

getBackwardEdge

public ExecutionGroupEdge getBackwardEdge(int index)

getForwardEdges

public List<ExecutionGroupEdge> getForwardEdges(ExecutionGroupVertex groupVertex)

getBackwardEdges

public List<ExecutionGroupEdge> getBackwardEdges(ExecutionGroupVertex groupVertex)

getConfiguration

public Configuration getConfiguration()

Returns the configuration object of the original job vertex.

Returns:

the configuration object of the original job vertex

getExecutionSignature

public ExecutionSignature getExecutionSignature()

Returns the execution signature of this vertex.

Returns:

the execution signature of this vertex

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

getVertexToShareInstancesWith

public ExecutionGroupVertex getVertexToShareInstancesWith()

getJobVertexID

public JobVertexID getJobVertexID()

Returns the ID of the job vertex which is represented by this group vertex.

Returns:

the ID of the job vertex which is represented by this group vertex

iterator

public Iterator<ExecutionVertex> iterator()

Returns an iterator over all members of this execution group vertex.

Returns:

an iterator over all members of this execution group vertex