org.apache.flink.runtime.jobmanager.scheduler

Class CoLocationGroup

java.lang.Object

org.apache.flink.runtime.jobmanager.scheduler.CoLocationGroup

All Implemented Interfaces:

Serializable

public class CoLocationGroup
extends Object
implements Serializable

A Co-location group is a group of JobVertices, where the i-th subtask of one vertex has to be executed on the same TaskManager as the i-th subtask of all other JobVertices in the same group.

The co-location group is used for example to make sure that the i-th subtasks for iteration head and iteration tail are scheduled to the same TaskManager.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CoLocationGroup()
CoLocationGroup(JobVertex... vertices)

Method Summary

Modifier and Type	Method and Description
void	addVertex(JobVertex vertex)
AbstractID	getId() Gets the ID that identifies this co-location group.
CoLocationConstraint	getLocationConstraint(int subtask)
List<JobVertex>	getVertices()
void	mergeInto(CoLocationGroup other)
void	resetConstraints() Resets this co-location group, meaning that future calls to getLocationConstraint(int) will give out new CoLocationConstraints.

Methods inherited from class java.lang.Object

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

Constructor Detail

CoLocationGroup

public CoLocationGroup()

CoLocationGroup

public CoLocationGroup(JobVertex... vertices)

Method Detail

addVertex

public void addVertex(JobVertex vertex)

getVertices

public List<JobVertex> getVertices()

mergeInto

public void mergeInto(CoLocationGroup other)

getLocationConstraint

public CoLocationConstraint getLocationConstraint(int subtask)

getId

public AbstractID getId()

Gets the ID that identifies this co-location group.

Returns:

The ID that identifies this co-location group.

resetConstraints

public void resetConstraints()

Resets this co-location group, meaning that future calls to getLocationConstraint(int) will give out new CoLocationConstraints.

This method can only be called when no tasks from any of the CoLocationConstraints are executed any more.