org.springframework.xd.rest.client

Interface JobOperations

All Superinterfaces:

ResourceOperations

All Known Implementing Classes:

JobTemplate

public interface JobOperations
extends ResourceOperations

Interface defining operations available against jobs.

Author:

Glenn Renfro, Ilayaperumal Gopinathan, Gunnar Hillert

Method Summary

Methods

Modifier and Type	Method and Description
JobDefinitionResource	createJob(java.lang.String name, java.lang.String definition, boolean deploy) Create a new Job, optionally deploying it.
JobExecutionInfoResource	displayJobExecution(long jobExecutionId) Retrieve a specific Job Execution for the provided jobExecutionId.
JobInstanceInfoResource	displayJobInstance(long instanceId) Retrieve a specific instance of a job, given its intanceId.
StepExecutionInfoResource	displayStepExecution(long jobExecutionId, long stepExecutionId) Retrieve a specific StepExecutionInfoResource for the provided jobExecutionId and stepExecutionId.
void	launchJob(java.lang.String name, java.lang.String jobParameters) Launch a job that is already deployed.
org.springframework.hateoas.PagedResources<JobDefinitionResource>	list() List jobs known to the system.
org.springframework.hateoas.PagedResources<JobExecutionInfoResource>	listJobExecutions() List all Job Executions.
java.util.List<StepExecutionInfoResource>	listStepExecutions(long jobExecutionId) Retrieve a List of StepExecutionInfoResources for the provided jobExecutionId.
void	restartJobExecution(long jobExecutionId) Restart a given job execution.
StepExecutionProgressInfoResource	stepExecutionProgress(long jobExecutionId, long stepExecutionId) Retrieve step execution progress with the given jobExecutionId and stepExecutionId.
void	stopAllJobExecutions() Stop all job executions.
void	stopJobExecution(long jobExecutionId) Stop job execution that is running.

Methods inherited from interface org.springframework.xd.rest.client.ResourceOperations

cleanBusResources, deploy, destroy, destroyAll, undeploy, undeployAll

Method Detail

createJob

JobDefinitionResource createJob(java.lang.String name,
                              java.lang.String definition,
                              boolean deploy)

Create a new Job, optionally deploying it.

launchJob

void launchJob(java.lang.String name,
             java.lang.String jobParameters)

Launch a job that is already deployed.

Parameters:

name - the name of the job to launch

jobParameters - the JSON string as jobParameters

list

org.springframework.hateoas.PagedResources<JobDefinitionResource> list()

List jobs known to the system.

listJobExecutions

org.springframework.hateoas.PagedResources<JobExecutionInfoResource> listJobExecutions()

List all Job Executions.

displayJobExecution

JobExecutionInfoResource displayJobExecution(long jobExecutionId)

Retrieve a specific Job Execution for the provided jobExecutionId.

listStepExecutions

java.util.List<StepExecutionInfoResource> listStepExecutions(long jobExecutionId)

Retrieve a List of StepExecutionInfoResources for the provided jobExecutionId.

stopJobExecution

void stopJobExecution(long jobExecutionId)

Stop job execution that is running.

restartJobExecution

void restartJobExecution(long jobExecutionId)

Restart a given job execution.

stopAllJobExecutions

void stopAllJobExecutions()

Stop all job executions.

stepExecutionProgress

StepExecutionProgressInfoResource stepExecutionProgress(long jobExecutionId,
                                                      long stepExecutionId)

Retrieve step execution progress with the given jobExecutionId and stepExecutionId.

displayStepExecution

StepExecutionInfoResource displayStepExecution(long jobExecutionId,
                                             long stepExecutionId)

Retrieve a specific StepExecutionInfoResource for the provided jobExecutionId and stepExecutionId.

displayJobInstance

JobInstanceInfoResource displayJobInstance(long instanceId)

Retrieve a specific instance of a job, given its intanceId.