org.springframework.xd.shell.command

Class JobCommands

java.lang.Object

org.springframework.xd.shell.command.JobCommands

All Implemented Interfaces:

org.springframework.shell.core.CommandMarker

@Component
public class JobCommands
extends java.lang.Object
implements org.springframework.shell.core.CommandMarker

Job commands.

Author:

Glenn Renfro, Ilayaperumal Gopinathan, Gunnar Hillert, Eric Bottard

Constructor Summary

Constructors

Constructor and Description
JobCommands()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	available()
java.lang.String	createJob(java.lang.String name, java.lang.String dsl, boolean deploy)
java.lang.String	deployJob(java.lang.String name, java.lang.String properties, java.io.File propertiesFile)
java.lang.String	destroyAllJobs(boolean force)
java.lang.String	destroyJob(java.lang.String name)
java.lang.String	display(long jobExecutionId)
java.lang.CharSequence	displayJobInstance(long instanceId)
Table	displayStepExecution(long stepExecutionId, long jobExecutionId)
java.lang.String	launchJob(java.lang.String name, java.lang.String jobParameters)
Table	listJobExecutions()
Table	listJobs()
Table	listStepExecutions(long jobExecutionId)
java.lang.String	restartJobExecution(long executionId)
Table	stepExecutionProgress(long stepExecutionId, long jobExecutionId)
java.lang.String	stopAllJobExecutions(boolean force)
java.lang.String	stopJobExecution(long executionId)
java.lang.String	undeployAllJobs(boolean force)
java.lang.String	undeployJob(java.lang.String name)

Methods inherited from class java.lang.Object

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

Constructor Detail

JobCommands

public JobCommands()

Method Detail

available

@CliAvailabilityIndicator(value={"job create","job list","job deploy","job undeploy","job destroy","job execution stop","job all destroy","job all undeploy","job execution all stop","job execution display","job execution list","job execution restart","job execution step display","job execution step list","job execution step progress","job instance display","job launch"})
public boolean available()

createJob

@CliCommand(value="job create",
            help="Create a job")
public java.lang.String createJob(@CliOption(mandatory=true,key={"name",""},help="the name to give to the job")
                                    java.lang.String name,
                                    @CliOption(mandatory=true,key="definition",optionContext="completion-job disable-string-converter",help="job definition using xd dsl ")
                                    java.lang.String dsl,
                                    @CliOption(key="deploy",help="whether to deploy the job immediately",unspecifiedDefaultValue="false",specifiedDefaultValue="true")
                                    boolean deploy)

listJobs

@CliCommand(value="job list",
            help="List all jobs")
public Table listJobs()

listJobExecutions

@CliCommand(value="job execution list",
            help="List all job executions")
public Table listJobExecutions()

listStepExecutions

@CliCommand(value="job execution step list",
            help="List all step executions for the provided job execution id")
public Table listStepExecutions(@CliOption(mandatory=true,key={"","id"},help="the id of the job execution")
                                  long jobExecutionId)

stepExecutionProgress

@CliCommand(value="job execution step progress",
            help="Get the progress info for the given step execution")
public Table stepExecutionProgress(@CliOption(mandatory=true,key={"","id"},help="the id of the step execution")
                                     long stepExecutionId,
                                     @CliOption(mandatory=true,key="jobExecutionId",help="the job execution id")
                                     long jobExecutionId)

displayStepExecution

@CliCommand(value="job execution step display",
            help="Display the details of a Step Execution")
public Table displayStepExecution(@CliOption(mandatory=true,key={"","id"},help="the id of the step execution")
                                    long stepExecutionId,
                                    @CliOption(mandatory=true,key="jobExecutionId",help="the job execution id")
                                    long jobExecutionId)

display

@CliCommand(value="job execution display",
            help="Display the details of a Job Execution")
public java.lang.String display(@CliOption(mandatory=true,key={"","id"},help="the id of the job execution")
                                  long jobExecutionId)

stopAllJobExecutions

@CliCommand(value="job execution all stop",
            help="Stop all the job executions that are running")
public java.lang.String stopAllJobExecutions(@CliOption(key="force",help="bypass confirmation prompt",unspecifiedDefaultValue="false",specifiedDefaultValue="true")
                                               boolean force)

stopJobExecution

@CliCommand(value="job execution stop",
            help="Stop a job execution that is running")
public java.lang.String stopJobExecution(@CliOption(key={"","id"},help="the id of the job execution",mandatory=true)
                                           long executionId)

restartJobExecution

@CliCommand(value="job execution restart",
            help="Restart a job that failed or interrupted previously")
public java.lang.String restartJobExecution(@CliOption(key={"","id"},help="the id of the job execution that failed or interrupted",mandatory=true)
                                              long executionId)

deployJob

@CliCommand(value="job deploy",
            help="Deploy a previously created job")
public java.lang.String deployJob(@CliOption(key={"","name"},help="the name of the job to deploy",mandatory=true,optionContext="existing-job undeployed disable-string-converter")
                                    java.lang.String name,
                                    @CliOption(key="properties",help="the properties for this deployment",mandatory=false)
                                    java.lang.String properties,
                                    @CliOption(key="propertiesFile",help="the properties for this deployment (as a File)",mandatory=false)
                                    java.io.File propertiesFile)
                           throws java.io.IOException

Throws:

java.io.IOException

launchJob

@CliCommand(value="job launch",
            help="Launch previously deployed job")
public java.lang.String launchJob(@CliOption(key={"","name"},help="the name of the job to deploy",optionContext="existing-job disable-string-converter")
                                    java.lang.String name,
                                    @CliOption(key="params",help="the parameters for the job",unspecifiedDefaultValue="")
                                    java.lang.String jobParameters)

undeployJob

@CliCommand(value="job undeploy",
            help="Un-deploy an existing job")
public java.lang.String undeployJob(@CliOption(key={"","name"},help="the name of the job to un-deploy",mandatory=true,optionContext="existing-job deployed disable-string-converter")
                                      java.lang.String name)

undeployAllJobs

@CliCommand(value="job all undeploy",
            help="Un-deploy all existing jobs")
public java.lang.String undeployAllJobs(@CliOption(key="force",help="bypass confirmation prompt",unspecifiedDefaultValue="false",specifiedDefaultValue="true")
                                          boolean force)

displayJobInstance

@CliCommand(value="job instance display",
            help="Display information about a given job instance")
public java.lang.CharSequence displayJobInstance(@CliOption(key={"","id"},help="the id of the job instance to retrieve")
                                                   long instanceId)

destroyJob

@CliCommand(value="job destroy",
            help="Destroy an existing job")
public java.lang.String destroyJob(@CliOption(key={"","name"},help="the name of the job to destroy",mandatory=true,optionContext="existing-job disable-string-converter")
                                     java.lang.String name)

destroyAllJobs

@CliCommand(value="job all destroy",
            help="Destroy all existing jobs")
public java.lang.String destroyAllJobs(@CliOption(key="force",help="bypass confirmation prompt",unspecifiedDefaultValue="false",specifiedDefaultValue="true")
                                         boolean force)