org.apache.flink.client.program.rest

Class RestClusterClient<T>

java.lang.Object

org.apache.flink.client.program.rest.RestClusterClient<T>

All Implemented Interfaces:

AutoCloseable, ClusterClient<T>

public class RestClusterClient<T>
extends Object
implements ClusterClient<T>

A ClusterClient implementation that communicates via HTTP REST requests.

Constructor Summary

Constructors

Constructor and Description
RestClusterClient(org.apache.flink.configuration.Configuration config, T clusterId)
RestClusterClient(org.apache.flink.configuration.Configuration config, T clusterId, org.apache.flink.runtime.highavailability.ClientHighAvailabilityServices clientHAServices)

Method Summary

Modifier and Type	Method and Description
CompletableFuture<org.apache.flink.runtime.messages.Acknowledge>	cancel(org.apache.flink.api.common.JobID jobID) Cancels a job identified by the job id.
CompletableFuture<String>	cancelWithSavepoint(org.apache.flink.api.common.JobID jobId, String savepointDirectory) Cancels a job identified by the job id and triggers a savepoint.
void	close()
CompletableFuture<org.apache.flink.runtime.messages.Acknowledge>	disposeSavepoint(String savepointPath) Dispose the savepoint under the given path.
CompletableFuture<Map<String,Object>>	getAccumulators(org.apache.flink.api.common.JobID jobID, ClassLoader loader) Requests and returns the accumulators for the given job identifier.
T	getClusterId() Returns the cluster id identifying the cluster to which the client is connected.
org.apache.flink.configuration.Configuration	getFlinkConfiguration() Return the Flink configuration object.
CompletableFuture<org.apache.flink.runtime.rest.messages.job.JobDetailsInfo>	getJobDetails(org.apache.flink.api.common.JobID jobId) Requests the job details.
CompletableFuture<org.apache.flink.api.common.JobStatus>	getJobStatus(org.apache.flink.api.common.JobID jobId) Requests the JobStatus of the job with the given JobID.
String	getWebInterfaceURL() Returns an URL (as a string) to the cluster web interface.
CompletableFuture<Collection<org.apache.flink.runtime.client.JobStatusMessage>>	listJobs() Lists the currently running and finished jobs on the cluster.
CompletableFuture<org.apache.flink.runtime.jobmaster.JobResult>	requestJobResult(org.apache.flink.api.common.JobID jobId) Requests the JobResult for the given JobID.
CompletableFuture<org.apache.flink.runtime.operators.coordination.CoordinationResponse>	sendCoordinationRequest(org.apache.flink.api.common.JobID jobId, org.apache.flink.runtime.jobgraph.OperatorID operatorId, org.apache.flink.runtime.operators.coordination.CoordinationRequest request) Sends out a request to a specified coordinator and return the response.
<M extends org.apache.flink.runtime.rest.messages.MessageHeaders<R,P,U>,U extends org.apache.flink.runtime.rest.messages.MessageParameters,R extends org.apache.flink.runtime.rest.messages.RequestBody,P extends org.apache.flink.runtime.rest.messages.ResponseBody> CompletableFuture<P>	sendRequest(M messageHeaders, U messageParameters, R request)
void	shutDownCluster() Shut down the cluster that this client communicate with.
CompletableFuture<String>	stopWithSavepoint(org.apache.flink.api.common.JobID jobId, boolean advanceToEndOfTime, String savepointDirectory) Stops a program on Flink cluster whose job-manager is configured in this client's configuration.
CompletableFuture<org.apache.flink.api.common.JobID>	submitJob(org.apache.flink.runtime.jobgraph.JobGraph jobGraph) Submit the given JobGraph to the cluster.
CompletableFuture<String>	triggerSavepoint(org.apache.flink.api.common.JobID jobId, String savepointDirectory) Triggers a savepoint for the job identified by the job id.

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.client.program.ClusterClient

getAccumulators

Constructor Detail

RestClusterClient

public RestClusterClient(org.apache.flink.configuration.Configuration config,
                         T clusterId)
                  throws Exception

Throws:

Exception

RestClusterClient

public RestClusterClient(org.apache.flink.configuration.Configuration config,
                         T clusterId,
                         org.apache.flink.runtime.highavailability.ClientHighAvailabilityServices clientHAServices)
                  throws Exception

Throws:

Exception

Method Detail

getFlinkConfiguration

public org.apache.flink.configuration.Configuration getFlinkConfiguration()

Description copied from interface: ClusterClient

Return the Flink configuration object.

Specified by:

getFlinkConfiguration in interface ClusterClient<T>

Returns:

The Flink configuration object

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface ClusterClient<T>

getJobDetails

public CompletableFuture<org.apache.flink.runtime.rest.messages.job.JobDetailsInfo> getJobDetails(org.apache.flink.api.common.JobID jobId)

Requests the job details.

Parameters:

jobId - The job id

Returns:

Job details

getJobStatus

public CompletableFuture<org.apache.flink.api.common.JobStatus> getJobStatus(org.apache.flink.api.common.JobID jobId)

Description copied from interface: ClusterClient

Requests the JobStatus of the job with the given JobID.

Specified by:

getJobStatus in interface ClusterClient<T>

requestJobResult

public CompletableFuture<org.apache.flink.runtime.jobmaster.JobResult> requestJobResult(@Nonnull
                                                                                        org.apache.flink.api.common.JobID jobId)

Requests the JobResult for the given JobID. The method retries multiple times to poll the JobResult before giving up.

Specified by:

requestJobResult in interface ClusterClient<T>

Parameters:

jobId - specifying the job for which to retrieve the JobResult

Returns:

Future which is completed with the JobResult once the job has completed or with a failure if the JobResult could not be retrieved.

submitJob

