Package org.springframework.cloud.dataflow.server.controller

Class JobStepExecutionController

java.lang.Object

org.springframework.cloud.dataflow.server.controller.JobStepExecutionController

@RestController
@RequestMapping("/jobs/executions/{jobExecutionId}/steps")
@ExposesResourceFor(StepExecutionResource.class)
public class JobStepExecutionController
extends Object

Author:

Glenn Renfro, Corneil du Plessis

Constructor Summary

Constructors

Constructor	Description
JobStepExecutionController(JobService jobService)	Creates a JobStepExecutionsController that retrieves Job Step Execution information from a the JobService

Method Summary

Modifier and Type	Method	Description
StepExecutionResource	getStepExecution(Long id, Long stepId)	Retrieve a specific StepExecutionResource.
org.springframework.hateoas.PagedModel<StepExecutionResource>	stepExecutions(long id, org.springframework.data.domain.Pageable pageable, org.springframework.data.web.PagedResourcesAssembler<org.springframework.batch.core.StepExecution> assembler)	List all step executions.

Methods inherited from class java.lang.Object

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

Constructor Details

JobStepExecutionController

public JobStepExecutionController(JobService jobService)

Creates a JobStepExecutionsController that retrieves Job Step Execution information from a the JobService

Parameters:

jobService - JobService used for this controller

Method Details

stepExecutions

@GetMapping("")
@ResponseStatus(OK)
public org.springframework.hateoas.PagedModel<StepExecutionResource> stepExecutions(@PathVariable("jobExecutionId")
 long id,
 org.springframework.data.domain.Pageable pageable,
 org.springframework.data.web.PagedResourcesAssembler<org.springframework.batch.core.StepExecution> assembler)
                                                                             throws org.springframework.batch.core.launch.NoSuchJobExecutionException

List all step executions.

Parameters:

id - the JobExecution.

pageable - the pagination information.

assembler - the resource assembler for step executions.

Returns:

Collection of StepExecutionResource for the given jobExecutionId.

Throws:

org.springframework.batch.core.launch.NoSuchJobExecutionException - if the job execution for the id specified does not exist.

getStepExecution

@GetMapping("/{stepExecutionId}")
@ResponseStatus(OK)
public StepExecutionResource getStepExecution(@PathVariable("jobExecutionId")
 Long id,
 @PathVariable("stepExecutionId")
 Long stepId)
                                       throws NoSuchStepExecutionException,
org.springframework.batch.core.launch.NoSuchJobExecutionException

Retrieve a specific StepExecutionResource.

Parameters:

id - the JobExecution id.

stepId - the StepExecution id.

Returns:

Collection of StepExecutionResource for the given jobExecutionId.

Throws:

NoSuchStepExecutionException - if the stepId specified does not exist.

org.springframework.batch.core.launch.NoSuchJobExecutionException - if the job execution for the id specified does not exist.