org.springframework.cloud.dataflow.rest.client

Class StreamTemplate

java.lang.Object

org.springframework.cloud.dataflow.rest.client.StreamTemplate

All Implemented Interfaces:

StreamOperations

public class StreamTemplate
extends Object
implements StreamOperations

Implementation for StreamOperations.

Author:

Ilayaperumal Gopinathan, Mark Fisher, Eric Bottard

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFINITIONS_REL

Method Summary

Modifier and Type	Method and Description
StreamDefinitionResource	createStream(String name, String definition, boolean deploy) Create a new stream, optionally deploying it.
void	deploy(String name, Map<String,String> properties) Deploy an already created stream.
void	destroy(String name) Destroy an existing stream.
void	destroyAll() Destroy all streams known to the system.
StreamDefinitionResource.Page	list()
void	undeploy(String name) Undeploy a deployed stream, retaining its definition.
void	undeployAll() Undeploy all currently deployed streams.

Methods inherited from class java.lang.Object

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

Field Detail

DEFINITIONS_REL

public static final String DEFINITIONS_REL

See Also:

Constant Field Values

Method Detail

list

public StreamDefinitionResource.Page list()

Specified by:

list in interface StreamOperations

Returns:

the list streams known to the system.

createStream

public StreamDefinitionResource createStream(String name,
                                             String definition,
                                             boolean deploy)

Description copied from interface: StreamOperations

Create a new stream, optionally deploying it.

Specified by:

createStream in interface StreamOperations

Parameters:

name - the name of the stream

definition - the stream definition DSL

deploy - whether to deploy the stream after creating its definition

Returns:

the new stream definition

deploy

public void deploy(String name,
                   Map<String,String> properties)

Description copied from interface: StreamOperations

Deploy an already created stream.

Specified by:

deploy in interface StreamOperations

Parameters:

name - the name of the stream

properties - the deployment properties

undeploy

public void undeploy(String name)

Description copied from interface: StreamOperations

Undeploy a deployed stream, retaining its definition.

Specified by:

undeploy in interface StreamOperations

Parameters:

name - the name of the stream

undeployAll

public void undeployAll()

Description copied from interface: StreamOperations

Undeploy all currently deployed streams.

Specified by:

undeployAll in interface StreamOperations

destroy

public void destroy(String name)

Description copied from interface: StreamOperations

Destroy an existing stream.

Specified by:

destroy in interface StreamOperations

Parameters:

name - the name of the stream

destroyAll

public void destroyAll()

Description copied from interface: StreamOperations

Destroy all streams known to the system.

Specified by:

destroyAll in interface StreamOperations