org.apache.flink.runtime.instance

Class AllocatedResource

java.lang.Object

org.apache.flink.runtime.instance.AllocatedResource

public final class AllocatedResource
extends Object

An allocated resource object unambiguously defines the hardware resources which have been assigned to an ExecutionVertex for executing a task. The allocated resource is comprised of an Instance which identifies the node the task is scheduled to run on as well as an AllocationID which determines the resources the task is scheduled to allocate within the node.

The class is thread-safe.

Constructor Summary

Constructors

Constructor and Description
AllocatedResource(Instance instance, AllocationID allocationID) Constructs a new allocated resource object.

Method Summary

Methods

Modifier and Type	Method and Description
Iterator<ExecutionVertex>	assignedVertices() Returns an iterator over all execution vertices currently assigned to this allocated resource.
void	assignVertexToResource(ExecutionVertex vertex) Assigns the given execution vertex to this allocated resource.
boolean	equals(Object obj)
AllocationID	getAllocationID() Returns the allocation ID which identifies the resource allocated within the assigned instance.
Instance	getInstance() Returns the instance a task is scheduled to run on.
int	hashCode()
void	removeVertexFromResource(ExecutionVertex vertex) Removes the given execution vertex from this allocated resource.

Methods inherited from class java.lang.Object

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

Constructor Detail

AllocatedResource

public AllocatedResource(Instance instance,
                 AllocationID allocationID)

Constructs a new allocated resource object.

Parameters:

instance - the instance a task is scheduled to run on.

allocationID - the allocation ID identifying the allocated resources within the instance

Method Detail

getInstance

public Instance getInstance()

Returns the instance a task is scheduled to run on.

Returns:

the instance a task is scheduled to run on

getAllocationID

public AllocationID getAllocationID()

Returns the allocation ID which identifies the resource allocated within the assigned instance.

Returns:

the allocation ID or null if the assigned instance is of type DummyInstance

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

assignVertexToResource

public void assignVertexToResource(ExecutionVertex vertex)

Assigns the given execution vertex to this allocated resource.

Parameters:

vertex - the vertex to assign to this resource

assignedVertices

public Iterator<ExecutionVertex> assignedVertices()

Returns an iterator over all execution vertices currently assigned to this allocated resource.

Returns:

an iterator over all execution vertices currently assigned to this allocated resource

removeVertexFromResource

public void removeVertexFromResource(ExecutionVertex vertex)

Removes the given execution vertex from this allocated resource.

Parameters:

vertex - the execution to be removed