org.apache.flink.runtime.jobmanager.slots

Interface TaskManagerGateway

All Known Implementing Classes:

RpcTaskManagerGateway

public interface TaskManagerGateway

Task manager gateway interface to communicate with the task manager.

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Acknowledge>	cancelTask(ExecutionAttemptID executionAttemptID, Time timeout) Cancel the given task.
CompletableFuture<Acknowledge>	freeSlot(AllocationID allocationId, Throwable cause, Time timeout) Frees the slot with the given allocation ID.
String	getAddress() Return the address of the task manager with which the gateway is associated.
void	notifyCheckpointComplete(ExecutionAttemptID executionAttemptID, JobID jobId, long checkpointId, long timestamp) Notify the given task about a completed checkpoint.
void	releasePartitions(JobID jobId, Set<ResultPartitionID> partitionIds) Batch release intermediate result partitions.
CompletableFuture<TaskBackPressureResponse>	requestTaskBackPressure(ExecutionAttemptID executionAttemptID, int requestId, Time timeout) Request the back pressure ratio for the given task.
CompletableFuture<Acknowledge>	submitTask(TaskDeploymentDescriptor tdd, Time timeout) Submit a task to the task manager.
void	triggerCheckpoint(ExecutionAttemptID executionAttemptID, JobID jobId, long checkpointId, long timestamp, CheckpointOptions checkpointOptions, boolean advanceToEndOfEventTime) Trigger for the given task a checkpoint.
CompletableFuture<Acknowledge>	updatePartitions(ExecutionAttemptID executionAttemptID, Iterable<PartitionInfo> partitionInfos, Time timeout) Update the task where the given partitions can be found.

Method Detail

getAddress

String getAddress()

Return the address of the task manager with which the gateway is associated.

Returns:

Address of the task manager with which this gateway is associated.

requestTaskBackPressure

CompletableFuture<TaskBackPressureResponse> requestTaskBackPressure(ExecutionAttemptID executionAttemptID,
                                                                    int requestId,
                                                                    Time timeout)

Request the back pressure ratio for the given task.

Parameters:

executionAttemptID - identifying the task to request.

requestId - id of the request.

timeout - rpc request timeout.

Returns:

A future of the task back pressure result.

submitTask

CompletableFuture<Acknowledge> submitTask(TaskDeploymentDescriptor tdd,
                                          Time timeout)

Submit a task to the task manager.

Parameters:

tdd - describing the task to submit

timeout - of the submit operation

Returns:

Future acknowledge of the successful operation

cancelTask

CompletableFuture<Acknowledge> cancelTask(ExecutionAttemptID executionAttemptID,
                                          Time timeout)

Cancel the given task.

Parameters:

executionAttemptID - identifying the task

timeout - of the submit operation

Returns:

Future acknowledge if the task is successfully canceled

updatePartitions

CompletableFuture<Acknowledge> updatePartitions(ExecutionAttemptID executionAttemptID,
                                                Iterable<PartitionInfo> partitionInfos,
                                                Time timeout)

Update the task where the given partitions can be found.

Parameters:

executionAttemptID - identifying the task

partitionInfos - telling where the partition can be retrieved from

timeout - of the submit operation

Returns:

Future acknowledge if the partitions have been successfully updated

releasePartitions

void releasePartitions(JobID jobId,
                       Set<ResultPartitionID> partitionIds)

Batch release intermediate result partitions.

Parameters:

jobId - id of the job that the partitions belong to

partitionIds - partition ids to release

notifyCheckpointComplete

void notifyCheckpointComplete(ExecutionAttemptID executionAttemptID,
                              JobID jobId,
                              long checkpointId,
                              long timestamp)

Notify the given task about a completed checkpoint.

Parameters:

executionAttemptID - identifying the task

jobId - identifying the job to which the task belongs

checkpointId - of the completed checkpoint

timestamp - of the completed checkpoint

triggerCheckpoint

void triggerCheckpoint(ExecutionAttemptID executionAttemptID,
                       JobID jobId,
                       long checkpointId,
                       long timestamp,
                       CheckpointOptions checkpointOptions,
                       boolean advanceToEndOfEventTime)

Trigger for the given task a checkpoint.

Parameters:

executionAttemptID - identifying the task

jobId - identifying the job to which the task belongs

checkpointId - of the checkpoint to trigger

timestamp - of the checkpoint to trigger

checkpointOptions - of the checkpoint to trigger

advanceToEndOfEventTime - Flag indicating if the source should inject a MAX_WATERMARK in the pipeline to fire any registered event-time timers

freeSlot

CompletableFuture<Acknowledge> freeSlot(AllocationID allocationId,
                                        Throwable cause,
                                        Time timeout)

Frees the slot with the given allocation ID.

Parameters:

allocationId - identifying the slot to free

cause - of the freeing operation

timeout - for the operation

Returns:

Future acknowledge which is returned once the slot has been freed