org.apache.flink.client.program

Interface ClusterClient<T>

Type Parameters:

T - type of the cluster id

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

MiniClusterClient, RestClusterClient

public interface ClusterClient<T>
extends AutoCloseable

Encapsulates the functionality necessary to submit a program to a remote cluster.

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.
default CompletableFuture<Map<String,Object>>	getAccumulators(org.apache.flink.api.common.JobID jobID) Requests and returns the accumulators for the given job identifier.
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.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) Request 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.
void	shutDownCluster() Shut down the cluster that this client communicate with.
CompletableFuture<String>	stopWithSavepoint(org.apache.flink.api.common.JobID jobId, boolean advanceToEndOfEventTime, 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.

Method Detail

close

void close()

Specified by:

close in interface AutoCloseable

getClusterId

T getClusterId()

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

Returns:

cluster id of the connected cluster

getFlinkConfiguration

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

Return the Flink configuration object.

Returns:

The Flink configuration object

shutDownCluster

void shutDownCluster()

Shut down the cluster that this client communicate with.

getWebInterfaceURL

String getWebInterfaceURL()

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

listJobs

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

Lists the currently running and finished jobs on the cluster.

Returns:

future collection of running and finished jobs

Throws:

Exception - if no connection to the cluster could be established

disposeSavepoint

CompletableFuture<org.apache.flink.runtime.messages.Acknowledge> disposeSavepoint(String savepointPath)
                                                                           throws org.apache.flink.util.FlinkException

Dispose the savepoint under the given path.

Parameters:

savepointPath - path to the savepoint to be disposed

Returns:

acknowledge future of the dispose action

Throws:

org.apache.flink.util.FlinkException

submitJob

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

Submit the given JobGraph to the cluster.

Parameters:

jobGraph - to submit

Returns:

JobID of the submitted job

getJobStatus

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.

requestJobResult

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

Request the JobResult for the given JobID.

Parameters:

jobId - for which to request the JobResult

Returns:

Future which is completed with the JobResult

getAccumulators

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

Requests and returns the accumulators for the given job identifier. Accumulators can be requested while a is running or after it has finished. The default class loader is used to deserialize the incoming accumulator results.

Parameters:

jobID - The job identifier of a job.

Returns:

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

getAccumulators

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

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

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.

cancel

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

Cancels a job identified by the job id.

Parameters:

jobId - the job id

cancelWithSavepoint

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

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

Parameters:

jobId - the job id

savepointDirectory - directory the savepoint should be written to

Returns:

future of path where the savepoint is located

stopWithSavepoint

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

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.

Parameters:

jobId - the job ID of the streaming program to stop

advanceToEndOfEventTime - 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

triggerSavepoint

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

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.

Parameters:

jobId - job id

savepointDirectory - directory the savepoint should be written to

Returns:

path future where the savepoint is located

sendCoordinationRequest

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.

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