org.springframework.cloud.dataflow.shell.command.skipper

Class SkipperStreamCommands

java.lang.Object

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

org.springframework.cloud.dataflow.shell.command.skipper.SkipperStreamCommands

All Implemented Interfaces:

org.springframework.shell.core.CommandMarker

@Component
public class SkipperStreamCommands
extends AbstractStreamCommands
implements org.springframework.shell.core.CommandMarker

Stream commands.

Author:

Ilayaperumal Gopinathan, Mark Fisher, Gunnar Hillert, Glenn Renfro, Janne Valkealahti

Field Summary

Fields inherited from class org.springframework.cloud.dataflow.shell.command.common.AbstractStreamCommands

dataFlowShell, PROPERTIES_FILE_OPTION, PROPERTIES_OPTION, userInput

Constructor Summary

Constructors

Constructor and Description
SkipperStreamCommands()

Method Summary

Modifier and Type	Method and Description
boolean	availableWithCreateRole()
String	deployStream(String name, String deploymentProperties, File propertiesFile, String packageVersion, String platformName, String repoName)
String	getManifest(String name, int releaseVersion)
org.springframework.shell.table.Table	history(String name)
org.springframework.shell.table.Table	listPlatforms()
String	rollbackStreamUsingSkipper(String name, int releaseVersion)
void	setDataFlowShell(DataFlowShell dataFlowShell)
void	setUserInput(UserInput userInput)
String	updateStream(String name, String properties, File propertiesFile, String packageVersion, String repoName)

Methods inherited from class org.springframework.cloud.dataflow.shell.command.common.AbstractStreamCommands

availableWithViewRole, createStream, destroyAllStreams, destroyStream, listStreams, streamInfo, streamOperations, undeployAllStreams, undeployStream

Methods inherited from class java.lang.Object

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

Constructor Detail

SkipperStreamCommands

public SkipperStreamCommands()

Method Detail

setDataFlowShell

@Autowired
public void setDataFlowShell(DataFlowShell dataFlowShell)

setUserInput

@Autowired
public void setUserInput(UserInput userInput)

availableWithCreateRole

@CliAvailabilityIndicator(value={"stream deploy","stream update"})
public boolean availableWithCreateRole()

Overrides:

availableWithCreateRole in class AbstractStreamCommands

deployStream

@CliCommand(value="stream deploy",
            help="Deploy a previously created stream using Skipper")
public String deployStream(@CliOption(key={"","name"},help="the name of the stream to deploy",mandatory=true,optionContext="existing-stream disable-string-converter")
                                                                                                                                   String name,
                                                                                                                                   @CliOption(key="properties",help="the properties for this deployment")
                                                                                                                                   String deploymentProperties,
                                                                                                                                   @CliOption(key="propertiesFile",help="the properties for this deployment (as a File)")
                                                                                                                                   File propertiesFile,
                                                                                                                                   @CliOption(key="packageVersion",help="the package version of the package to deploy.  Default is 1.0.0when using Skipper",unspecifiedDefaultValue="1.0.0")
                                                                                                                                   String packageVersion,
                                                                                                                                   @CliOption(key="platformName",help="the name of the target platform to deploy when using Skipper")
                                                                                                                                   String platformName,
                                                                                                                                   @CliOption(key="repoName",help="the name of the local repository to upload the package when using Skipper")
                                                                                                                                   String repoName)
                                                                                                                            throws IOException

Throws:

IOException

getManifest

@CliCommand(value="stream manifest",
            help="Get manifest for the stream deployed using Skipper")
public String getManifest(@CliOption(key={"","name"},help="the name of the stream",mandatory=true,optionContext="existing-stream disable-string-converter")
                                                                                                                                      String name,
                                                                                                                                      @CliOption(key="releaseVersion",help="the Skipper release version to get the manifest for",unspecifiedDefaultValue="0")
                                                                                                                                      int releaseVersion)

history

@CliCommand(value="stream history",
            help="Get history for the stream deployed using Skipper")
public org.springframework.shell.table.Table history(@CliOption(key={"","name"},help="the name of the stream",mandatory=true,optionContext="existing-stream disable-string-converter")
                                                                                                                                                               String name)

listPlatforms

@CliCommand(value="stream platform-list",
            help="List Skipper platforms")
public org.springframework.shell.table.Table listPlatforms()

updateStream

@CliCommand(value="stream update",
            help="Update a previously created stream using Skipper")
public String updateStream(@CliOption(key={"","name"},help="the name of the stream to update",mandatory=true,optionContext="existing-stream disable-string-converter")
                                                                                                                                   String name,
                                                                                                                                   @CliOption(key="properties",help="Flattened YAML style properties to update the stream",mandatory=false)
                                                                                                                                   String properties,
                                                                                                                                   @CliOption(key="propertiesFile",help="the properties for the stream update (as a File)",mandatory=false)
                                                                                                                                   File propertiesFile,
                                                                                                                                   @CliOption(key="packageVersion",help="the package version of the package to update when using Skipper")
                                                                                                                                   String packageVersion,
                                                                                                                                   @CliOption(key="repoName",help="the name of the local repository to upload the package when using Skipper")
                                                                                                                                   String repoName)
                                                                                                                            throws IOException

Throws:

IOException

rollbackStreamUsingSkipper

@CliCommand(value="stream rollback",
            help="Rollback a stream using Skipper")
public String rollbackStreamUsingSkipper(@CliOption(key={"","name"},help="the name of the stream to rollback",mandatory=true,optionContext="existing-stream disable-string-converter")
                                                                                                                                  String name,
                                                                                                                                  @CliOption(key="releaseVersion",help="the Skipper release version to rollback to",unspecifiedDefaultValue="0")
                                                                                                                                  int releaseVersion)