org.apache.flink.runtime.dispatcher

Interface DispatcherGateway

All Superinterfaces:

org.apache.flink.runtime.rpc.FencedRpcGateway<DispatcherId>, RestfulGateway, org.apache.flink.runtime.rpc.RpcGateway

All Known Implementing Classes:

Dispatcher, MiniDispatcher, StandaloneDispatcher

public interface DispatcherGateway
extends org.apache.flink.runtime.rpc.FencedRpcGateway<DispatcherId>, RestfulGateway

Gateway for the Dispatcher component.

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Integer>	getBlobServerPort(org.apache.flink.api.common.time.Time timeout) Returns the port of the blob server.
CompletableFuture<Collection<org.apache.flink.api.common.JobID>>	listJobs(org.apache.flink.api.common.time.Time timeout) List the current set of submitted jobs.
default CompletableFuture<Acknowledge>	shutDownCluster(ApplicationStatus applicationStatus)
default CompletableFuture<String>	stopWithSavepointAndGetLocation(org.apache.flink.api.common.JobID jobId, String targetDirectory, org.apache.flink.core.execution.SavepointFormatType formatType, TriggerSavepointMode savepointMode, org.apache.flink.api.common.time.Time timeout) Stops the job with a savepoint, returning a future that completes with the savepoint location when the savepoint is completed.
CompletableFuture<Acknowledge>	submitFailedJob(org.apache.flink.api.common.JobID jobId, String jobName, Throwable exception)
CompletableFuture<Acknowledge>	submitJob(JobGraph jobGraph, org.apache.flink.api.common.time.Time timeout) Submit a job to the dispatcher.
default CompletableFuture<String>	triggerCheckpoint(org.apache.flink.api.common.JobID jobID, org.apache.flink.api.common.time.Time timeout)
default CompletableFuture<String>	triggerSavepointAndGetLocation(org.apache.flink.api.common.JobID jobId, String targetDirectory, org.apache.flink.core.execution.SavepointFormatType formatType, TriggerSavepointMode savepointMode, org.apache.flink.api.common.time.Time timeout) Triggers a savepoint with the given savepoint directory as a target, returning a future that completes with the savepoint location when it is complete.

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

getFencingToken

Methods inherited from interface org.apache.flink.runtime.webmonitor.RestfulGateway

cancelJob, deliverCoordinationRequestToCoordinator, disposeSavepoint, getTriggeredSavepointStatus, requestClusterOverview, requestExecutionGraphInfo, requestJob, requestJobResult, requestJobStatus, requestMetricQueryServiceAddresses, requestMultipleJobDetails, requestTaskManagerMetricQueryServiceAddresses, requestThreadDump, shutDownCluster, stopWithSavepoint, triggerSavepoint

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

getAddress, getHostname

Method Detail

submitJob

CompletableFuture<Acknowledge> submitJob(JobGraph jobGraph,
                                         org.apache.flink.api.common.time.Time timeout)

Submit a job to the dispatcher.

Parameters:

jobGraph - JobGraph to submit

timeout - RPC timeout

Returns:

A future acknowledge if the submission succeeded

submitFailedJob

CompletableFuture<Acknowledge> submitFailedJob(org.apache.flink.api.common.JobID jobId,
                                               String jobName,
                                               Throwable exception)

listJobs

CompletableFuture<Collection<org.apache.flink.api.common.JobID>> listJobs(org.apache.flink.api.common.time.Time timeout)

List the current set of submitted jobs.

Parameters:

timeout - RPC timeout

Returns:

A future collection of currently submitted jobs

getBlobServerPort

CompletableFuture<Integer> getBlobServerPort(org.apache.flink.api.common.time.Time timeout)

Returns the port of the blob server.

Parameters:

timeout - of the operation

Returns:

A future integer of the blob server port

shutDownCluster

default CompletableFuture<Acknowledge> shutDownCluster(ApplicationStatus applicationStatus)

triggerCheckpoint

default CompletableFuture<String> triggerCheckpoint(org.apache.flink.api.common.JobID jobID,
                                                    org.apache.flink.api.common.time.Time timeout)

triggerSavepointAndGetLocation

default CompletableFuture<String> triggerSavepointAndGetLocation(org.apache.flink.api.common.JobID jobId,
                                                                 String targetDirectory,
                                                                 org.apache.flink.core.execution.SavepointFormatType formatType,
                                                                 TriggerSavepointMode savepointMode,
                                                                 org.apache.flink.api.common.time.Time timeout)

Triggers a savepoint with the given savepoint directory as a target, returning a future that completes with the savepoint location when it is complete.

Parameters:

jobId - the job id

targetDirectory - Target directory for the savepoint.

formatType - Binary format of the savepoint.

savepointMode - context of the savepoint operation

timeout - Timeout for the asynchronous operation

Returns:

Future which is completed once the operation is triggered successfully

stopWithSavepointAndGetLocation

default CompletableFuture<String> stopWithSavepointAndGetLocation(org.apache.flink.api.common.JobID jobId,
                                                                  String targetDirectory,
                                                                  org.apache.flink.core.execution.SavepointFormatType formatType,
                                                                  TriggerSavepointMode savepointMode,
                                                                  org.apache.flink.api.common.time.Time timeout)

Stops the job with a savepoint, returning a future that completes with the savepoint location when the savepoint is completed.

Parameters:

jobId - the job id

targetDirectory - Target directory for the savepoint.

savepointMode - context of the savepoint operation

timeout - for the rpc call

Returns:

Future which is completed with the savepoint location once it is completed