org.springframework.cloud.dataflow.rest.client

Class JobTemplate

java.lang.Object

org.springframework.cloud.dataflow.rest.client.JobTemplate

All Implemented Interfaces:

JobOperations

public class JobTemplate
extends Object
implements JobOperations

Implementation for JobOperations.

Author:

Glenn Renfro

Method Summary

Methods

Modifier and Type	Method and Description
org.springframework.hateoas.PagedResources<JobExecutionResource>	executionList() List job executions known to the system.
org.springframework.hateoas.PagedResources<JobExecutionResource>	executionListByJobName(String jobName) List job executions known to the system filtered by job name.
org.springframework.hateoas.PagedResources<JobInstanceResource>	instanceList(String jobName) List job instances for the specified jobName.
JobExecutionResource	jobExecution(long id) Return the JobExecutionResource for the id specified.
JobInstanceResource	jobInstance(long id) Return the JobInstanceResource for the id specified.
org.springframework.hateoas.PagedResources<StepExecutionResource>	stepExecutionList(long jobExecutionId) List step executions known for a specific job execution id.
StepExecutionProgressInfoResource	stepExecutionProgress(long jobExecutionId, long stepExecutionId) Return StepExecutionProgressInfoResource for a specific job execution id and step execution Id.

Methods inherited from class java.lang.Object

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

Method Detail

executionList

public org.springframework.hateoas.PagedResources<JobExecutionResource> executionList()

Description copied from interface: JobOperations

List job executions known to the system.

Specified by:

executionList in interface JobOperations

instanceList

public org.springframework.hateoas.PagedResources<JobInstanceResource> instanceList(String jobName)

Description copied from interface: JobOperations

List job instances for the specified jobName.

Specified by:

instanceList in interface JobOperations

executionListByJobName

public org.springframework.hateoas.PagedResources<JobExecutionResource> executionListByJobName(String jobName)

Description copied from interface: JobOperations

List job executions known to the system filtered by job name.

Specified by:

executionListByJobName in interface JobOperations

Parameters:

jobName - of the executions.

jobExecution

public JobExecutionResource jobExecution(long id)

Description copied from interface: JobOperations

Return the JobExecutionResource for the id specified.

Specified by:

jobExecution in interface JobOperations

Parameters:

id - identifier of the job execution

Returns:

JobExecutionResource

jobInstance

public JobInstanceResource jobInstance(long id)

Description copied from interface: JobOperations

Return the JobInstanceResource for the id specified.

Specified by:

jobInstance in interface JobOperations

Parameters:

id - identifier of the job instasnce

Returns:

JobInstanceResource

stepExecutionList

public org.springframework.hateoas.PagedResources<StepExecutionResource> stepExecutionList(long jobExecutionId)

Description copied from interface: JobOperations

List step executions known for a specific job execution id.

Specified by:

stepExecutionList in interface JobOperations

Parameters:

jobExecutionId - the id of the job execution.

stepExecutionProgress

public StepExecutionProgressInfoResource stepExecutionProgress(long jobExecutionId,
                                                      long stepExecutionId)

Description copied from interface: JobOperations

Return StepExecutionProgressInfoResource for a specific job execution id and step execution Id.

Specified by:

stepExecutionProgress in interface JobOperations

Parameters:

jobExecutionId - the id of the job execution for the step to be returned.

stepExecutionId - the id step execution to be returned.