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

Class RuntimeStreamsController

java.lang.Object

org.springframework.cloud.dataflow.server.controller.RuntimeStreamsController

@RestController
@RequestMapping("/runtime/streams")
@ExposesResourceFor(StreamStatusResource.class)
public class RuntimeStreamsController
extends Object

Author:

Christian Tzolov, Ilayaperumal Gopinathan

Constructor Summary

Constructors

Constructor	Description
RuntimeStreamsController(StreamDeployer streamDeployer)	Construct a new runtime apps controller.

Method Summary

Modifier and Type	Method	Description
org.springframework.hateoas.PagedModel<StreamStatusResource>	status(String[] names, org.springframework.data.domain.Pageable pageable, org.springframework.data.web.PagedResourcesAssembler<org.springframework.data.util.Pair<String,List<org.springframework.cloud.deployer.spi.app.AppStatus>>> assembler)
org.springframework.hateoas.PagedModel<StreamStatusResource>	streamStatus(String[] streamNames, org.springframework.data.domain.Pageable pageable, org.springframework.data.web.PagedResourcesAssembler<org.springframework.data.util.Pair<String,List<org.springframework.cloud.deployer.spi.app.AppStatus>>> assembler)

Methods inherited from class java.lang.Object

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

Constructor Details

RuntimeStreamsController

public RuntimeStreamsController(StreamDeployer streamDeployer)

Construct a new runtime apps controller.

Parameters:

streamDeployer - the deployer this controller will use to get the status of deployed stream apps

Method Details

status

@GetMapping
public org.springframework.hateoas.PagedModel<StreamStatusResource> status(@RequestParam(required=false)
 String[] names,
 org.springframework.data.domain.Pageable pageable,
 org.springframework.data.web.PagedResourcesAssembler<org.springframework.data.util.Pair<String,List<org.springframework.cloud.deployer.spi.app.AppStatus>>> assembler)

Parameters:

names - The names of streams to include in result.

pageable - the page

assembler - the resource assembler

Returns:

a paged model for stream statuses

streamStatus

@GetMapping("/{streamNames}")
public org.springframework.hateoas.PagedModel<StreamStatusResource> streamStatus(@PathVariable
 String[] streamNames,
 org.springframework.data.domain.Pageable pageable,
 org.springframework.data.web.PagedResourcesAssembler<org.springframework.data.util.Pair<String,List<org.springframework.cloud.deployer.spi.app.AppStatus>>> assembler)

Parameters:

streamNames - comma separated list of streams to retrieve the statuses for

pageable - Pageable required on subsequent calls.

assembler - The resource assembler for the results.

Returns:

paged results.