org.apache.flink.runtime.jobmanager.slots

Interface TaskManagerGateway

All Known Implementing Classes:

ActorTaskManagerGateway, 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, org.apache.flink.api.common.time.Time timeout) Cancel the given task.
void	disconnectFromJobManager(InstanceID instanceId, Exception cause) Disconnect the task manager from the job manager.
void	failPartition(ExecutionAttemptID executionAttemptID) Fail all intermediate result partitions of the given task.
CompletableFuture<Acknowledge>	freeSlot(AllocationID allocationId, Throwable cause, org.apache.flink.api.common.time.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, org.apache.flink.api.common.JobID jobId, long checkpointId, long timestamp) Notify the given task about a completed checkpoint.
CompletableFuture<StackTrace>	requestStackTrace(org.apache.flink.api.common.time.Time timeout) Request the stack trace from the task manager.
CompletableFuture<StackTraceSampleResponse>	requestStackTraceSample(ExecutionAttemptID executionAttemptID, int sampleId, int numSamples, org.apache.flink.api.common.time.Time delayBetweenSamples, int maxStackTraceDepth, org.apache.flink.api.common.time.Time timeout) Request a stack trace sample from the given task.
CompletableFuture<TransientBlobKey>	requestTaskManagerLog(org.apache.flink.api.common.time.Time timeout) Request the task manager log from the task manager.
CompletableFuture<TransientBlobKey>	requestTaskManagerStdout(org.apache.flink.api.common.time.Time timeout) Request the task manager stdout from the task manager.
void	stopCluster(ApplicationStatus applicationStatus, String message) Stop the cluster.
CompletableFuture<Acknowledge>	stopTask(ExecutionAttemptID executionAttemptID, org.apache.flink.api.common.time.Time timeout) Stop the given task.
CompletableFuture<Acknowledge>	submitTask(TaskDeploymentDescriptor tdd, org.apache.flink.api.common.time.Time timeout) Submit a task to the task manager.
void	triggerCheckpoint(ExecutionAttemptID executionAttemptID, org.apache.flink.api.common.JobID jobId, long checkpointId, long timestamp, CheckpointOptions checkpointOptions) Trigger for the given task a checkpoint.
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.

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.

disconnectFromJobManager

void disconnectFromJobManager(InstanceID instanceId,
                              Exception cause)

Disconnect the task manager from the job manager.

Parameters:

instanceId - identifying the task manager

cause - of the disconnection

stopCluster

void stopCluster(ApplicationStatus applicationStatus,
                 String message)

Stop the cluster.

Parameters:

applicationStatus - to stop the cluster with

message - to deliver

requestStackTrace

CompletableFuture<StackTrace> requestStackTrace(org.apache.flink.api.common.time.Time timeout)

Request the stack trace from the task manager.

Parameters:

timeout - for the stack trace request

Returns:

Future for a stack trace

requestStackTraceSample

CompletableFuture<StackTraceSampleResponse> requestStackTraceSample(ExecutionAttemptID executionAttemptID,
                                                                    int sampleId,
                                                                    int numSamples,
                                                                    org.apache.flink.api.common.time.Time delayBetweenSamples,
                                                                    int maxStackTraceDepth,
                                                                    org.apache.flink.api.common.time.Time timeout)

Request a stack trace sample from the given task.

Parameters:

executionAttemptID - identifying the task to sample

sampleId - of the sample

numSamples - to take from the given task

delayBetweenSamples - to wait for

maxStackTraceDepth - of the returned sample

timeout - of the request

Returns:

Future of stack trace sample response

submitTask

CompletableFuture<Acknowledge> submitTask(TaskDeploymentDescriptor tdd,
                                          org.apache.flink.api.common.time.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

stopTask

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

Stop the given task.

Parameters:

executionAttemptID - identifying the task

timeout - of the submit operation

Returns:

Future acknowledge if the task is successfully stopped

cancelTask

CompletableFuture<Acknowledge> cancelTask(ExecutionAttemptID executionAttemptID,
                                          org.apache.flink.api.common.time.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,
                                                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 - of the submit operation

Returns:

Future acknowledge if the partitions have been successfully updated

failPartition

void failPartition(ExecutionAttemptID executionAttemptID)

Fail all intermediate result partitions of the given task.

Parameters:

executionAttemptID - identifying the task

notifyCheckpointComplete

void notifyCheckpointComplete(ExecutionAttemptID executionAttemptID,
                              org.apache.flink.api.common.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,
                       org.apache.flink.api.common.JobID jobId,
                       long checkpointId,
                       long timestamp,
                       CheckpointOptions checkpointOptions)

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

requestTaskManagerLog

CompletableFuture<TransientBlobKey> requestTaskManagerLog(org.apache.flink.api.common.time.Time timeout)

Request the task manager log from the task manager.

Parameters:

timeout - for the request

Returns:

Future blob key under which the task manager log has been stored

requestTaskManagerStdout

CompletableFuture<TransientBlobKey> requestTaskManagerStdout(org.apache.flink.api.common.time.Time timeout)

Request the task manager stdout from the task manager.

Parameters:

timeout - for the request

Returns:

Future blob key under which the task manager stdout file has been stored

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