org.apache.flink.runtime.dispatcher

Interface DispatcherGateway

All Superinterfaces:

FencedRpcGateway<DispatcherId>, RestfulGateway, RpcGateway

All Known Implementing Classes:

Dispatcher, MiniDispatcher, StandaloneDispatcher

public interface DispatcherGateway
extends FencedRpcGateway<DispatcherId>, RestfulGateway

Gateway for the Dispatcher component.

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Integer>	getBlobServerPort(Time timeout) Returns the port of the blob server.
CompletableFuture<Collection<JobID>>	listJobs(Time timeout) List the current set of submitted jobs.
CompletableFuture<ArchivedExecutionGraph>	requestJob(JobID jobId, Time timeout) Requests the ArchivedExecutionGraph for the given jobId.
default CompletableFuture<Acknowledge>	shutDownCluster(ApplicationStatus applicationStatus)
CompletableFuture<Acknowledge>	submitJob(JobGraph jobGraph, Time timeout) Submit a job to the dispatcher.

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

getFencingToken

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

cancelJob, deliverCoordinationRequestToCoordinator, disposeSavepoint, requestClusterOverview, requestJobResult, requestJobStatus, requestMetricQueryServiceAddresses, requestMultipleJobDetails, requestOperatorBackPressureStats, requestTaskManagerMetricQueryServiceAddresses, shutDownCluster, stopWithSavepoint, triggerSavepoint

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

getAddress, getHostname

Method Detail

submitJob

CompletableFuture<Acknowledge> submitJob(JobGraph jobGraph,
                                         Time timeout)

Submit a job to the dispatcher.

Parameters:

jobGraph - JobGraph to submit

timeout - RPC timeout

Returns:

A future acknowledge if the submission succeeded

listJobs

CompletableFuture<Collection<JobID>> listJobs(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(Time timeout)

Returns the port of the blob server.

Parameters:

timeout - of the operation

Returns:

A future integer of the blob server port

requestJob

CompletableFuture<ArchivedExecutionGraph> requestJob(JobID jobId,
                                                     Time timeout)

Requests the ArchivedExecutionGraph for the given jobId. If there is no such graph, then the future is completed with a FlinkJobNotFoundException.

Note: We enforce that the returned future contains a ArchivedExecutionGraph unlike the super interface.

Specified by:

requestJob in interface RestfulGateway

Parameters:

jobId - identifying the job whose AccessExecutionGraph is requested

timeout - for the asynchronous operation

Returns:

Future containing the AccessExecutionGraph for the given jobId, otherwise FlinkJobNotFoundException

shutDownCluster

default CompletableFuture<Acknowledge> shutDownCluster(ApplicationStatus applicationStatus)