org.springframework.cloud.dataflow.server.controller

Class JobExecutionThinController

java.lang.Object

org.springframework.cloud.dataflow.server.controller.JobExecutionThinController

@RestController
 @RequestMapping(value="/jobs/thinexecutions")
 @ExposesResourceFor(value=JobExecutionThinResource.class)
public class JobExecutionThinController
extends Object

Controller for retrieving JobExecutions where the step executions are not included in the results that are returned.

Since:

2.0

Author:

Glenn Renfro

Constructor Summary

Constructors

Constructor and Description
JobExecutionThinController(TaskJobService taskJobService) Creates a JobExecutionThinController that retrieves Job Execution information from a the JobService

Method Summary

Modifier and Type	Method and Description
org.springframework.hateoas.PagedResources<JobExecutionThinResource>	listJobsOnly(org.springframework.data.domain.Pageable pageable, org.springframework.data.web.PagedResourcesAssembler<TaskJobExecution> assembler) Return a page-able list of JobExecutionThinResource defined jobs that do not contain step execution detail.
org.springframework.hateoas.PagedResources<JobExecutionThinResource>	retrieveJobsByName(String jobName, org.springframework.data.domain.Pageable pageable, org.springframework.data.web.PagedResourcesAssembler<TaskJobExecution> assembler) Retrieve all task job executions with the task name specified

Methods inherited from class java.lang.Object

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

Constructor Detail

JobExecutionThinController

@Autowired
public JobExecutionThinController(TaskJobService taskJobService)

Creates a JobExecutionThinController that retrieves Job Execution information from a the JobService

Parameters:

taskJobService - the service this controller will use for retrieving job execution information. Must not be null.

Method Detail

listJobsOnly

@RequestMapping(value="",
                method=GET,
                produces="application/json")
 @ResponseStatus(value=OK)
public org.springframework.hateoas.PagedResources<JobExecutionThinResource> listJobsOnly(org.springframework.data.domain.Pageable pageable,
                                                                                                                                                                                                                       org.springframework.data.web.PagedResourcesAssembler<TaskJobExecution> assembler)
                                                                                                                                                                                                                throws org.springframework.batch.core.launch.NoSuchJobExecutionException

Return a page-able list of JobExecutionThinResource defined jobs that do not contain step execution detail.

Parameters:

pageable - page-able collection of TaskJobExecutions.

assembler - for the TaskJobExecutions

Returns:

a list of Task/Job executions(job executions do not contain step executions.

Throws:

org.springframework.batch.core.launch.NoSuchJobExecutionException - in the event that a job execution id specified is not present when looking up stepExecutions for the result.

retrieveJobsByName

@RequestMapping(value="",
                method=GET,
                params="name",
                produces="application/json")
 @ResponseStatus(value=OK)
public org.springframework.hateoas.PagedResources<JobExecutionThinResource> retrieveJobsByName(@RequestParam(value="name")
                                                                                                                                                                                                                                                            String jobName,
                                                                                                                                                                                                                                                            org.springframework.data.domain.Pageable pageable,
                                                                                                                                                                                                                                                            org.springframework.data.web.PagedResourcesAssembler<TaskJobExecution> assembler)
                                                                                                                                                                                                                                                     throws org.springframework.batch.core.launch.NoSuchJobException

Retrieve all task job executions with the task name specified

Parameters:

jobName - name of the job

pageable - page-able collection of TaskJobExecutions.

assembler - for the TaskJobExecutions

Returns:

list task/job executions with the specified jobName.

Throws:

org.springframework.batch.core.launch.NoSuchJobException - if the job with the given name does not exist.