org.springframework.cloud.dataflow.shell.command

Class StreamCommands

java.lang.Object

org.springframework.cloud.dataflow.shell.command.StreamCommands

All Implemented Interfaces:

org.springframework.shell.core.CommandMarker

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

Stream commands.

Author:

Ilayaperumal Gopinathan, Mark Fisher

Constructor Summary

Constructors

Constructor and Description
StreamCommands()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	available()
String	createStream(String name, String dsl, boolean deploy)
String	deployStream(String name, String properties, File propertiesFile)
String	destroyAllStreams(boolean force)
String	destroyStream(String name)
org.springframework.shell.table.Table	listStreams()
String	undeployAllStreams(boolean force)
String	undeployStream(String name)

Methods inherited from class java.lang.Object

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

Constructor Detail

StreamCommands

public StreamCommands()

Method Detail

available

@CliAvailabilityIndicator(value={"stream list","stream create","stream deploy","stream undeploy","stream all undeploy","stream destroy","stream all destroy"})
public boolean available()

listStreams

@CliCommand(value="stream list",
            help="List created streams")
public org.springframework.shell.table.Table listStreams()

createStream

@CliCommand(value="stream create",
            help="Create a new stream definition")
public String createStream(@CliOption(mandatory=true,key={"","name"},help="the name to give to the stream")
                             String name,
                             @CliOption(mandatory=true,key="definition",help="a stream definition, using the DSL (e.g. \"http --port=9000 | hdfs\")",optionContext="disable-string-converter completion-stream")
                             String dsl,
                             @CliOption(key="deploy",help="whether to deploy the stream immediately",unspecifiedDefaultValue="false",specifiedDefaultValue="true")
                             boolean deploy)

deployStream

@CliCommand(value="stream deploy",
            help="Deploy a previously created stream")
public String deployStream(@CliOption(key={"","name"},help="the name of the stream to deploy",mandatory=true)
                             String name,
                             @CliOption(key="properties",help="the properties for this deployment",mandatory=false)
                             String properties,
                             @CliOption(key="propertiesFile",help="the properties for this deployment (as a File)",mandatory=false)
                             File propertiesFile)
                    throws IOException

Throws:

IOException

undeployStream

@CliCommand(value="stream undeploy",
            help="Un-deploy a previously deployed stream")
public String undeployStream(@CliOption(key={"","name"},help="the name of the stream to un-deploy",mandatory=true)
                               String name)

undeployAllStreams

@CliCommand(value="stream all undeploy",
            help="Un-deploy all previously deployed stream")
public String undeployAllStreams(@CliOption(key="force",help="bypass confirmation prompt",unspecifiedDefaultValue="false",specifiedDefaultValue="true")
                                   boolean force)

destroyStream

@CliCommand(value="stream destroy",
            help="Destroy an existing stream")
public String destroyStream(@CliOption(key={"","name"},help="the name of the stream to destroy",mandatory=true)
                              String name)

destroyAllStreams

@CliCommand(value="stream all destroy",
            help="Destroy all existing streams")
public String destroyAllStreams(@CliOption(key="force",help="bypass confirmation prompt",unspecifiedDefaultValue="false",specifiedDefaultValue="true")
                                  boolean force)