Package cn.sliew.flinkful.rest.client.controller

Class JobController

java.lang.Object

cn.sliew.flinkful.rest.client.controller.JobController

@RestController
@RequestMapping("/flinkful/jobs")
public class JobController
extends Object

Constructor Summary

Constructors

Constructor	Description
JobController()

Method Summary

Modifier and Type	Method	Description
CompletableFuture<JobDetailsInfo>	job(String jobId)	https://nightlies.apache.org/flink/flink-docs-release-1.19/docs/ops/rest_api/#jobs-jobid
CompletableFuture<JobAccumulatorsInfo>	jobAccumulators(String jobId, Optional<Boolean> includeSerializedValue)	https://nightlies.apache.org/flink/flink-docs-release-1.19/docs/ops/rest_api/#jobs-jobid-accumulators
CompletableFuture<CheckpointStatistics>	jobCheckpointDetail(String jobId, Long checkpointId)	https://nightlies.apache.org/flink/flink-docs-release-1.19/docs/ops/rest_api/#jobs-jobid-checkpoints-details-checkpointid
CompletableFuture<CheckpointingStatistics>	jobCheckpoints(String jobId)	https://nightlies.apache.org/flink/flink-docs-release-1.19/docs/ops/rest_api/#jobs-jobid-checkpoints
CompletableFuture<CheckpointConfigInfo>	jobCheckpointsConfig(String jobId)	https://nightlies.apache.org/flink/flink-docs-release-1.19/docs/ops/rest_api/#jobs-jobid-checkpoints-config
CompletableFuture<TaskCheckpointStatisticsWithSubtaskDetails>	jobCheckpointSubtaskDetail(String jobId, Long checkpointId, String vertexId)	https://nightlies.apache.org/flink/flink-docs-release-1.19/docs/ops/rest_api/#jobs-jobid-checkpoints-details-checkpointid-subtasks-vertexid
CompletableFuture<JobConfigInfo>	jobConfig(String jobId)	https://nightlies.apache.org/flink/flink-docs-release-1.19/docs/ops/rest_api/#jobs-jobid-config
CompletableFuture<JobExceptionsInfoWithHistory>	jobExceptions(String jobId, Optional<String> maxExceptions)	https://nightlies.apache.org/flink/flink-docs-release-1.19/docs/ops/rest_api/#jobs-jobid-exceptions
CompletableFuture<JobExecutionResultResponseBody>	jobExecutionResult(String jobId)	https://nightlies.apache.org/flink/flink-docs-release-1.19/docs/ops/rest_api/#jobs-jobid-execution-result
CompletableFuture<MetricCollectionResponseBody>	jobMetrics(String jobId, Optional<String> get)	https://nightlies.apache.org/flink/flink-docs-release-1.19/docs/ops/rest_api/#jobs-jobid-metrics
CompletableFuture<JobPlanInfo>	jobPlan(String jobId)	https://nightlies.apache.org/flink/flink-docs-release-1.19/docs/ops/rest_api/#jobs-jobid-plan
CompletableFuture<org.apache.flink.runtime.messages.webmonitor.JobIdsWithStatusOverview>	jobs()	https://nightlies.apache.org/flink/flink-docs-release-1.19/docs/ops/rest_api/#jobs-1
CompletableFuture<AggregatedMetricsResponseBody>	jobsMetrics(Optional<String> get, Optional<String> agg, Optional<String> jobs)	https://nightlies.apache.org/flink/flink-docs-release-1.19/docs/ops/rest_api/#jobs-metrics
CompletableFuture<org.apache.flink.runtime.messages.webmonitor.MultipleJobsDetails>	jobsOverview()	https://nightlies.apache.org/flink/flink-docs-release-1.19/docs/ops/rest_api/#jobs-overview
CompletableFuture<org.apache.flink.runtime.rest.handler.async.TriggerResponse>	rescale(String jobId, Integer parallelism)	Rescaling is temporarily disabled.
CompletableFuture<org.apache.flink.runtime.rest.handler.async.AsynchronousOperationResult<org.apache.flink.runtime.rest.handler.async.AsynchronousOperationInfo>>	rescaleResult(String jobId, String triggerId)	https://nightlies.apache.org/flink/flink-docs-release-1.19/docs/ops/rest_api/#jobs-jobid-rescaling-triggerid
CompletableFuture<org.apache.flink.runtime.rest.handler.async.TriggerResponse>	savepoint(String jobId, org.apache.flink.runtime.rest.messages.job.savepoints.SavepointTriggerRequestBody requestBody)	https://nightlies.apache.org/flink/flink-docs-release-1.19/docs/ops/rest_api/#jobs-jobid-savepoints
CompletableFuture<org.apache.flink.runtime.rest.handler.async.AsynchronousOperationResult<org.apache.flink.runtime.rest.messages.job.savepoints.SavepointInfo>>	savepointResult(String jobId, String triggerId)	https://nightlies.apache.org/flink/flink-docs-release-1.19/docs/ops/rest_api/#jobs-jobid-savepoints-triggerid
CompletableFuture<org.apache.flink.runtime.rest.handler.async.TriggerResponse>	stop(String jobId, org.apache.flink.runtime.rest.messages.job.savepoints.stop.StopWithSavepointRequestBody requestBody)	https://nightlies.apache.org/flink/flink-docs-release-1.19/docs/ops/rest_api/#jobs-jobid-stop
CompletableFuture<JobSubmitResponseBody>	submit(JobSubmitRequestBody requestBody)	https://nightlies.apache.org/flink/flink-docs-release-1.19/docs/ops/rest_api/#jobs-1
CompletableFuture<EmptyResponseBody>	terminate(String jobId)	https://nightlies.apache.org/flink/flink-docs-release-1.19/docs/ops/rest_api/#jobs-jobid-1

