org.apache.flink.runtime.dispatcher

Interface DispatcherGateway

All Superinterfaces:

FencedRpcGateway<DispatcherId>, RestfulGateway, RpcGateway

All Known Implementing Classes:

Dispatcher, StandaloneDispatcher

public interface DispatcherGateway
extends FencedRpcGateway<DispatcherId>, RestfulGateway

Gateway for the Dispatcher component.

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Acknowledge>	cancelJob(org.apache.flink.api.common.JobID jobId, org.apache.flink.api.common.time.Time timeout) Cancel the given job.
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.
CompletableFuture<Acknowledge>	stopJob(org.apache.flink.api.common.JobID jobId, org.apache.flink.api.common.time.Time timeout) Stop the given job.
CompletableFuture<Acknowledge>	submitJob(JobGraph jobGraph, org.apache.flink.api.common.time.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

requestClusterOverview, requestJob, requestJobDetails, requestMetricQueryServicePaths, requestRestAddress, requestTaskManagerMetricQueryServicePaths

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

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

cancelJob

CompletableFuture<Acknowledge> cancelJob(org.apache.flink.api.common.JobID jobId,
                                         org.apache.flink.api.common.time.Time timeout)

Cancel the given job.

Parameters:

jobId - identifying the job to cancel

timeout - of the operation

Returns:

A future acknowledge if the cancellation succeeded

stopJob

CompletableFuture<Acknowledge> stopJob(org.apache.flink.api.common.JobID jobId,
                                       org.apache.flink.api.common.time.Time timeout)

Stop the given job.

Parameters:

jobId - identifying the job to stop

timeout - of the operation

Returns:

A future acknowledge if the stopping succeeded

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