public CompletableFuture<org.apache.flink.api.common.JobID> submitJob(@Nonnull
                                                                      org.apache.flink.runtime.jobgraph.JobGraph jobGraph)

Description copied from interface: ClusterClient

Submit the given JobGraph to the cluster.

Specified by:

submitJob in interface ClusterClient<T>

Parameters:

jobGraph - to submit

Returns:

JobID of the submitted job

cancel

public CompletableFuture<org.apache.flink.runtime.messages.Acknowledge> cancel(org.apache.flink.api.common.JobID jobID)

Description copied from interface: ClusterClient

Cancels a job identified by the job id.

Specified by:

cancel in interface ClusterClient<T>

Parameters:

jobID - the job id

stopWithSavepoint

public CompletableFuture<String> stopWithSavepoint(org.apache.flink.api.common.JobID jobId,
                                                   boolean advanceToEndOfTime,
                                                   @Nullable
                                                   String savepointDirectory)

Description copied from interface: ClusterClient

Stops a program on Flink cluster whose job-manager is configured in this client's configuration. Stopping works only for streaming programs. Be aware, that the program might continue to run for a while after sending the stop command, because after sources stopped to emit data all operators need to finish processing.

Specified by:

stopWithSavepoint in interface ClusterClient<T>

Parameters:

jobId - the job ID of the streaming program to stop

advanceToEndOfTime - flag indicating if the source should inject a MAX_WATERMARK in the pipeline

savepointDirectory - directory the savepoint should be written to

Returns:

a CompletableFuture containing the path where the savepoint is located

cancelWithSavepoint

public CompletableFuture<String> cancelWithSavepoint(org.apache.flink.api.common.JobID jobId,
                                                     @Nullable
                                                     String savepointDirectory)

Description copied from interface: ClusterClient

Cancels a job identified by the job id and triggers a savepoint.

Specified by:

cancelWithSavepoint in interface ClusterClient<T>

Parameters:

jobId - the job id

savepointDirectory - directory the savepoint should be written to

Returns:

future of path where the savepoint is located

triggerSavepoint

public CompletableFuture<String> triggerSavepoint(org.apache.flink.api.common.JobID jobId,
                                                  @Nullable
                                                  String savepointDirectory)

Description copied from interface: ClusterClient

Triggers a savepoint for the job identified by the job id. The savepoint will be written to the given savepoint directory, or CheckpointingOptions.SAVEPOINT_DIRECTORY if it is null.

Specified by:

triggerSavepoint in interface ClusterClient<T>

Parameters:

jobId - job id

savepointDirectory - directory the savepoint should be written to

Returns:

path future where the savepoint is located

sendCoordinationRequest

public CompletableFuture<org.apache.flink.runtime.operators.coordination.CoordinationResponse> sendCoordinationRequest(org.apache.flink.api.common.JobID jobId,
                                                                                                                       org.apache.flink.runtime.jobgraph.OperatorID operatorId,
                                                                                                                       org.apache.flink.runtime.operators.coordination.CoordinationRequest request)

Description copied from interface: ClusterClient

Sends out a request to a specified coordinator and return the response.

Specified by:

sendCoordinationRequest in interface ClusterClient<T>

Parameters:

jobId - specifies the job which the coordinator belongs to

operatorId - specifies which coordinator to receive the request

request - the request to send

Returns:

the response from the coordinator

getAccumulators

public CompletableFuture<Map<String,Object>> getAccumulators(org.apache.flink.api.common.JobID jobID,
                                                             ClassLoader loader)

Description copied from interface: ClusterClient

Requests and returns the accumulators for the given job identifier. Accumulators can be requested while a is running or after it has finished.

Specified by:

getAccumulators in interface ClusterClient<T>

Parameters:

jobID - The job identifier of a job.

loader - The class loader for deserializing the accumulator results.

Returns:

A Map containing the accumulator's name and its value.

listJobs

public CompletableFuture<Collection<org.apache.flink.runtime.client.JobStatusMessage>> listJobs()

Description copied from interface: ClusterClient

Lists the currently running and finished jobs on the cluster.

Specified by:

listJobs in interface ClusterClient<T>

Returns:

future collection of running and finished jobs

getClusterId

public T getClusterId()

Description copied from interface: ClusterClient

Returns the cluster id identifying the cluster to which the client is connected.

Specified by:

getClusterId in interface ClusterClient<T>

Returns:

cluster id of the connected cluster

disposeSavepoint

public CompletableFuture<org.apache.flink.runtime.messages.Acknowledge> disposeSavepoint(String savepointPath)

Description copied from interface: ClusterClient

Dispose the savepoint under the given path.

Specified by:

disposeSavepoint in interface ClusterClient<T>

Parameters:

savepointPath - path to the savepoint to be disposed

Returns:

acknowledge future of the dispose action

shutDownCluster

public void shutDownCluster()

Description copied from interface: ClusterClient

Shut down the cluster that this client communicate with.

Specified by:

shutDownCluster in interface ClusterClient<T>

getWebInterfaceURL

public String getWebInterfaceURL()

Description copied from interface: ClusterClient

Returns an URL (as a string) to the cluster web interface.

Specified by:

getWebInterfaceURL in interface ClusterClient<T>

sendRequest

@VisibleForTesting
public <M extends org.apache.flink.runtime.rest.messages.MessageHeaders<R,P,U>,U extends org.apache.flink.runtime.rest.messages.MessageParameters,R extends org.apache.flink.runtime.rest.messages.RequestBody,P extends org.apache.flink.runtime.rest.messages.ResponseBody> CompletableFuture<P> sendRequest(M messageHeaders,
                                                                                                                                                                                                                                                                                                                                  U messageParameters,
                                                                                                                                                                                                                                                                                                                                  R request)