Package org.apache.flink.runtime.deployment

Class TaskDeploymentDescriptor

java.lang.Object

org.apache.flink.runtime.deployment.TaskDeploymentDescriptor

All Implemented Interfaces:

Serializable

public final class TaskDeploymentDescriptor
extends Object
implements Serializable

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TaskDeploymentDescriptor.MaybeOffloaded<T>	Wrapper class for serialized values which may be offloaded to the BlobServer or not.
static class	TaskDeploymentDescriptor.NonOffloaded<T>	A serialized value that is not offloaded to the BlobServer.
static class	TaskDeploymentDescriptor.Offloaded<T>	Reference to a serialized value that was offloaded to the BlobServer.

Constructor Summary

Constructors

Constructor

Description

TaskDeploymentDescriptor(org.apache.flink.api.common.JobID jobId, TaskDeploymentDescriptor.MaybeOffloaded<JobInformation> serializedJobInformation, TaskDeploymentDescriptor.MaybeOffloaded<TaskInformation> serializedTaskInformation, ExecutionAttemptID executionAttemptId, AllocationID allocationId, JobManagerTaskRestore taskRestore, List<ResultPartitionDeploymentDescriptor> resultPartitionDeploymentDescriptors, List<InputGateDeploymentDescriptor> inputGateDeploymentDescriptors)

Method Summary

Modifier and Type	Method	Description
AllocationID	getAllocationId()
int	getAttemptNumber()	Returns the attempt number of the subtask.
ExecutionAttemptID	getExecutionAttemptId()
List<InputGateDeploymentDescriptor>	getInputGates()
org.apache.flink.api.common.JobID	getJobId()	Returns the task's job ID.
List<ResultPartitionDeploymentDescriptor>	getProducedPartitions()
org.apache.flink.util.SerializedValue<JobInformation>	getSerializedJobInformation()	Return the sub task's serialized job information.
org.apache.flink.util.SerializedValue<TaskInformation>	getSerializedTaskInformation()	Return the sub task's serialized task information.
int	getSubtaskIndex()	Returns the task's index in the subtask group.
JobManagerTaskRestore	getTaskRestore()
void	loadBigData(PermanentBlobService blobService, ShuffleDescriptorsCache shuffleDescriptorsCache)	Loads externalized data from the BLOB store back to the object.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

TaskDeploymentDescriptor

public TaskDeploymentDescriptor(org.apache.flink.api.common.JobID jobId,
                                TaskDeploymentDescriptor.MaybeOffloaded<JobInformation> serializedJobInformation,
                                TaskDeploymentDescriptor.MaybeOffloaded<TaskInformation> serializedTaskInformation,
                                ExecutionAttemptID executionAttemptId,
                                AllocationID allocationId,
                                @Nullable
                                JobManagerTaskRestore taskRestore,
                                List<ResultPartitionDeploymentDescriptor> resultPartitionDeploymentDescriptors,
                                List<InputGateDeploymentDescriptor> inputGateDeploymentDescriptors)

Method Detail

getSerializedJobInformation

public org.apache.flink.util.SerializedValue<JobInformation> getSerializedJobInformation()

Return the sub task's serialized job information.

Returns:

serialized job information (may throw IllegalStateException if loadBigData(org.apache.flink.runtime.blob.PermanentBlobService, org.apache.flink.runtime.taskexecutor.ShuffleDescriptorsCache) is not called beforehand).

Throws:

IllegalStateException - If job information is offloaded to BLOB store.

getSerializedTaskInformation

public org.apache.flink.util.SerializedValue<TaskInformation> getSerializedTaskInformation()

Return the sub task's serialized task information.

Returns:

serialized task information (may throw IllegalStateException if loadBigData(org.apache.flink.runtime.blob.PermanentBlobService, org.apache.flink.runtime.taskexecutor.ShuffleDescriptorsCache) is not called beforehand)).

Throws:

IllegalStateException - If job information is offloaded to BLOB store.

getJobId

public org.apache.flink.api.common.JobID getJobId()

Returns the task's job ID.

Returns:

the job ID this task belongs to

getExecutionAttemptId

public ExecutionAttemptID getExecutionAttemptId()

getSubtaskIndex

public int getSubtaskIndex()

Returns the task's index in the subtask group.

Returns:

the task's index in the subtask group

getAttemptNumber

public int getAttemptNumber()

Returns the attempt number of the subtask.

getProducedPartitions

public List<ResultPartitionDeploymentDescriptor> getProducedPartitions()

getInputGates

public List<InputGateDeploymentDescriptor> getInputGates()

getTaskRestore

@Nullable
public JobManagerTaskRestore getTaskRestore()

getAllocationId

public AllocationID getAllocationId()

loadBigData

public void loadBigData(@Nullable
                        PermanentBlobService blobService,
                        ShuffleDescriptorsCache shuffleDescriptorsCache)
                 throws IOException,
                        ClassNotFoundException

Loads externalized data from the BLOB store back to the object.

Parameters:

blobService - the blob store to use (may be null if serializedJobInformation and serializedTaskInformation are non-null)

shuffleDescriptorsCache - cache of shuffle descriptors to reduce the cost of deserialization

Throws:

IOException - during errors retrieving or reading the BLOBs

ClassNotFoundException - Class of a serialized object cannot be found.

toString

public String toString()

Overrides:

toString in class Object