org.apache.flink.runtime.taskexecutor

Interface TaskExecutorGateway

All Superinterfaces:

RpcGateway

All Known Implementing Classes:

TaskExecutor

public interface TaskExecutorGateway
extends RpcGateway

TaskExecutor RPC gateway interface.

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Boolean>	canBeReleased() Checks whether the task executor can be released.
CompletableFuture<Acknowledge>	cancelTask(ExecutionAttemptID executionAttemptID, org.apache.flink.api.common.time.Time timeout) Cancel the given task.
CompletableFuture<Acknowledge>	confirmCheckpoint(ExecutionAttemptID executionAttemptID, long checkpointId, long checkpointTimestamp) Confirm a checkpoint for the given task.
void	disconnectJobManager(org.apache.flink.api.common.JobID jobId, Exception cause) Disconnects the given JobManager from the TaskManager.
void	disconnectResourceManager(Exception cause) Disconnects the ResourceManager from the TaskManager.
CompletableFuture<Acknowledge>	freeSlot(AllocationID allocationId, Throwable cause, org.apache.flink.api.common.time.Time timeout) Frees the slot with the given allocation ID.
void	heartbeatFromJobManager(ResourceID heartbeatOrigin, AllocatedSlotReport allocatedSlotReport) Heartbeat request from the job manager.
void	heartbeatFromResourceManager(ResourceID heartbeatOrigin) Heartbeat request from the resource manager.
void	releaseOrPromotePartitions(org.apache.flink.api.common.JobID jobId, Set<ResultPartitionID> partitionToRelease, Set<ResultPartitionID> partitionsToPromote) Batch release/promote intermediate result partitions.
CompletableFuture<TransientBlobKey>	requestFileUpload(FileType fileType, org.apache.flink.api.common.time.Time timeout) Requests the file upload of the specified type to the cluster's BlobServer.
CompletableFuture<org.apache.flink.types.SerializableOptional<String>>	requestMetricQueryServiceAddress(org.apache.flink.api.common.time.Time timeout) Returns the gateway of Metric Query Service on the TaskManager.
CompletableFuture<Acknowledge>	requestSlot(SlotID slotId, org.apache.flink.api.common.JobID jobId, AllocationID allocationId, ResourceProfile resourceProfile, String targetAddress, ResourceManagerId resourceManagerId, org.apache.flink.api.common.time.Time timeout) Requests a slot from the TaskManager.
CompletableFuture<TaskBackPressureResponse>	requestTaskBackPressure(ExecutionAttemptID executionAttemptId, int requestId, org.apache.flink.api.common.time.Time timeout)
CompletableFuture<Acknowledge>	submitTask(TaskDeploymentDescriptor tdd, JobMasterId jobMasterId, org.apache.flink.api.common.time.Time timeout) Submit a Task to the TaskExecutor.
CompletableFuture<Acknowledge>	triggerCheckpoint(ExecutionAttemptID executionAttemptID, long checkpointID, long checkpointTimestamp, CheckpointOptions checkpointOptions, boolean advanceToEndOfEventTime) Trigger the checkpoint for the given task.
CompletableFuture<Acknowledge>	updatePartitions(ExecutionAttemptID executionAttemptID, Iterable<PartitionInfo> partitionInfos, org.apache.flink.api.common.time.Time timeout) Update the task where the given partitions can be found.

Methods inherited from interface org.apache.flink.runtime.rpc.RpcGateway

getAddress, getHostname

Method Detail

requestSlot

CompletableFuture<Acknowledge> requestSlot(SlotID slotId,
                                           org.apache.flink.api.common.JobID jobId,
                                           AllocationID allocationId,
                                           ResourceProfile resourceProfile,
                                           String targetAddress,
                                           ResourceManagerId resourceManagerId,
                                           org.apache.flink.api.common.time.Time timeout)

Requests a slot from the TaskManager.

Parameters:

slotId - slot id for the request

jobId - for which to request a slot

allocationId - id for the request

resourceProfile - of requested slot, used only for dynamic slot allocation and will be ignored otherwise

targetAddress - to which to offer the requested slots

resourceManagerId - current leader id of the ResourceManager

timeout - for the operation

Returns:

answer to the slot request

requestTaskBackPressure

CompletableFuture<TaskBackPressureResponse> requestTaskBackPressure(ExecutionAttemptID executionAttemptId,
                                                                    int requestId,
                                                                    org.apache.flink.api.common.time.Time timeout)

submitTask

CompletableFuture<Acknowledge> submitTask(TaskDeploymentDescriptor tdd,
                                          JobMasterId jobMasterId,
                                          org.apache.flink.api.common.time.Time timeout)

