org.apache.flink.runtime.deployment

Class TaskDeploymentDescriptor

java.lang.Object

org.apache.flink.runtime.deployment.TaskDeploymentDescriptor

All Implemented Interfaces:

IOReadableWritable

public final class TaskDeploymentDescriptor
extends Object
implements IOReadableWritable

A task deployment descriptor contains all the information necessary to deploy a task on a task manager.

This class is not thread-safe in general.

Constructor Summary

Constructors

Constructor and Description
TaskDeploymentDescriptor() Default constructor for serialization/deserialization.
TaskDeploymentDescriptor(JobID jobID, ExecutionVertexID vertexID, String taskName, int indexInSubtaskGroup, int currentNumberOfSubtasks, Configuration jobConfiguration, Configuration taskConfiguration, Class<? extends AbstractInvokable> invokableClass, SerializableArrayList<GateDeploymentDescriptor> outputGates, SerializableArrayList<GateDeploymentDescriptor> inputGates) Constructs a task deployment descriptor.

Method Summary

Methods

Modifier and Type	Method and Description
int	getCurrentNumberOfSubtasks() Returns the current number of subtasks.
int	getIndexInSubtaskGroup() Returns the task's index in the subtask group.
GateDeploymentDescriptor	getInputGateDescriptor(int index) Returns the input gate descriptor with the given index
Class<? extends AbstractInvokable>	getInvokableClass() Returns the class containing the task code to be executed.
Configuration	getJobConfiguration() Returns the configuration of the job the task belongs to.
JobID	getJobID() Returns the ID of the job the tasks belongs to.
int	getNumberOfInputGateDescriptors() Returns the number of output gate deployment descriptors contained in this task deployment descriptor.
int	getNumberOfOutputGateDescriptors() Returns the number of output gate deployment descriptors contained in this task deployment descriptor.
GateDeploymentDescriptor	getOutputGateDescriptor(int index) Returns the output gate descriptor with the given index
Configuration	getTaskConfiguration() Returns the task's configuration object.
String	getTaskName() Returns the task's name.
ExecutionVertexID	getVertexID() Returns the task's execution vertex ID.
void	read(DataInputView in)
void	write(DataOutputView out)

Methods inherited from class java.lang.Object

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

Constructor Detail

TaskDeploymentDescriptor

public TaskDeploymentDescriptor(JobID jobID,
                        ExecutionVertexID vertexID,
                        String taskName,
                        int indexInSubtaskGroup,
                        int currentNumberOfSubtasks,
                        Configuration jobConfiguration,
                        Configuration taskConfiguration,
                        Class<? extends AbstractInvokable> invokableClass,
                        SerializableArrayList<GateDeploymentDescriptor> outputGates,
                        SerializableArrayList<GateDeploymentDescriptor> inputGates)

Constructs a task deployment descriptor.

Parameters:

jobID - the ID of the job the tasks belongs to

vertexID - the task's execution vertex ID

taskName - the task's name the task's index in the subtask group

indexInSubtaskGroup - he task's index in the subtask group

currentNumberOfSubtasks - the current number of subtasks

jobConfiguration - the configuration of the job the task belongs to

taskConfiguration - the task's configuration object

invokableClass - the class containing the task code to be executed

outputGates - list of output gate deployment descriptors

inputGateIDs - list of input gate deployment descriptors

TaskDeploymentDescriptor

public TaskDeploymentDescriptor()

Default constructor for serialization/deserialization.

Method Detail

write

public void write(DataOutputView out)
           throws IOException

Specified by:

write in interface IOReadableWritable

Throws:

IOException

read

public void read(DataInputView in)
          throws IOException

Specified by:

read in interface IOReadableWritable

Throws:

IOException

getJobID

public JobID getJobID()

Returns the ID of the job the tasks belongs to.

Returns:

the ID of the job the tasks belongs to

getVertexID

public ExecutionVertexID getVertexID()

Returns the task's execution vertex ID.

Returns:

the task's execution vertex ID

getTaskName

public String getTaskName()

Returns the task's name.

Returns:

the task's name

getIndexInSubtaskGroup

public int getIndexInSubtaskGroup()

Returns the task's index in the subtask group.

Returns:

the task's index in the subtask group

getCurrentNumberOfSubtasks

public int getCurrentNumberOfSubtasks()

Returns the current number of subtasks.

Returns:

the current number of subtasks

getJobConfiguration

public Configuration getJobConfiguration()

Returns the configuration of the job the task belongs to.

Returns:

the configuration of the job the tasks belongs to

getTaskConfiguration

public Configuration getTaskConfiguration()

Returns the task's configuration object.

Returns:

the task's configuration object

getInvokableClass

public Class<? extends AbstractInvokable> getInvokableClass()

Returns the class containing the task code to be executed.

Returns:

the class containing the task code to be executed

getNumberOfOutputGateDescriptors

public int getNumberOfOutputGateDescriptors()

Returns the number of output gate deployment descriptors contained in this task deployment descriptor.

Returns:

the number of output gate deployment descriptors

getOutputGateDescriptor

public GateDeploymentDescriptor getOutputGateDescriptor(int index)

Returns the output gate descriptor with the given index

Parameters:

index - the index if the output gate descriptor to return

Returns:

the output gate descriptor with the given index

getNumberOfInputGateDescriptors

public int getNumberOfInputGateDescriptors()

Returns the number of output gate deployment descriptors contained in this task deployment descriptor.

Returns:

the number of output gate deployment descriptors

getInputGateDescriptor

public GateDeploymentDescriptor getInputGateDescriptor(int index)

Returns the input gate descriptor with the given index

Parameters:

index - the index if the input gate descriptor to return

Returns:

the input gate descriptor with the given index