org.apache.flink.runtime.webmonitor

Interface RestfulGateway

All Superinterfaces:

RpcGateway

All Known Subinterfaces:

DispatcherGateway

All Known Implementing Classes:

Dispatcher, MiniDispatcher, StandaloneDispatcher

public interface RestfulGateway
extends RpcGateway

Gateway for restful endpoints.

Gateways which implement this method run a REST endpoint which is reachable under the returned address.

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Acknowledge>	cancelJob(JobID jobId, Time timeout) Cancel the given job.
default CompletableFuture<CoordinationResponse>	deliverCoordinationRequestToCoordinator(JobID jobId, OperatorID operatorId, SerializedValue<CoordinationRequest> serializedRequest, Time timeout) Deliver a coordination request to a specified coordinator and return the response.
default CompletableFuture<Acknowledge>	disposeSavepoint(String savepointPath, Time timeout) Dispose the given savepoint.
CompletableFuture<ClusterOverview>	requestClusterOverview(Time timeout) Requests the cluster status overview.
CompletableFuture<ArchivedExecutionGraph>	requestJob(JobID jobId, Time timeout) Requests the ArchivedExecutionGraph for the given jobId.
CompletableFuture<JobResult>	requestJobResult(JobID jobId, Time timeout) Requests the JobResult of a job specified by the given jobId.
default CompletableFuture<JobStatus>	requestJobStatus(JobID jobId, Time timeout) Request the JobStatus of the given job.
CompletableFuture<Collection<String>>	requestMetricQueryServiceAddresses(Time timeout) Requests the addresses of the MetricQueryService to query.
CompletableFuture<MultipleJobsDetails>	requestMultipleJobDetails(Time timeout) Requests job details currently being executed on the Flink cluster.
default CompletableFuture<OperatorBackPressureStatsResponse>	requestOperatorBackPressureStats(JobID jobId, JobVertexID jobVertexId) Requests the statistics on operator back pressure.
CompletableFuture<Collection<Tuple2<ResourceID,String>>>	requestTaskManagerMetricQueryServiceAddresses(Time timeout) Requests the addresses for the TaskManagers' MetricQueryService to query.
default CompletableFuture<Acknowledge>	shutDownCluster()
default CompletableFuture<String>	stopWithSavepoint(JobID jobId, String targetDirectory, boolean terminate, Time timeout) Stops the job with a savepoint.
default CompletableFuture<String>	triggerSavepoint(JobID jobId, String targetDirectory, boolean cancelJob, Time timeout) Triggers a savepoint with the given savepoint directory as a target.

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

getAddress, getHostname

Method Detail

cancelJob

CompletableFuture<Acknowledge> cancelJob(JobID jobId,
                                         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

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.

Parameters:

jobId - identifying the job whose ArchivedExecutionGraph is requested

timeout - for the asynchronous operation

Returns:

Future containing the ArchivedExecutionGraph for the given jobId, otherwise FlinkJobNotFoundException

requestJobResult

CompletableFuture<JobResult> requestJobResult(JobID jobId,
                                              Time timeout)

Requests the JobResult of a job specified by the given jobId.

Parameters:

jobId - identifying the job for which to retrieve the JobResult.

timeout - for the asynchronous operation

Returns:

Future which is completed with the job's JobResult once the job has finished

requestMultipleJobDetails

CompletableFuture<MultipleJobsDetails> requestMultipleJobDetails(Time timeout)

Requests job details currently being executed on the Flink cluster.

Parameters:

timeout - for the asynchronous operation

Returns:

Future containing the job details

requestClusterOverview

CompletableFuture<ClusterOverview> requestClusterOverview(Time timeout)

Requests the cluster status overview.

Parameters:

timeout - for the asynchronous operation

Returns:

Future containing the status overview

requestMetricQueryServiceAddresses

CompletableFuture<Collection<String>> requestMetricQueryServiceAddresses(Time timeout)

Requests the addresses of the MetricQueryService to query.

Parameters:

timeout - for the asynchronous operation

Returns:

Future containing the collection of metric query service addresses to query

requestTaskManagerMetricQueryServiceAddresses

CompletableFuture<Collection<Tuple2<ResourceID,String>>> requestTaskManagerMetricQueryServiceAddresses(Time timeout)

Requests the addresses for the TaskManagers' MetricQueryService to query.

Parameters:

timeout - for the asynchronous operation

Returns:

Future containing the collection of instance ids and the corresponding metric query service address

triggerSavepoint

default CompletableFuture<String> triggerSavepoint(JobID jobId,
                                                   String targetDirectory,
                                                   boolean cancelJob,
                                                   Time timeout)

Triggers a savepoint with the given savepoint directory as a target.

Parameters:

jobId - ID of the job for which the savepoint should be triggered.

targetDirectory - Target directory for the savepoint.

timeout - Timeout for the asynchronous operation

Returns:

A future to the external pointer of the savepoint.

stopWithSavepoint

default CompletableFuture<String> stopWithSavepoint(JobID jobId,
                                                    String targetDirectory,
                                                    boolean terminate,
                                                    Time timeout)

Stops the job with a savepoint.

Parameters:

jobId - ID of the job for which the savepoint should be triggered.

targetDirectory - to which to write the savepoint data or null if the default savepoint directory should be used

terminate - flag indicating if the job should terminate or just suspend

timeout - for the rpc call

Returns:

Future which is completed with the savepoint path once completed

disposeSavepoint

default CompletableFuture<Acknowledge> disposeSavepoint(String savepointPath,
                                                        Time timeout)

Dispose the given savepoint.

Parameters:

savepointPath - identifying the savepoint to dispose

timeout - RPC timeout

Returns:

A future acknowledge if the disposal succeeded

requestJobStatus

default CompletableFuture<JobStatus> requestJobStatus(JobID jobId,
                                                      Time timeout)

Request the JobStatus of the given job.

Parameters:

jobId - identifying the job for which to retrieve the JobStatus

timeout - for the asynchronous operation

Returns:

A future to the JobStatus of the given job

requestOperatorBackPressureStats

default CompletableFuture<OperatorBackPressureStatsResponse> requestOperatorBackPressureStats(JobID jobId,
                                                                                              JobVertexID jobVertexId)

Requests the statistics on operator back pressure.

Parameters:

jobId - Job for which the stats are requested.

jobVertexId - JobVertex for which the stats are requested.

Returns:

A Future to the OperatorBackPressureStatsResponse.

shutDownCluster

default CompletableFuture<Acknowledge> shutDownCluster()

deliverCoordinationRequestToCoordinator

default CompletableFuture<CoordinationResponse> deliverCoordinationRequestToCoordinator(JobID jobId,
                                                                                        OperatorID operatorId,
                                                                                        SerializedValue<CoordinationRequest> serializedRequest,
                                                                                        Time timeout)

Deliver a coordination request to a specified coordinator and return the response.

Parameters:

jobId - identifying the job which the coordinator belongs to

operatorId - identifying the coordinator to receive the request

serializedRequest - serialized request to deliver

timeout - RPC timeout

Returns:

A future containing the response. The response will fail with a FlinkException if the task is not running, or no operator/coordinator exists for the given ID, or the coordinator cannot handle client events.