org.apache.flink.runtime.webmonitor

Interface RestfulGateway

All Superinterfaces:

RpcGateway

All Known Subinterfaces:

DispatcherGateway, JobManagerGateway

All Known Implementing Classes:

AkkaJobManagerGateway, Dispatcher, 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<ClusterOverview>	requestClusterOverview(Time timeout) Requests the cluster status overview.
CompletableFuture<AccessExecutionGraph>	requestJob(JobID jobId, Time timeout) Requests the AccessExecutionGraph for the given jobId.
CompletableFuture<MultipleJobsDetails>	requestJobDetails(boolean includeRunning, boolean includeFinished, Time timeout) Requests job details currently being executed on the Flink cluster.
CompletableFuture<Collection<String>>	requestMetricQueryServicePaths(Time timeout) Requests the paths for the MetricQueryService to query.
CompletableFuture<String>	requestRestAddress(Time timeout) Requests the REST address of this RpcEndpoint.
CompletableFuture<Collection<Tuple2<ResourceID,String>>>	requestTaskManagerMetricQueryServicePaths(Time timeout) Requests the paths for the TaskManager's MetricQueryService to query.

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

getAddress, getHostname

Method Detail

requestRestAddress

CompletableFuture<String> requestRestAddress(Time timeout)

Requests the REST address of this RpcEndpoint.

Parameters:

timeout - for this operation

Returns:

Future REST endpoint address

requestJob

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

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

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

requestJobDetails

CompletableFuture<MultipleJobsDetails> requestJobDetails(boolean includeRunning,
                                                         boolean includeFinished,
                                                         Time timeout)

Requests job details currently being executed on the Flink cluster.

Parameters:

includeRunning - true if running jobs shall be included, otherwise false

includeFinished - true if finished jobs shall be included, otherwise false

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

requestMetricQueryServicePaths

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

Requests the paths for the MetricQueryService to query.

Parameters:

timeout - for the asynchronous operation

Returns:

Future containing the collection of metric query service paths to query

requestTaskManagerMetricQueryServicePaths

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

Requests the paths for the TaskManager's MetricQueryService to query.

Parameters:

timeout - for the asynchronous operation

Returns:

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