org.apache.flink.runtime.jobmaster

Interface JobManagerGateway

All Superinterfaces:

RestfulGateway, RpcGateway

All Known Implementing Classes:

AkkaJobManagerGateway

public interface JobManagerGateway
extends RestfulGateway

Public JobManager gateway.

This interface constitutes the operations an external component can trigger on the JobManager.

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) Cancels the given job.
CompletableFuture<String>	cancelJobWithSavepoint(org.apache.flink.api.common.JobID jobId, String savepointPath, org.apache.flink.api.common.time.Time timeout) Cancels the given job after taking a savepoint and returning its path.
CompletableFuture<Integer>	requestBlobServerPort(org.apache.flink.api.common.time.Time timeout) Requests the BlobServer port.
CompletableFuture<Optional<org.apache.flink.runtime.messages.JobManagerMessages.ClassloadingProps>>	requestClassloadingProps(org.apache.flink.api.common.JobID jobId, org.apache.flink.api.common.time.Time timeout) Requests the class loading properties for the given JobID.
CompletableFuture<JobIdsWithStatusOverview>	requestJobsOverview(org.apache.flink.api.common.time.Time timeout) Requests the job overview from the JobManager.
CompletableFuture<Optional<Instance>>	requestTaskManagerInstance(ResourceID resourceId, org.apache.flink.api.common.time.Time timeout) Requests the TaskManager instance registered under the given instanceId from the JobManager.
CompletableFuture<Collection<Instance>>	requestTaskManagerInstances(org.apache.flink.api.common.time.Time timeout) Requests all currently registered TaskManager instances from the JobManager.
CompletableFuture<Acknowledge>	stopJob(org.apache.flink.api.common.JobID jobId, org.apache.flink.api.common.time.Time timeout) Stops the given job.
CompletableFuture<Acknowledge>	submitJob(JobGraph jobGraph, ListeningBehaviour listeningBehaviour, org.apache.flink.api.common.time.Time timeout) Submits a job to the JobManager.

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

disposeSavepoint, requestClusterOverview, requestJob, requestJobResult, requestJobStatus, requestMetricQueryServicePaths, requestMultipleJobDetails, requestOperatorBackPressureStats, requestRestAddress, requestTaskManagerMetricQueryServicePaths, rescaleJob, shutDownCluster, triggerSavepoint

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

getAddress, getHostname

Method Detail

requestBlobServerPort

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

Requests the BlobServer port.

Parameters:

timeout - for this operation

Returns:

Future containing the BlobServer port

submitJob

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

Submits a job to the JobManager.

Parameters:

jobGraph - to submit

listeningBehaviour - of the client

timeout - for this operation

Returns:

Future containing an Acknowledge message if the submission succeeded

cancelJobWithSavepoint

CompletableFuture<String> cancelJobWithSavepoint(org.apache.flink.api.common.JobID jobId,
                                                 @Nullable
                                                 String savepointPath,
                                                 org.apache.flink.api.common.time.Time timeout)

Cancels the given job after taking a savepoint and returning its path. If the savepointPath is null, then the JobManager will use the default savepoint directory to store the savepoint in. After the savepoint has been taken and the job has been canceled successfully, the path of the savepoint is returned.

Parameters:

jobId - identifying the job to cancel

savepointPath - Optional path for the savepoint to be stored under; if null, then the default path is taken

timeout - for the asynchronous operation

Returns:

Future containing the savepoint path of the taken savepoint or an Exception if the operation failed

cancelJob

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

Cancels the given job.

Specified by:

cancelJob in interface RestfulGateway

Parameters:

jobId - identifying the job to cancel

timeout - for the asynchronous operation

Returns:

Future containing Acknowledge or an Exception if the operation failed

stopJob

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

Stops the given job.

Specified by:

stopJob in interface RestfulGateway

Parameters:

jobId - identifying the job to cancel

timeout - for the asynchronous operation

Returns:

Future containing Acknowledge or an Exception if the operation failed

requestClassloadingProps

CompletableFuture<Optional<org.apache.flink.runtime.messages.JobManagerMessages.ClassloadingProps>> requestClassloadingProps(org.apache.flink.api.common.JobID jobId,
                                                                                                                             org.apache.flink.api.common.time.Time timeout)

Requests the class loading properties for the given JobID.

Parameters:

jobId - for which the class loading properties are requested

timeout - for this operation

Returns:

Future containing the optional class loading properties if they could be retrieved from the JobManager.

requestTaskManagerInstance

CompletableFuture<Optional<Instance>> requestTaskManagerInstance(ResourceID resourceId,
                                                                 org.apache.flink.api.common.time.Time timeout)

Requests the TaskManager instance registered under the given instanceId from the JobManager. If there is no Instance registered, then Optional.empty() is returned.

Parameters:

resourceId - identifying the TaskManager which shall be retrieved

timeout - for the asynchronous operation

Returns:

Future containing the TaskManager instance registered under instanceId, otherwise Optional.empty()

requestTaskManagerInstances

CompletableFuture<Collection<Instance>> requestTaskManagerInstances(org.apache.flink.api.common.time.Time timeout)

Requests all currently registered TaskManager instances from the JobManager.

Parameters:

timeout - for the asynchronous operation

Returns:

Future containing the collection of all currently registered TaskManager instances

requestJobsOverview

CompletableFuture<JobIdsWithStatusOverview> requestJobsOverview(org.apache.flink.api.common.time.Time timeout)

Requests the job overview from the JobManager.

Parameters:

timeout - for the asynchronous operation

Returns:

Future containing the job overview