org.apache.flink.runtime.akka

Class AkkaJobManagerGateway

java.lang.Object

org.apache.flink.runtime.akka.AkkaJobManagerGateway

All Implemented Interfaces:

JobManagerGateway, RpcGateway, RestfulGateway

public class AkkaJobManagerGateway
extends Object
implements JobManagerGateway

Implementation of the JobManagerGateway for old JobManager code based on Akka actors and the ActorGateway.

Constructor Summary

Constructors

Constructor and Description
AkkaJobManagerGateway(ActorGateway jobManagerGateway)

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.
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<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<ClusterOverview>	requestClusterOverview(org.apache.flink.api.common.time.Time timeout) Requests the cluster status overview.
CompletableFuture<AccessExecutionGraph>	requestJob(org.apache.flink.api.common.JobID jobId, org.apache.flink.api.common.time.Time timeout) Requests the AccessExecutionGraph for the given jobId.
CompletableFuture<JobResult>	requestJobResult(org.apache.flink.api.common.JobID jobId, org.apache.flink.api.common.time.Time timeout) Requests the JobResult of a job specified by the given jobId.
CompletableFuture<JobIdsWithStatusOverview>	requestJobsOverview(org.apache.flink.api.common.time.Time timeout) Requests the job overview from the JobManager.
CompletableFuture<Collection<String>>	requestMetricQueryServicePaths(org.apache.flink.api.common.time.Time timeout) Requests the paths for the MetricQueryService to query.
CompletableFuture<MultipleJobsDetails>	requestMultipleJobDetails(org.apache.flink.api.common.time.Time timeout) Requests job details currently being executed on the Flink cluster.
CompletableFuture<String>	requestRestAddress(org.apache.flink.api.common.time.Time timeout) Requests the REST address of this RpcEndpoint.
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<Collection<org.apache.flink.api.java.tuple.Tuple2<ResourceID,String>>>	requestTaskManagerMetricQueryServicePaths(org.apache.flink.api.common.time.Time timeout) Requests the paths for the TaskManager's MetricQueryService to query.
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 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

disposeSavepoint, requestJobStatus, requestOperatorBackPressureStats, rescaleJob, shutDownCluster, triggerSavepoint

Constructor Detail

AkkaJobManagerGateway

public AkkaJobManagerGateway(ActorGateway jobManagerGateway)

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

requestBlobServerPort

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

Description copied from interface: JobManagerGateway

Requests the BlobServer port.

Specified by:

requestBlobServerPort in interface JobManagerGateway

Parameters:

timeout - for this operation

Returns:

Future containing the BlobServer port

submitJob

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

Description copied from interface: JobManagerGateway

Submits a job to the JobManager.

Specified by:

submitJob in interface JobManagerGateway

Parameters:

jobGraph - to submit

listeningBehaviour - of the client

timeout - for this operation

Returns:

Future containing an Acknowledge message if the submission succeeded

cancelJobWithSavepoint

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

Description copied from interface: JobManagerGateway

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.

Specified by:

cancelJobWithSavepoint in interface JobManagerGateway

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

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

Description copied from interface: JobManagerGateway

Cancels the given job.

Specified by:

cancelJob in interface JobManagerGateway

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

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

Description copied from interface: JobManagerGateway

Stops the given job.

Specified by:

stopJob in interface JobManagerGateway

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

requestTaskManagerInstance

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

Description copied from interface: JobManagerGateway

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

Specified by:

requestTaskManagerInstance in interface JobManagerGateway

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

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

Description copied from interface: JobManagerGateway

Requests all currently registered TaskManager instances from the JobManager.

Specified by:

requestTaskManagerInstances in interface JobManagerGateway

Parameters:

timeout - for the asynchronous operation

Returns:

Future containing the collection of all currently registered TaskManager instances

requestClassloadingProps

public 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)

Description copied from interface: JobManagerGateway

Requests the class loading properties for the given JobID.

Specified by:

requestClassloadingProps in interface JobManagerGateway

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.

requestMultipleJobDetails

public CompletableFuture<MultipleJobsDetails> requestMultipleJobDetails(org.apache.flink.api.common.time.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

requestJob

public CompletableFuture<AccessExecutionGraph> requestJob(org.apache.flink.api.common.JobID jobId,
                                                          org.apache.flink.api.common.time.Time timeout)

Description copied from interface: RestfulGateway

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

Specified by:

requestJob in interface RestfulGateway

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

requestJobResult

public CompletableFuture<JobResult> requestJobResult(org.apache.flink.api.common.JobID jobId,
                                                     org.apache.flink.api.common.time.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

requestClusterOverview

public CompletableFuture<ClusterOverview> requestClusterOverview(org.apache.flink.api.common.time.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

requestMetricQueryServicePaths

public CompletableFuture<Collection<String>> requestMetricQueryServicePaths(org.apache.flink.api.common.time.Time timeout)

Description copied from interface: RestfulGateway

Requests the paths for the MetricQueryService to query.

Specified by:

requestMetricQueryServicePaths in interface RestfulGateway

Parameters:

timeout - for the asynchronous operation

Returns:

Future containing the collection of metric query service paths to query

requestTaskManagerMetricQueryServicePaths

public CompletableFuture<Collection<org.apache.flink.api.java.tuple.Tuple2<ResourceID,String>>> requestTaskManagerMetricQueryServicePaths(org.apache.flink.api.common.time.Time timeout)

Description copied from interface: RestfulGateway

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

Specified by:

requestTaskManagerMetricQueryServicePaths in interface RestfulGateway

Parameters:

timeout - for the asynchronous operation

Returns:

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

requestJobsOverview

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

Description copied from interface: JobManagerGateway

Requests the job overview from the JobManager.

Specified by:

requestJobsOverview in interface JobManagerGateway

Parameters:

timeout - for the asynchronous operation

Returns:

Future containing the job overview

requestRestAddress

public CompletableFuture<String> requestRestAddress(org.apache.flink.api.common.time.Time timeout)

Description copied from interface: RestfulGateway

Requests the REST address of this RpcEndpoint.

Specified by:

requestRestAddress in interface RestfulGateway

Parameters:

timeout - for this operation

Returns:

Future REST endpoint address