org.apache.flink.client.program.rest

类 RestClusterClient<T>

java.lang.Object

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

所有已实现的接口:

AutoCloseable, ClusterClient<T>

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

A ClusterClient implementation that communicates via HTTP REST requests.

构造器概要

构造器

构造器和说明
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)

方法概要

限定符和类型	方法和说明
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.
<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.

从类继承的方法 java.lang.Object

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

从接口继承的方法 org.apache.flink.client.program.ClusterClient

getAccumulators

构造器详细资料

RestClusterClient

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

抛出:

Exception

RestClusterClient

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

抛出:

Exception

方法详细资料

getFlinkConfiguration

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

从接口复制的说明: ClusterClient

Return the Flink configuration object.

指定者:

getFlinkConfiguration 在接口中 ClusterClient<T>

返回:

The Flink configuration object

close

public void close()

指定者:

close 在接口中 AutoCloseable

指定者:

close 在接口中 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.

参数:

jobId - The job id

返回:

Job details

getJobStatus

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

从接口复制的说明: ClusterClient

Requests the JobStatus of the job with the given JobID.

指定者:

getJobStatus 在接口中 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.

指定者:

requestJobResult 在接口中 ClusterClient<T>

参数:

jobId - specifying the job for which to retrieve the JobResult

返回:

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)

从接口复制的说明: ClusterClient

Submit the given JobGraph to the cluster.

指定者:

submitJob 在接口中 ClusterClient<T>

参数:

jobGraph - to submit

返回:

JobID of the submitted job

cancel

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

从接口复制的说明: ClusterClient

Cancels a job identified by the job id.

指定者:

cancel 在接口中 ClusterClient<T>

参数:

jobID - the job id

stopWithSavepoint

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

从接口复制的说明: 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.

指定者:

stopWithSavepoint 在接口中 ClusterClient<T>

参数:

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

返回:

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)

从接口复制的说明: ClusterClient

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

指定者:

cancelWithSavepoint 在接口中 ClusterClient<T>

参数:

jobId - the job id

savepointDirectory - directory the savepoint should be written to

返回:

future of path where the savepoint is located

triggerSavepoint

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

从接口复制的说明: 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.

指定者:

triggerSavepoint 在接口中 ClusterClient<T>

参数:

jobId - job id

savepointDirectory - directory the savepoint should be written to

返回:

path future where the savepoint is located

getAccumulators

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

从接口复制的说明: ClusterClient

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

指定者:

getAccumulators 在接口中 ClusterClient<T>

参数:

jobID - The job identifier of a job.

loader - The class loader for deserializing the accumulator results.

返回:

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

listJobs

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

从接口复制的说明: ClusterClient

Lists the currently running and finished jobs on the cluster.

指定者:

listJobs 在接口中 ClusterClient<T>

返回:

future collection of running and finished jobs

getClusterId

public T getClusterId()

从接口复制的说明: ClusterClient

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

指定者:

getClusterId 在接口中 ClusterClient<T>

返回:

cluster id of the connected cluster

disposeSavepoint

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

从接口复制的说明: ClusterClient

Dispose the savepoint under the given path.

指定者:

disposeSavepoint 在接口中 ClusterClient<T>

参数:

savepointPath - path to the savepoint to be disposed

返回:

acknowledge future of the dispose action

shutDownCluster

public void shutDownCluster()

从接口复制的说明: ClusterClient

Shut down the cluster that this client communicate with.

指定者:

shutDownCluster 在接口中 ClusterClient<T>

getWebInterfaceURL

public String getWebInterfaceURL()

从接口复制的说明: ClusterClient

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

指定者:

getWebInterfaceURL 在接口中 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)