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

Constructor Summary

Constructors

Constructor and Description
JobCommands()

Method Summary

Modifier and Type	Method and Description
org.springframework.shell.Availability	availableWithViewRole()
org.springframework.shell.table.Table	executionDisplay(long id, String schemaTarget)
org.springframework.shell.table.Table	executionList(String name)
String	executionRestart(long id, String schemaTarget)
org.springframework.shell.table.Table	instanceDisplay(long id, String schemaTarget)
org.springframework.shell.table.Table	stepExecutionDisplay(long id, long jobExecutionId, String schemaTarget)
org.springframework.shell.table.Table	stepExecutionList(long id, String schemaTarget)
org.springframework.shell.table.Table	stepProgressDisplay(long id, long jobExecutionId, String schemaTarget)

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

availableWithViewRole

public org.springframework.shell.Availability availableWithViewRole()

executionList

@ShellMethod(key="job execution list",
             value="List created job executions filtered by jobName")
 @ShellMethodAvailability(value="availableWithViewRole")
public org.springframework.shell.table.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(value="availableWithViewRole")
public String executionRestart(@ShellOption(help="the job execution id")
                                                                                                                                                                                               long id,
                                                                                                                                                                                               @ShellOption(value="--schemaTarget",help="schema target",defaultValue="__NULL__")
                                                                                                                                                                                               String schemaTarget)

executionDisplay

@ShellMethod(key="job execution display",
             value="Display the details of a specific job execution")
 @ShellMethodAvailability(value="availableWithViewRole")
public org.springframework.shell.table.Table executionDisplay(@ShellOption(help="the job execution id")
                                                                                                                                                                                                                                       long id,
                                                                                                                                                                                                                                       @ShellOption(value="--schemaTarget",help="schema target",defaultValue="__NULL__")
                                                                                                                                                                                                                                       String schemaTarget)

instanceDisplay

@ShellMethod(key="job instance display",
             value="Display the job executions for a specific job instance.")
 @ShellMethodAvailability(value="availableWithViewRole")
public org.springframework.shell.table.Table instanceDisplay(@ShellOption(help="the job instance id")
                                                                                                                                                                                                                                             long id,
                                                                                                                                                                                                                                             @ShellOption(value="--schemaTarget",help="schema target",defaultValue="__NULL__")
                                                                                                                                                                                                                                             String schemaTarget)

stepExecutionList

@ShellMethod(key="job execution step list",
             value="List step executions filtered by jobExecutionId")
 @ShellMethodAvailability(value="availableWithViewRole")
public org.springframework.shell.table.Table stepExecutionList(@ShellOption(help="the job execution id to be used as a filter")
                                                                                                                                                                                                                                          long id,
                                                                                                                                                                                                                                          @ShellOption(value="--schemaTarget",help="schema target",defaultValue="__NULL__")
                                                                                                                                                                                                                                          String schemaTarget)

stepProgressDisplay

@ShellMethod(key="job execution step progress",
             value="Display the details of a specific step progress")
 @ShellMethodAvailability(value="availableWithViewRole")
public org.springframework.shell.table.Table stepProgressDisplay(@ShellOption(help="the step execution id")
                                                                                                                                                                                                                                                long id,
                                                                                                                                                                                                                                                @ShellOption(value="--jobExecutionId",help="the job execution id")
                                                                                                                                                                                                                                                long jobExecutionId,
                                                                                                                                                                                                                                                @ShellOption(value="--schemaTarget",help="schema target",defaultValue="__NULL__")
                                                                                                                                                                                                                                                String schemaTarget)

stepExecutionDisplay

@ShellMethod(key="job execution step display",
             value="Display the details of a specific step execution")
 @ShellMethodAvailability(value="availableWithViewRole")
public org.springframework.shell.table.Table stepExecutionDisplay(@ShellOption(help="the step execution id")
                                                                                                                                                                                                                                                 long id,
                                                                                                                                                                                                                                                 @ShellOption(value="--jobExecutionId",help="the job execution id")
                                                                                                                                                                                                                                                 long jobExecutionId,
                                                                                                                                                                                                                                                 @ShellOption(value="--schemaTarget",help="schema target",defaultValue="__NULL__")
                                                                                                                                                                                                                                                 String schemaTarget)