Package org.springframework.cloud.dataflow.shell.command

Class JobCommands

java.lang.Object

org.springframework.cloud.dataflow.shell.command.JobCommands

@ShellComponent
public class JobCommands
extends Object

Job commands for the SCDF Shell.

Author:

Glenn Renfro, Ilayaperumal Gopinathan, Gunnar Hillert, Chris Bono, Corneil du Plessis

Constructor Summary

Constructors

Constructor	Description
JobCommands()

Method Summary

Modifier and Type	Method	Description
Availability	availableWithViewRole()
Table	executionDisplay(long id)
Table	executionList(String name)
String	executionRestart(long id, String useJsonJobParameters)
Table	instanceDisplay(long id)
Table	stepExecutionDisplay(long id, long jobExecutionId)
Table	stepExecutionList(long id)
Table	stepProgressDisplay(long id, long jobExecutionId)

Methods inherited from class java.lang.Object

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

Constructor Details

JobCommands

public JobCommands()

Method Details

availableWithViewRole

public Availability availableWithViewRole()

executionList

@ShellMethod(key="job execution list",
             value="List created job executions filtered by jobName")
@ShellMethodAvailability("availableWithViewRole")
public Table executionList(@ShellOption(help="the job name to be used as a filter",defaultValue="__NULL__")
 String name)

executionRestart

@ShellMethod(key="job execution restart",
             value="Restart a failed job by jobExecutionId")
@ShellMethodAvailability("availableWithViewRole")
public String executionRestart(@ShellOption(help="the job executiond id")
 long id,
 @ShellOption(value="--useJsonJobParameters",help="boolean value serialize job parameter as Json.  Default is null, meaning SCDF default will be used.",defaultValue="__NULL__")
 String useJsonJobParameters)

executionDisplay

@ShellMethod(key="job execution display",
             value="Display the details of a specific job execution")
@ShellMethodAvailability("availableWithViewRole")
public Table executionDisplay(@ShellOption(help="the job execution id")
 long id)

instanceDisplay

@ShellMethod(key="job instance display",
             value="Display the job executions for a specific job instance.")
@ShellMethodAvailability("availableWithViewRole")
public Table instanceDisplay(@ShellOption(help="the job instance id")
 long id)

stepExecutionList

@ShellMethod(key="job execution step list",
             value="List step executions filtered by jobExecutionId")
@ShellMethodAvailability("availableWithViewRole")
public Table stepExecutionList(@ShellOption(help="the job execution id to be used as a filter")
 long id)

stepProgressDisplay

@ShellMethod(key="job execution step progress",
             value="Display the details of a specific step progress")
@ShellMethodAvailability("availableWithViewRole")
public Table stepProgressDisplay(@ShellOption(help="the step execution id")
 long id,
 @ShellOption(value="--jobExecutionId",help="the job execution id")
 long jobExecutionId)

stepExecutionDisplay

@ShellMethod(key="job execution step display",
             value="Display the details of a specific step execution")
@ShellMethodAvailability("availableWithViewRole")
public Table stepExecutionDisplay(@ShellOption(help="the step execution id")
 long id,
 @ShellOption(value="--jobExecutionId",help="the job execution id")
 long jobExecutionId)