Package org.springframework.cloud.dataflow.server.controller

Class StreamDeploymentController

java.lang.Object

org.springframework.cloud.dataflow.server.controller.StreamDeploymentController

@RestController
@RequestMapping("/streams/deployments")
@ExposesResourceFor(StreamDeploymentResource.class)
public class StreamDeploymentController
extends Object

Controller for deployment operations on StreamDefinitions. Support for stream update, rollback, and update history by delegating to StreamService.

Author:

Eric Bottard, Mark Fisher, Patrick Peralta, Ilayaperumal Gopinathan, Marius Bogoevici, Janne Valkealahti, Christian Tzolov, Gunnar Hillert, Christian Tzolov

Constructor Summary

Constructors

Constructor	Description
StreamDeploymentController(StreamDefinitionRepository repository, StreamService streamService, StreamDefinitionService streamDefinitionService)	Construct a new UpdatableStreamDeploymentController, given a StreamDeploymentController and StreamService and StreamDefinitionService

Method Summary

Modifier and Type	Method	Description
ResponseEntity<Void>	deploy(String name, Map<String,String> properties)	Request deployment of an existing stream definition.
Collection<org.springframework.cloud.skipper.domain.Release>	history(String releaseName)
StreamDeploymentResource	info(String name, boolean reuseDeploymentProperties)	Request deployment of an existing stream definition.
ResponseEntity<String>	manifest(String name, Integer version)
Collection<org.springframework.cloud.skipper.domain.Deployer>	platformList()
ResponseEntity<Void>	rollback(String name, Integer version)
ResponseEntity<Void>	scaleApplicationInstances(String streamName, String appName, Integer count, Map<String,String> properties)	Scale application instances in a deployed stream.
ResponseEntity<Void>	undeploy(String name)	Request un-deployment of an existing stream.
ResponseEntity<Void>	undeployAll()	Request un-deployment of all streams.
ResponseEntity<Void>	update(String name, UpdateStreamRequest updateStreamRequest)

Methods inherited from class java.lang.Object

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

Constructor Details

StreamDeploymentController

public StreamDeploymentController(StreamDefinitionRepository repository,
 StreamService streamService,
 StreamDefinitionService streamDefinitionService)

Construct a new UpdatableStreamDeploymentController, given a StreamDeploymentController and StreamService and StreamDefinitionService

Parameters:

repository - the repository this controller will use for stream CRUD operations

streamService - the underlying UpdatableStreamService to deploy the stream

streamDefinitionService - the StreamDefinitionService

Method Details

scaleApplicationInstances

@PostMapping("/scale/{streamName}/{appName}/instances/{count}")
public ResponseEntity<Void> scaleApplicationInstances(@PathVariable
 String streamName,
 @PathVariable
 String appName,
 @PathVariable
 Integer count,
 @RequestBody(required=false)
 Map<String,String> properties)

Scale application instances in a deployed stream.

Parameters:

streamName - the name of an existing stream definition (required)

appName - in stream application name to scale (required)

count - number of instances for the selected stream application (required)

properties - scale deployment specific properties (optional)

Returns:

response without a body

update

@PostMapping("/update/{name}")
public ResponseEntity<Void> update(@PathVariable
 String name,
 @RequestBody
 UpdateStreamRequest updateStreamRequest)

rollback

@PostMapping("/rollback/{name}/{version}")
public ResponseEntity<Void> rollback(@PathVariable
 String name,
 @PathVariable
 Integer version)

manifest

@GetMapping("/manifest/{name}/{version}")
public ResponseEntity<String> manifest(@PathVariable
 String name,
 @PathVariable
 Integer version)

history

@GetMapping("/history/{name}")
@ResponseStatus(OK)
public Collection<org.springframework.cloud.skipper.domain.Release> history(@PathVariable("name")
 String releaseName)

platformList

@GetMapping("/platform/list")
@ResponseStatus(OK)
public Collection<org.springframework.cloud.skipper.domain.Deployer> platformList()

undeploy

@DeleteMapping("/{name}")
public ResponseEntity<Void> undeploy(@PathVariable
 String name)

Request un-deployment of an existing stream.

Parameters:

name - the name of an existing stream (required)

Returns:

response without a body

undeployAll

@DeleteMapping("")
public ResponseEntity<Void> undeployAll()

Request un-deployment of all streams.

Returns:

instance of ResponseEntity

info

@GetMapping("/{name}")
@ResponseStatus(OK)
public StreamDeploymentResource info(@PathVariable
 String name,
 @RequestParam(value="reuse-deployment-properties",required=false)
 boolean reuseDeploymentProperties)

Request deployment of an existing stream definition.

Parameters:

name - the name of an existing stream definition (required)

reuseDeploymentProperties - Indicator to re-use deployment properties.

Returns:

The stream deployment

deploy

@PostMapping("/{name}")
public ResponseEntity<Void> deploy(@PathVariable
 String name,
 @RequestBody(required=false)
 Map<String,String> properties)

Request deployment of an existing stream definition.

Parameters:

name - the name of an existing stream definition (required)

properties - the deployment properties for the stream as a comma-delimited list of key=value pairs

Returns:

response without a body