Methods inherited from class java.lang.Object

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

Constructor Details

JobController

public JobController()

Method Details

jobsOverview

@GetMapping("overview")
public CompletableFuture<org.apache.flink.runtime.messages.webmonitor.MultipleJobsDetails> jobsOverview()
                                                                                                 throws IOException

https://nightlies.apache.org/flink/flink-docs-release-1.19/docs/ops/rest_api/#jobs-overview

Throws:

IOException

jobs

@GetMapping
public CompletableFuture<org.apache.flink.runtime.messages.webmonitor.JobIdsWithStatusOverview> jobs()
                                                                                              throws IOException

https://nightlies.apache.org/flink/flink-docs-release-1.19/docs/ops/rest_api/#jobs-1

Throws:

IOException

jobsMetrics

@GetMapping("/metrics")
public CompletableFuture<AggregatedMetricsResponseBody> jobsMetrics(@RequestParam(value="get",required=false)
 Optional<String> get,
 @RequestParam(value="agg",required=false)
 Optional<String> agg,
 @RequestParam(value="jobs",required=false)
 Optional<String> jobs)
                                                             throws IOException

https://nightlies.apache.org/flink/flink-docs-release-1.19/docs/ops/rest_api/#jobs-metrics

Throws:

IOException

job

@GetMapping("{jobId}")
public CompletableFuture<JobDetailsInfo> job(@PathVariable("jobId")
 String jobId)
                                      throws IOException

https://nightlies.apache.org/flink/flink-docs-release-1.19/docs/ops/rest_api/#jobs-jobid

Throws:

IOException

jobConfig

@GetMapping("{jobId}/config")
public CompletableFuture<JobConfigInfo> jobConfig(@PathVariable("jobId")
 String jobId)
                                           throws IOException

https://nightlies.apache.org/flink/flink-docs-release-1.19/docs/ops/rest_api/#jobs-jobid-config

Throws:

IOException

jobMetrics

@GetMapping("{jobId}/metrics")
public CompletableFuture<MetricCollectionResponseBody> jobMetrics(@PathVariable("jobId")
 String jobId,
 @RequestParam(value="get",required=false)
 Optional<String> get)
                                                           throws IOException

https://nightlies.apache.org/flink/flink-docs-release-1.19/docs/ops/rest_api/#jobs-jobid-metrics

Throws:

IOException

jobExceptions

@GetMapping("{jobId}/exceptions")
public CompletableFuture<JobExceptionsInfoWithHistory> jobExceptions(@PathVariable("jobId")
 String jobId,
 @RequestParam(value="maxExceptions",required=false)
 Optional<String> maxExceptions)
                                                              throws IOException

https://nightlies.apache.org/flink/flink-docs-release-1.19/docs/ops/rest_api/#jobs-jobid-exceptions

Throws:

IOException

jobExecutionResult

@GetMapping("{jobId}/execution-result")
public CompletableFuture<JobExecutionResultResponseBody> jobExecutionResult(@PathVariable("jobId")
 String jobId)
                                                                     throws IOException

https://nightlies.apache.org/flink/flink-docs-release-1.19/docs/ops/rest_api/#jobs-jobid-execution-result

Throws:

IOException

jobAccumulators

@GetMapping("{jobId}/accumulators")
public CompletableFuture<JobAccumulatorsInfo> jobAccumulators(@PathVariable("jobId")
 String jobId,
 @RequestParam(value="includeSerializedValue",required=false)
 Optional<Boolean> includeSerializedValue)
                                                       throws IOException

https://nightlies.apache.org/flink/flink-docs-release-1.19/docs/ops/rest_api/#jobs-jobid-accumulators

Throws:

IOException

jobPlan

@GetMapping("{jobId}/plan")
public CompletableFuture<JobPlanInfo> jobPlan(@PathVariable("jobId")
 String jobId)
                                       throws IOException

https://nightlies.apache.org/flink/flink-docs-release-1.19/docs/ops/rest_api/#jobs-jobid-plan

Throws:

IOException

jobCheckpoints

@GetMapping("{jobId}/checkpoints")
public CompletableFuture<CheckpointingStatistics> jobCheckpoints(@PathVariable("jobId")
 String jobId)
                                                          throws IOException

https://nightlies.apache.org/flink/flink-docs-release-1.19/docs/ops/rest_api/#jobs-jobid-checkpoints

