org.apache.flink.runtime.webmonitor

Class NonLeaderRetrievalRestfulGateway

java.lang.Object

org.apache.flink.runtime.webmonitor.NonLeaderRetrievalRestfulGateway

All Implemented Interfaces:

RpcGateway, RestfulGateway

public class NonLeaderRetrievalRestfulGateway
extends Object
implements RestfulGateway

* Gateway for restful endpoints without leader retrieval logic. * *

Gateways which implement this method run a REST endpoint which is reachable under the returned address, and can be used in AbstractHandler without leader retrieval logic.

Field Summary

Fields

Modifier and Type	Field and Description
static NonLeaderRetrievalRestfulGateway	INSTANCE

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Acknowledge>	cancelJob(JobID jobId, Time timeout) Cancel the given job.
String	getAddress() Returns the fully qualified address under which the associated rpc endpoint is reachable.
String	getHostname() Returns the fully qualified hostname under which the associated rpc endpoint is reachable.
CompletableFuture<ClusterOverview>	requestClusterOverview(Time timeout) Requests the cluster status overview.
CompletableFuture<ExecutionGraphInfo>	requestExecutionGraphInfo(JobID jobId, Time timeout) Requests the ExecutionGraphInfo containing additional information besides the ArchivedExecutionGraph.
CompletableFuture<JobResult>	requestJobResult(JobID jobId, Time timeout) Requests the JobResult of a job specified by the given jobId.
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.
CompletableFuture<Collection<Tuple2<ResourceID,String>>>	requestTaskManagerMetricQueryServiceAddresses(Time timeout) Requests the addresses for the TaskManagers' MetricQueryService to query.
CompletableFuture<ThreadDumpInfo>	requestThreadDump(Time timeout) Requests the thread dump from the JobManager.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

deliverCoordinationRequestToCoordinator, disposeSavepoint, getTriggeredSavepointStatus, requestJob, requestJobStatus, shutDownCluster, stopWithSavepoint, triggerSavepoint

Field Detail

INSTANCE

public static final NonLeaderRetrievalRestfulGateway INSTANCE

Method Detail

getAddress

public String getAddress()

Description copied from interface: RpcGateway

Returns the fully qualified address under which the associated rpc endpoint is reachable.

Specified by:

getAddress in interface RpcGateway

Returns:

Fully qualified (RPC) address under which the associated rpc endpoint is reachable

getHostname

public String getHostname()

Description copied from interface: RpcGateway

Returns the fully qualified hostname under which the associated rpc endpoint is reachable.

Specified by:

getHostname in interface RpcGateway

Returns:

Fully qualified hostname under which the associated rpc endpoint is reachable

cancelJob

public CompletableFuture<Acknowledge> cancelJob(JobID jobId,
                                                Time timeout)

Description copied from interface: RestfulGateway

Cancel the given job.

Specified by:

cancelJob in interface RestfulGateway

Parameters:

jobId - identifying the job to cancel

timeout - of the operation

Returns:

A future acknowledge if the cancellation succeeded

requestExecutionGraphInfo

public CompletableFuture<ExecutionGraphInfo> requestExecutionGraphInfo(JobID jobId,
                                                                       Time timeout)

Description copied from interface: RestfulGateway

Requests the ExecutionGraphInfo containing additional information besides the ArchivedExecutionGraph. If there is no such graph, then the future is completed with a FlinkJobNotFoundException.

Specified by:

requestExecutionGraphInfo in interface RestfulGateway

Parameters:

jobId - identifying the job whose ExecutionGraphInfo is requested

timeout - for the asynchronous operation

Returns:

Future containing the ExecutionGraphInfo for the given jobId, otherwise FlinkJobNotFoundException

requestJobResult

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

Description copied from interface: RestfulGateway

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

Specified by:

requestJobResult in interface RestfulGateway

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

public CompletableFuture<MultipleJobsDetails> requestMultipleJobDetails(Time timeout)

Description copied from interface: RestfulGateway

Requests job details currently being executed on the Flink cluster.

Specified by:

requestMultipleJobDetails in interface RestfulGateway

Parameters:

timeout - for the asynchronous operation

Returns:

Future containing the job details

requestClusterOverview

public CompletableFuture<ClusterOverview> requestClusterOverview(Time timeout)

Description copied from interface: RestfulGateway

Requests the cluster status overview.

Specified by:

requestClusterOverview in interface RestfulGateway

Parameters:

timeout - for the asynchronous operation

Returns:

Future containing the status overview

requestMetricQueryServiceAddresses

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

Description copied from interface: RestfulGateway

Requests the addresses of the MetricQueryService to query.

Specified by:

requestMetricQueryServiceAddresses in interface RestfulGateway

Parameters:

timeout - for the asynchronous operation

Returns:

Future containing the collection of metric query service addresses to query

requestTaskManagerMetricQueryServiceAddresses

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

Description copied from interface: RestfulGateway

Requests the addresses for the TaskManagers' MetricQueryService to query.

Specified by:

requestTaskManagerMetricQueryServiceAddresses in interface RestfulGateway

Parameters:

timeout - for the asynchronous operation

Returns:

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

requestThreadDump

public CompletableFuture<ThreadDumpInfo> requestThreadDump(Time timeout)

Description copied from interface: RestfulGateway

Requests the thread dump from the JobManager.

Specified by:

requestThreadDump in interface RestfulGateway

Parameters:

timeout - timeout of the asynchronous operation

Returns:

Future containing the thread dump information