org.springframework.xd.rest.client

Interface TapOperations

All Known Implementing Classes:

TapTemplate

public interface TapOperations

Interface defining operations against taps.

Since:

1.0

Author:

Ilayaperumal Gopinathan, Gunnar Hillert

Method Summary

Methods

Modifier and Type	Method and Description
TapDefinitionResource	createTap(java.lang.String name, java.lang.String definition, boolean deploy) Create a new Tap.
void	destroyTap(java.lang.String name) Destroy an existing tap
org.springframework.hateoas.PagedResources<TapDefinitionResource>	list() Retrieve a list of taps.

Method Detail

createTap

TapDefinitionResource createTap(java.lang.String name,
                              java.lang.String definition,
                              boolean deploy)

Create a new Tap.

Parameters:

name - the name to give to the tap

definition - the tap definition, expressed in XD DSL

deploy - whether to deploy the tap immediately

Returns:

a runtime representation of the created tap

list

org.springframework.hateoas.PagedResources<TapDefinitionResource> list()

Retrieve a list of taps.

Returns:

A list of taps

destroyTap

void destroyTap(java.lang.String name)

Destroy an existing tap

Parameters:

name -