org.springframework.xd.dirt.rest

Class BatchJobsController

java.lang.Object

org.springframework.xd.dirt.rest.AbstractBatchJobsController

org.springframework.xd.dirt.rest.BatchJobsController

@RestController
@RequestMapping(value="/jobs/configurations")
@ExposesResourceFor(value=DetailedJobInfoResource.class)
public class BatchJobsController
extends AbstractBatchJobsController

Controller for batch jobs and job instances, job executions on a given batch job.

Author:

Dave Syer, Ilayaperumal Gopinathan, Andrew Eisenberg

Field Summary

Fields inherited from class org.springframework.xd.dirt.rest.AbstractBatchJobsController

jobExecutionInfoResourceAssembler, jobInfoResourceAssembler, jobInstanceInfoResourceAssembler, jobService, progressInfoResourceAssembler, stepExecutionInfoResourceAssembler, timeZone, xdJobDefinitionRepository, xdJobrepository

Constructor Summary

Constructors

Constructor and Description
BatchJobsController()

Method Summary

Methods

Modifier and Type	Method and Description
DetailedJobInfoResource	jobinfo(java.lang.String jobName)
java.util.Collection<DetailedJobInfoResource>	jobs(int startJob, int pageSize) Get a list of JobInfo, in a given range.

Methods inherited from class org.springframework.xd.dirt.rest.AbstractBatchJobsController

setTimeZone

Methods inherited from class java.lang.Object

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

Constructor Detail

BatchJobsController

public BatchJobsController()

Method Detail

jobs

@RequestMapping(value="",
                method=GET,
                produces="application/json")
@ResponseStatus(value=OK)
public java.util.Collection<DetailedJobInfoResource> jobs(@RequestParam(defaultValue="0")
                                                                               int startJob,
                                                                               @RequestParam(defaultValue="20")
                                                                               int pageSize)

Get a list of JobInfo, in a given range.

Parameters:

startJob - the start index of the job names to return

pageSize - page size for the list

jobinfo

@RequestMapping(value="/{jobName}",
                method=GET,
                produces="application/json")
@ResponseStatus(value=OK)
public DetailedJobInfoResource jobinfo(@PathVariable
                                                            java.lang.String jobName)

Parameters:

jobName - name of the job

Returns:

ExpandedJobInfo for the given job name