org.springframework.cloud.dataflow.shell.command

Class TaskSchedulerCommands

java.lang.Object

org.springframework.cloud.dataflow.shell.command.TaskSchedulerCommands

@ShellComponent
public class TaskSchedulerCommands
extends Object

Task Scheduler commands

Author:

Daniel Serleg, Chris Bono

Constructor Summary

Constructors

Constructor and Description
TaskSchedulerCommands()

Method Summary

Modifier and Type	Method and Description
org.springframework.shell.Availability	availableWithCreateRole()
org.springframework.shell.Availability	availableWithListRole()
org.springframework.shell.Availability	availableWithUnscheduleRole()
String	create(String name, String definitionName, String expression, String properties, File propertiesFile, String arguments, String platform)
org.springframework.shell.table.Table	listByDefinition(String platform, String definitionName)
String	unschedule(String name, String platform)

Methods inherited from class java.lang.Object

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

Constructor Detail

TaskSchedulerCommands

public TaskSchedulerCommands()

Method Detail

availableWithCreateRole

public org.springframework.shell.Availability availableWithCreateRole()

availableWithListRole

public org.springframework.shell.Availability availableWithListRole()

availableWithUnscheduleRole

public org.springframework.shell.Availability availableWithUnscheduleRole()

create

@ShellMethod(key="task schedule create",
             value="Create new task schedule")
 @ShellMethodAvailability(value="availableWithCreateRole")
public String create(@ShellOption(help="the name to give to the schedule")
                                                                                                                                                                        String name,
                                                                                                                                                                        @ShellOption(value="--definitionName",help="a task definition name")
                                                                                                                                                                        String definitionName,
                                                                                                                                                                        @ShellOption(help="the cron expression of the schedule")
                                                                                                                                                                        String expression,
                                                                                                                                                                        @ShellOption(help="a task properties (comma separated string eg.: --properties \'prop.first=prop,prop.sec=prop2\'",defaultValue="__NULL__")
                                                                                                                                                                        String properties,
                                                                                                                                                                        @ShellOption(value="--propertiesFile",help="the properties for this deployment (as a File)",defaultValue="__NULL__")
                                                                                                                                                                        File propertiesFile,
                                                                                                                                                                        @ShellOption(help="command line args (space separated string eg.: --arguments \'a b c d\'",defaultValue="__NULL__")
                                                                                                                                                                        String arguments,
                                                                                                                                                                        @ShellOption(help="the name of the platform from which to create the schedule",defaultValue="__NULL__")
                                                                                                                                                                        String platform)
                                                                                                                                                                 throws IOException

Throws:

IOException

listByDefinition

@ShellMethod(key="task schedule list",
             value="List task schedules by task definition name")
 @ShellMethodAvailability(value="availableWithListRole")
public org.springframework.shell.table.Table listByDefinition(@ShellOption(help="the name platform from which to retrieve a list of schedules",defaultValue="__NULL__")
                                                                                                                                                                                                                                String platform,
                                                                                                                                                                                                                                @ShellOption(value="--definitionName",help="the task definition name",defaultValue="__NULL__")
                                                                                                                                                                                                                                String definitionName)

unschedule

@ShellMethod(key="task schedule destroy",
             value="Delete task schedule")
 @ShellMethodAvailability(value="availableWithUnscheduleRole")
public String unschedule(@ShellOption(help="The name of the task schedule")
                                                                                                                                                                             String name,
                                                                                                                                                                             @ShellOption(help="the name platform from which to unschedule",defaultValue="__NULL__")
                                                                                                                                                                             String platform)