Throws:

IOException

jobCheckpointsConfig

@GetMapping("{jobId}/checkpoints/config")
public CompletableFuture<CheckpointConfigInfo> jobCheckpointsConfig(@PathVariable("jobId")
 String jobId)
                                                             throws IOException

https://nightlies.apache.org/flink/flink-docs-release-1.19/docs/ops/rest_api/#jobs-jobid-checkpoints-config

Throws:

IOException

jobCheckpointDetail

@GetMapping("{jobId}/checkpoints/details/{checkpointId}")
public CompletableFuture<CheckpointStatistics> jobCheckpointDetail(@PathVariable("jobId")
 String jobId,
 @PathVariable("checkpointId")
 Long checkpointId)
                                                            throws IOException

https://nightlies.apache.org/flink/flink-docs-release-1.19/docs/ops/rest_api/#jobs-jobid-checkpoints-details-checkpointid

Throws:

IOException

jobCheckpointSubtaskDetail

@GetMapping("{jobId}/checkpoints/details/{checkpointId}/subtasks/{vertexId}")
public CompletableFuture<TaskCheckpointStatisticsWithSubtaskDetails> jobCheckpointSubtaskDetail(@PathVariable("jobId")
 String jobId,
 @PathVariable("checkpointId")
 Long checkpointId,
 @PathVariable("vertexId")
 String vertexId)
                                                                                         throws IOException

https://nightlies.apache.org/flink/flink-docs-release-1.19/docs/ops/rest_api/#jobs-jobid-checkpoints-details-checkpointid-subtasks-vertexid

Throws:

IOException

submit

@PostMapping
public CompletableFuture<JobSubmitResponseBody> submit(@RequestBody
 JobSubmitRequestBody requestBody)
                                                throws IOException

https://nightlies.apache.org/flink/flink-docs-release-1.19/docs/ops/rest_api/#jobs-1

Throws:

IOException

terminate

@PatchMapping("{jobId}")
public CompletableFuture<EmptyResponseBody> terminate(@PathVariable("jobId")
 String jobId)
                                               throws IOException

https://nightlies.apache.org/flink/flink-docs-release-1.19/docs/ops/rest_api/#jobs-jobid-1

Throws:

IOException

stop

@PostMapping("{jobId}/stop")
public CompletableFuture<org.apache.flink.runtime.rest.handler.async.TriggerResponse> stop(@PathVariable("jobId")
 String jobId,
 @RequestBody
 org.apache.flink.runtime.rest.messages.job.savepoints.stop.StopWithSavepointRequestBody requestBody)
                                                                                    throws IOException

https://nightlies.apache.org/flink/flink-docs-release-1.19/docs/ops/rest_api/#jobs-jobid-stop

Throws:

IOException

rescale

@PostMapping("{jobId}/rescaling")
public CompletableFuture<org.apache.flink.runtime.rest.handler.async.TriggerResponse> rescale(@PathVariable("jobId")
 String jobId,
 @RequestParam(value="parallelism",defaultValue="2")
 Integer parallelism)
                                                                                       throws IOException

Rescaling is temporarily disabled. See FLINK-12312 https://nightlies.apache.org/flink/flink-docs-release-1.19/docs/ops/rest_api/#jobs-jobid-rescaling

Throws:

IOException

rescaleResult

@GetMapping("{jobId}/rescaling/{triggerId}")
public CompletableFuture<org.apache.flink.runtime.rest.handler.async.AsynchronousOperationResult<org.apache.flink.runtime.rest.handler.async.AsynchronousOperationInfo>> rescaleResult(@PathVariable("jobId")
 String jobId,
 @PathVariable("triggerId")
 String triggerId)
                                                                                                                                                                                throws IOException

https://nightlies.apache.org/flink/flink-docs-release-1.19/docs/ops/rest_api/#jobs-jobid-rescaling-triggerid

Throws:

IOException

savepoint

@PostMapping("{jobId}/savepoints")
public CompletableFuture<org.apache.flink.runtime.rest.handler.async.TriggerResponse> savepoint(@PathVariable("jobId")
 String jobId,
 @RequestBody
 org.apache.flink.runtime.rest.messages.job.savepoints.SavepointTriggerRequestBody requestBody)
                                                                                         throws IOException

https://nightlies.apache.org/flink/flink-docs-release-1.19/docs/ops/rest_api/#jobs-jobid-savepoints

Throws:

IOException

savepointResult

@GetMapping("{jobId}/savepoints/{triggerId}")
public CompletableFuture<org.apache.flink.runtime.rest.handler.async.AsynchronousOperationResult<org.apache.flink.runtime.rest.messages.job.savepoints.SavepointInfo>> savepointResult(@PathVariable("jobId")
 String jobId,
 @PathVariable("triggerId")
 String triggerId)
                                                                                                                                                                                throws IOException

https://nightlies.apache.org/flink/flink-docs-release-1.19/docs/ops/rest_api/#jobs-jobid-savepoints-triggerid

Throws:

IOException