org.springframework.cloud.dataflow.server.controller

Class JobStepExecutionProgressController

java.lang.Object

org.springframework.cloud.dataflow.server.controller.JobStepExecutionProgressController

@RestController
 @RequestMapping(value="/jobs/executions/{jobExecutionId}/steps")
 @ExposesResourceFor(value=org.springframework.cloud.dataflow.rest.resource.StepExecutionProgressInfoResource.class)
public class JobStepExecutionProgressController
extends Object

Author:

Glenn Renfro, Corneil du Plessis

Constructor Summary

Constructors

Constructor and Description
JobStepExecutionProgressController(JobServiceContainer jobServiceContainer, TaskJobService taskJobService) Creates a JobStepProgressInfoExecutionsController that retrieves Job Step Progress Execution information from a the JobServiceContainer

Method Summary

Modifier and Type	Method and Description
StepExecutionProgressInfoResource	progress(long jobExecutionId, long stepExecutionId, String schemaTarget) Get the step execution progress for the given jobExecutions step.

Methods inherited from class java.lang.Object

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

Constructor Detail

JobStepExecutionProgressController

@Autowired
public JobStepExecutionProgressController(JobServiceContainer jobServiceContainer,
                                                     TaskJobService taskJobService)

Creates a JobStepProgressInfoExecutionsController that retrieves Job Step Progress Execution information from a the JobServiceContainer

Parameters:

jobServiceContainer - A container of JobServices that this controller will use for retrieving job step progress execution information.

taskJobService - Queries both schemas.

Method Detail

progress

@RequestMapping(value="/{stepExecutionId}/progress",
                method=GET)
 @ResponseStatus(value=OK)
public StepExecutionProgressInfoResource progress(@PathVariable
                                                                                                                                                              long jobExecutionId,
                                                                                                                                                              @PathVariable
                                                                                                                                                              long stepExecutionId,
                                                                                                                                                              @RequestParam(name="schemaTarget",required=false)
                                                                                                                                                              String schemaTarget)
                                                                                                                                                       throws NoSuchStepExecutionException,
                                                                                                                                                              org.springframework.batch.core.launch.NoSuchJobExecutionException

Get the step execution progress for the given jobExecutions step.

Parameters:

jobExecutionId - Id of the JobExecution, must not be null

stepExecutionId - Id of the StepExecution, must not be null

Returns:

StepExecutionProgressInfoResource that has the progress info on the given StepExecution.

Throws:

org.springframework.batch.core.launch.NoSuchJobExecutionException - Thrown if the respective JobExecution does not exist

NoSuchStepExecutionException - Thrown if the respective StepExecution does not exist