org.springframework.cloud.dataflow.rest.client

Interface JobOperations

All Known Implementing Classes:

JobTemplate

public interface JobOperations

Interface defining operations available for jobs.

Author:

Glenn Renfro

Method Summary

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.

Method Detail

executionList

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

List job executions known to the system.

instanceList

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

List job instances for the specified jobName.

executionListByJobName

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

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

Parameters:

jobName - of the executions.

jobExecution

JobExecutionResource jobExecution(long id)

Return the JobExecutionResource for the id specified.

Parameters:

id - identifier of the job execution

Returns:

JobExecutionResource

jobInstance

JobInstanceResource jobInstance(long id)

Return the JobInstanceResource for the id specified.

Parameters:

id - identifier of the job instasnce

Returns:

JobInstanceResource

stepExecutionList

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

List step executions known for a specific job execution id.

Parameters:

jobExecutionId - the id of the job execution.

stepExecutionProgress

StepExecutionProgressInfoResource stepExecutionProgress(long jobExecutionId,
                                                        long stepExecutionId)

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

Parameters:

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

stepExecutionId - the id step execution to be returned.