org.springframework.cloud.dataflow.shell.command.common

Class TaskCommands

java.lang.Object

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

All Implemented Interfaces:

org.springframework.shell.core.CommandMarker

@Component
public class TaskCommands
extends Object
implements org.springframework.shell.core.CommandMarker

Task commands.

Author:

Glenn Renfro, Michael Minella, Gunnar Hillert, Ilayaperumal Gopinathan, Janne Valkealahti

Constructor Summary

Constructors

Constructor and Description
TaskCommands()

Method Summary

Modifier and Type	Method and Description
boolean	availableWithCreateRole()
boolean	availableWithViewRole()
String	cleanup(long id)
String	create(String name, String dsl)
String	destroy(String name)
org.springframework.shell.table.Table	display(long id)
org.springframework.shell.table.Table	executionListByName(String name)
String	launch(String name, String properties, File propertiesFile, String arguments)
org.springframework.shell.table.Table	list()

Methods inherited from class java.lang.Object

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

Constructor Detail

TaskCommands

public TaskCommands()

Method Detail

availableWithViewRole

@CliAvailabilityIndicator(value={"task list","task execution status","task execution list"})
public boolean availableWithViewRole()

availableWithCreateRole

@CliAvailabilityIndicator(value={"task create","task launch","task execution cleanup","task destroy"})
public boolean availableWithCreateRole()

list

@CliCommand(value="task list",
            help="List created tasks")
public org.springframework.shell.table.Table list()

create

@CliCommand(value="task create",
            help="Create a new task definition")
public String create(@CliOption(mandatory=true,key={"","name"},help="the name to give to the task")
                                                                                                       String name,
                                                                                                       @CliOption(mandatory=true,key="definition",help="a task definition, using the DSL (e.g. \"timestamp --format=YYYY\")",optionContext="disable-string-converter completion-task")
                                                                                                       String dsl)

launch

@CliCommand(value="task launch",
            help="Launch a previously created task")
public String launch(@CliOption(key={"","name"},help="the name of the task to launch",mandatory=true,optionContext="existing-task disable-string-converter")
                                                                                                           String name,
                                                                                                           @CliOption(key="properties",help="the properties for this launch",mandatory=false)
                                                                                                           String properties,
                                                                                                           @CliOption(key="propertiesFile",help="the properties for this launch (as a File)",mandatory=false)
                                                                                                           File propertiesFile,
                                                                                                           @CliOption(key="arguments",help="the commandline arguments for this launch",mandatory=false)
                                                                                                           String arguments)
                                                                                                    throws IOException

Throws:

IOException

destroy

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

executionListByName

@CliCommand(value="task execution list",
            help="List created task executions filtered by taskName")
public org.springframework.shell.table.Table executionListByName(@CliOption(key="name",help="the task name to be used as a filter",optionContext="existing-task disable-string-converter")
                                                                                                                                                                                String name)

display

@CliCommand(value="task execution status",
            help="Display the details of a specific task execution")
public org.springframework.shell.table.Table display(@CliOption(key={"","id"},help="the task execution id",mandatory=true)
                                                                                                                                                                     long id)

cleanup

@CliCommand(value="task execution cleanup",
            help="Clean up any platform specific resources linked to a task execution")
public String cleanup(@CliOption(key={"","id"},help="the task execution id",mandatory=true)
                                                                                                                                                          long id)