Submit a Task to the TaskExecutor.

Parameters:

tdd - describing the task to submit

jobMasterId - identifying the submitting JobMaster

timeout - of the submit operation

Returns:

Future acknowledge of the successful operation

updatePartitions

CompletableFuture<Acknowledge> updatePartitions(ExecutionAttemptID executionAttemptID,
                                                Iterable<PartitionInfo> partitionInfos,
                                                org.apache.flink.api.common.time.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 - for the update partitions operation

Returns:

Future acknowledge if the partitions have been successfully updated

releaseOrPromotePartitions

void releaseOrPromotePartitions(org.apache.flink.api.common.JobID jobId,
                                Set<ResultPartitionID> partitionToRelease,
                                Set<ResultPartitionID> partitionsToPromote)

Batch release/promote intermediate result partitions.

Parameters:

jobId - id of the job that the partitions belong to

partitionToRelease - partition ids to release

partitionsToPromote - partitions ids to promote

triggerCheckpoint

CompletableFuture<Acknowledge> triggerCheckpoint(ExecutionAttemptID executionAttemptID,
                                                 long checkpointID,
                                                 long checkpointTimestamp,
                                                 CheckpointOptions checkpointOptions,
                                                 boolean advanceToEndOfEventTime)

Trigger the checkpoint for the given task. The checkpoint is identified by the checkpoint ID and the checkpoint timestamp.

Parameters:

executionAttemptID - identifying the task

checkpointID - unique id for the checkpoint

checkpointTimestamp - is the timestamp when the checkpoint has been initiated

checkpointOptions - for performing the checkpoint

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

Returns:

Future acknowledge if the checkpoint has been successfully triggered

confirmCheckpoint

CompletableFuture<Acknowledge> confirmCheckpoint(ExecutionAttemptID executionAttemptID,
                                                 long checkpointId,
                                                 long checkpointTimestamp)

Confirm a checkpoint for the given task. The checkpoint is identified by the checkpoint ID and the checkpoint timestamp.

Parameters:

executionAttemptID - identifying the task

checkpointId - unique id for the checkpoint

checkpointTimestamp - is the timestamp when the checkpoint has been initiated

Returns:

Future acknowledge if the checkpoint has been successfully confirmed

cancelTask

CompletableFuture<Acknowledge> cancelTask(ExecutionAttemptID executionAttemptID,
                                          org.apache.flink.api.common.time.Time timeout)

Cancel the given task.

Parameters:

executionAttemptID - identifying the task

timeout - for the cancel operation

Returns:

Future acknowledge if the task is successfully canceled

heartbeatFromJobManager

void heartbeatFromJobManager(ResourceID heartbeatOrigin,
                             AllocatedSlotReport allocatedSlotReport)

Heartbeat request from the job manager.

Parameters:

heartbeatOrigin - unique id of the job manager

heartbeatFromResourceManager

void heartbeatFromResourceManager(ResourceID heartbeatOrigin)

Heartbeat request from the resource manager.

Parameters:

heartbeatOrigin - unique id of the resource manager

disconnectJobManager

void disconnectJobManager(org.apache.flink.api.common.JobID jobId,
                          Exception cause)

Disconnects the given JobManager from the TaskManager.

Parameters:

jobId - JobID for which the JobManager was the leader

cause - for the disconnection from the JobManager

disconnectResourceManager

void disconnectResourceManager(Exception cause)

Disconnects the ResourceManager from the TaskManager.

Parameters:

cause - for the disconnection from the ResourceManager

freeSlot

CompletableFuture<Acknowledge> freeSlot(AllocationID allocationId,
                                        Throwable cause,
                                        org.apache.flink.api.common.time.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

requestFileUpload

CompletableFuture<TransientBlobKey> requestFileUpload(FileType fileType,
                                                      org.apache.flink.api.common.time.Time timeout)

Requests the file upload of the specified type to the cluster's BlobServer.

Parameters:

fileType - to upload

timeout - for the asynchronous operation

Returns:

Future which is completed with the TransientBlobKey of the uploaded file.

requestMetricQueryServiceAddress

CompletableFuture<org.apache.flink.types.SerializableOptional<String>> requestMetricQueryServiceAddress(org.apache.flink.api.common.time.Time timeout)

Returns the gateway of Metric Query Service on the TaskManager.

Returns:

Future gateway of Metric Query Service on the TaskManager.

canBeReleased

CompletableFuture<Boolean> canBeReleased()

Checks whether the task executor can be released. It cannot be released if there're unconsumed result partitions.

Returns:

Future flag indicating whether the task executor can be released.