org.springframework.cloud.dataflow.shell.command

Class TaskCommands

java.lang.Object

org.springframework.cloud.dataflow.shell.command.TaskCommands

@ShellComponent
public class TaskCommands
extends Object

Task commands.

Author:

Glenn Renfro, Michael Minella, Gunnar Hillert, Ilayaperumal Gopinathan, Janne Valkealahti, David Turanski, Mike Baranski, Chris Bono

Field Summary

Fields

Modifier and Type	Field and Description
protected UserInput	userInput

Constructor Summary

Constructors

Constructor and Description
TaskCommands()

Method Summary

Modifier and Type	Method and Description
org.springframework.shell.Availability	availableWithCreateRole()
org.springframework.shell.Availability	availableWithDeployRole()
org.springframework.shell.Availability	availableWithDestroyRole()
org.springframework.shell.Availability	availableWithUnDeployRole()
org.springframework.shell.Availability	availableWithViewRole()
String	cleanup(Long id, boolean all, boolean includeNonCompleted, String taskName, String schemaTarget, boolean force)
String	create(String name, String dsl, String description)
org.springframework.shell.table.Table	currentExecutions()
String	destroy(String name, boolean cleanup)
String	destroyAll(boolean force)
org.springframework.shell.table.Table	display(long id, String schemaTarget)
org.springframework.shell.table.Table	executionListByName(String name)
String	launch(String name, String properties, File propertiesFile, String arguments, String platformName)
org.springframework.shell.table.Table	list()
org.springframework.shell.table.Table	listPlatforms()
String	retrieveTaskExecutionLog(Long id, String externalExecutionId, String platform, String schemaTarget)
String	stop(String ids, String platform, String schemaTarget)
TablesInfo	validate(String name)

Methods inherited from class java.lang.Object

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

Field Detail

userInput

@Autowired
protected UserInput userInput

Constructor Detail

TaskCommands

public TaskCommands()

Method Detail

availableWithViewRole

public org.springframework.shell.Availability availableWithViewRole()

availableWithCreateRole

public org.springframework.shell.Availability availableWithCreateRole()

availableWithDeployRole

public org.springframework.shell.Availability availableWithDeployRole()

availableWithUnDeployRole

public org.springframework.shell.Availability availableWithUnDeployRole()

availableWithDestroyRole

public org.springframework.shell.Availability availableWithDestroyRole()

list

@ShellMethod(key="task list",
             value="List created tasks")
 @ShellMethodAvailability(value="availableWithViewRole")
public org.springframework.shell.table.Table list()

listPlatforms

@ShellMethod(key="task platform-list",
             value="List platform accounts for tasks")
 @ShellMethodAvailability(value="availableWithViewRole")
public org.springframework.shell.table.Table listPlatforms()

validate

@ShellMethod(key="task validate",
             value="Validate apps contained in task definitions")
public TablesInfo validate(@ShellOption(value={"","--name"},help="the task definition name")
                                                                                                                               String name)
                                                                                                                        throws OperationNotSupportedException

Throws:

OperationNotSupportedException

create

@ShellMethod(key="task create",
             value="Create a new task definition")
 @ShellMethodAvailability(value="availableWithCreateRole")
public String create(@ShellOption(value={"","--name"},help="the name to give to the task")
                                                                                                                                                                   String name,
                                                                                                                                                                   @ShellOption(value="--definition",help="a task definition, using the DSL (e.g. \"timestamp --format=YYYY\")")
                                                                                                                                                                   String dsl,
                                                                                                                                                                   @ShellOption(help="a sort description about the task",defaultValue="")
                                                                                                                                                                   String description)

launch

@ShellMethod(key="task launch",
             value="Launch a previously created task")
 @ShellMethodAvailability(value="availableWithDeployRole")
public String launch(@ShellOption(value={"","--name"},help="the name of the task to launch")
                                                                                                                                                                       String name,
                                                                                                                                                                       @ShellOption(help="the properties for this launch",defaultValue="__NULL__")
                                                                                                                                                                       String properties,
                                                                                                                                                                       @ShellOption(value="--propertiesFile",help="the properties for this launch (as a File)",defaultValue="__NULL__")
                                                                                                                                                                       File propertiesFile,
                                                                                                                                                                       @ShellOption(help="the commandline arguments for this launch",defaultValue="__NULL__")
                                                                                                                                                                       String arguments,
                                                                                                                                                                       @ShellOption(value="--platformName",help="the platform name to use for this launch",defaultValue="__NULL__")
                                                                                                                                                                       String platformName)
                                                                                                                                                                throws IOException

