public interface RestfulGateway extends RpcGateway
Gateways which implement this method run a REST endpoint which is reachable under the returned address.
Modifier and Type | Method and Description |
---|---|
CompletableFuture<Acknowledge> |
cancelJob(JobID jobId,
Time timeout)
Cancel the given job.
|
default CompletableFuture<Acknowledge> |
disposeSavepoint(String savepointPath,
Time timeout)
Dispose the given savepoint.
|
CompletableFuture<ClusterOverview> |
requestClusterOverview(Time timeout)
Requests the cluster status overview.
|
CompletableFuture<? extends AccessExecutionGraph> |
requestJob(JobID jobId,
Time timeout)
Requests the
AccessExecutionGraph for the given jobId. |
CompletableFuture<JobResult> |
requestJobResult(JobID jobId,
Time timeout)
Requests the
JobResult of a job specified by the given jobId. |
default CompletableFuture<JobStatus> |
requestJobStatus(JobID jobId,
Time timeout)
Request the
JobStatus of the given job. |
CompletableFuture<Collection<String>> |
requestMetricQueryServicePaths(Time timeout)
Requests the paths for the
MetricQueryService to query. |
CompletableFuture<MultipleJobsDetails> |
requestMultipleJobDetails(Time timeout)
Requests job details currently being executed on the Flink cluster.
|
default CompletableFuture<OperatorBackPressureStatsResponse> |
requestOperatorBackPressureStats(JobID jobId,
JobVertexID jobVertexId)
Requests the statistics on operator back pressure.
|
CompletableFuture<String> |
requestRestAddress(Time timeout)
Requests the REST address of this
RpcEndpoint . |
CompletableFuture<Collection<Tuple2<ResourceID,String>>> |
requestTaskManagerMetricQueryServicePaths(Time timeout)
Requests the paths for the TaskManager's
MetricQueryService to query. |
default CompletableFuture<Acknowledge> |
rescaleJob(JobID jobId,
int newParallelism,
RescalingBehaviour rescalingBehaviour,
Time timeout)
Trigger rescaling of the given job.
|
default CompletableFuture<Acknowledge> |
shutDownCluster() |
CompletableFuture<Acknowledge> |
stopJob(JobID jobId,
Time timeout)
Stop the given job.
|
default CompletableFuture<String> |
triggerSavepoint(JobID jobId,
String targetDirectory,
boolean cancelJob,
Time timeout)
Triggers a savepoint with the given savepoint directory as a target.
|
getAddress, getHostname
CompletableFuture<Acknowledge> cancelJob(JobID jobId, Time timeout)
jobId
- identifying the job to canceltimeout
- of the operationCompletableFuture<Acknowledge> stopJob(JobID jobId, Time timeout)
jobId
- identifying the job to stoptimeout
- of the operationCompletableFuture<String> requestRestAddress(Time timeout)
RpcEndpoint
.timeout
- for this operationCompletableFuture<? extends AccessExecutionGraph> requestJob(JobID jobId, Time timeout)
AccessExecutionGraph
for the given jobId. If there is no such graph, then
the future is completed with a FlinkJobNotFoundException
.jobId
- identifying the job whose AccessExecutionGraph is requestedtimeout
- for the asynchronous operationFlinkJobNotFoundException
CompletableFuture<JobResult> requestJobResult(JobID jobId, Time timeout)
JobResult
of a job specified by the given jobId.CompletableFuture<MultipleJobsDetails> requestMultipleJobDetails(Time timeout)
timeout
- for the asynchronous operationCompletableFuture<ClusterOverview> requestClusterOverview(Time timeout)
timeout
- for the asynchronous operationCompletableFuture<Collection<String>> requestMetricQueryServicePaths(Time timeout)
MetricQueryService
to query.timeout
- for the asynchronous operationCompletableFuture<Collection<Tuple2<ResourceID,String>>> requestTaskManagerMetricQueryServicePaths(Time timeout)
MetricQueryService
to query.timeout
- for the asynchronous operationdefault CompletableFuture<String> triggerSavepoint(JobID jobId, String targetDirectory, boolean cancelJob, Time timeout)
jobId
- ID of the job for which the savepoint should be triggered.targetDirectory
- Target directory for the savepoint.timeout
- Timeout for the asynchronous operationexternal pointer
of
the savepoint.default CompletableFuture<Acknowledge> disposeSavepoint(String savepointPath, Time timeout)
savepointPath
- identifying the savepoint to disposetimeout
- RPC timeoutdefault CompletableFuture<JobStatus> requestJobStatus(JobID jobId, Time timeout)
JobStatus
of the given job.jobId
- identifying the job for which to retrieve the JobStatustimeout
- for the asynchronous operationJobStatus
of the given jobdefault CompletableFuture<OperatorBackPressureStatsResponse> requestOperatorBackPressureStats(JobID jobId, JobVertexID jobVertexId)
jobId
- Job for which the stats are requested.jobVertexId
- JobVertex for which the stats are requested.OperatorBackPressureStatsResponse
or null
if the stats are
not available (yet).default CompletableFuture<Acknowledge> rescaleJob(JobID jobId, int newParallelism, RescalingBehaviour rescalingBehaviour, Time timeout)
jobId
- specifying the job to rescalenewParallelism
- new parallelism of the jobrescalingBehaviour
- defining how strict the rescaling has to be executedtimeout
- of this operationAcknowledge
once the rescaling was successfuldefault CompletableFuture<Acknowledge> shutDownCluster()
Copyright © 2014–2020 The Apache Software Foundation. All rights reserved.