Throws:

IOException

stop

@ShellMethod(key="task execution stop",
             value="Stop executing tasks")
 @ShellMethodAvailability(value="availableWithUnDeployRole")
public String stop(@ShellOption(value={"","--ids"},help="the task execution id")
                                                                                                                                                                   String ids,
                                                                                                                                                                   @ShellOption(value="--platformName",help="the name of the platform where the task is executing",defaultValue="__NULL__")
                                                                                                                                                                   String platform,
                                                                                                                                                                   @ShellOption(value="--schemaTarget",help="the schema target of the task.",defaultValue="__NULL__")
                                                                                                                                                                   String schemaTarget)

retrieveTaskExecutionLog

@ShellMethod(key="task execution log",
             value="Retrieve task execution log")
public String retrieveTaskExecutionLog(@ShellOption(value={"","--id"},help="the task execution id",defaultValue="__NULL__")
                                                                                                                                Long id,
                                                                                                                                @ShellOption(value={"","--externalExecutionId"},help="the task external execution id",defaultValue="__NULL__")
                                                                                                                                String externalExecutionId,
                                                                                                                                @ShellOption(help="the platform of the task execution",defaultValue="__NULL__")
                                                                                                                                String platform,
                                                                                                                                @ShellOption(value="--schemaTarget",help="the schema target of the task",defaultValue="__NULL__")
                                                                                                                                String schemaTarget)

destroy

@ShellMethod(key="task destroy",
             value="Destroy an existing task")
 @ShellMethodAvailability(value="availableWithDestroyRole")
public String destroy(@ShellOption(value={"","--name"},help="the name of the task to destroy",valueProvider=TaskNameValueProvider.class)
                                                                                                                                                                  String name,
                                                                                                                                                                  @ShellOption(help="the boolean flag to set if task executions and related resources should NOT also be cleaned up",defaultValue="false")
                                                                                                                                                                  boolean cleanup)

destroyAll

@ShellMethod(key="task all destroy",
             value="Destroy all existing tasks")
 @ShellMethodAvailability(value="availableWithDestroyRole")
public String destroyAll(@ShellOption(help="bypass confirmation prompt",defaultValue="false")
                                                                                                                                                                           boolean force)

executionListByName

@ShellMethod(key="task execution list",
             value="List created task executions filtered by taskName")
 @ShellMethodAvailability(value="availableWithViewRole")
public org.springframework.shell.table.Table executionListByName(@ShellOption(value={"","--name"},help="the task name to be used as a filter",valueProvider=TaskNameValueProvider.class,defaultValue="__NULL__")
                                                                                                                                                                                                                                          String name)

display

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

currentExecutions

@ShellMethod(key="task execution current",
             value="Display count of currently executin tasks and related information")
 @ShellMethodAvailability(value="availableWithViewRole")
public org.springframework.shell.table.Table currentExecutions()

cleanup

@ShellMethod(key="task execution cleanup",
             value="Clean up any platform specific resources linked to a task execution")
 @ShellMethodAvailability(value="availableWithDestroyRole")
public String cleanup(@ShellOption(value={"","--id"},help="the task execution id",defaultValue="__NULL__")
                                                                                                                                                                                                                       Long id,
                                                                                                                                                                                                                       @ShellOption(help="all task execution IDs",defaultValue="false")
                                                                                                                                                                                                                       boolean all,
                                                                                                                                                                                                                       @ShellOption(help="include non-completed task executions",defaultValue="false")
                                                                                                                                                                                                                       boolean includeNonCompleted,
                                                                                                                                                                                                                       @ShellOption(value="--task-name",help="the name of the task to cleanup",defaultValue="__NULL__")
                                                                                                                                                                                                                       String taskName,
                                                                                                                                                                                                                       @ShellOption(value="--schemaTarget",help="the schema target of the task",defaultValue="__NULL__")
                                                                                                                                                                                                                       String schemaTarget,
                                                                                                                                                                                                                       @ShellOption(help="bypass confirmation prompt",defaultValue="false")
                                                                                                                                                                                                                       boolean force)