TaskDefinitionController (Spring Cloud Data Flow Docs 1.4.1.RELEASE API)

java.lang.Object
- org.springframework.cloud.dataflow.server.controller.TaskDefinitionController

@RestController
 @RequestMapping(value="/tasks/definitions")
 @ExposesResourceFor(value=TaskDefinitionResource.class)
public class TaskDefinitionController
extends Object

Controller for operations on TaskDefinition. This includes CRUD operations.

Author:: Michael Minella, Marius Bogoevici, Glenn Renfro, Mark Fisher

Constructor Summary

Constructors
Constructor and Description
`TaskDefinitionController(TaskDefinitionRepository repository, DeploymentIdRepository deploymentIdRepository, org.springframework.cloud.deployer.spi.task.TaskLauncher taskLauncher, AppRegistryCommon appRegistry, TaskService taskService)` Creates a `TaskDefinitionController` that delegates CRUD operations to the provided `TaskDefinitionRepository` task status checks to the provided `TaskLauncher`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`destroyTask(String name)` Delete the task from the repository so that it can no longer be executed.
`TaskDefinitionResource`	`display(String name)` Return a given task definition resource.
`org.springframework.hateoas.PagedResources<TaskDefinitionResource>`	`list(org.springframework.data.domain.Pageable pageable, String search, org.springframework.data.web.PagedResourcesAssembler<TaskDefinition> assembler)` Return a page-able list of `TaskDefinitionResource` defined tasks.
`TaskDefinitionResource`	`save(String name, String dsl)` Register a task definition for future execution.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- TaskDefinitionController
```
public TaskDefinitionController(TaskDefinitionRepository repository,
                                DeploymentIdRepository deploymentIdRepository,
                                org.springframework.cloud.deployer.spi.task.TaskLauncher taskLauncher,
                                AppRegistryCommon appRegistry,
                                TaskService taskService)
```
  Creates a TaskDefinitionController that delegates
  - CRUD operations to the provided TaskDefinitionRepository
  - task status checks to the provided TaskLauncher
  Parameters:
  
  repository - the repository this controller will use for task CRUD operations.
  
  deploymentIdRepository - the repository this controller will use for deployment IDs
  
  taskLauncher - the TaskLauncher this controller will use to check task status.
  
  appRegistry - the app registry to look up registered apps.
  
  taskService - handles specialized behavior needed for tasks.

Method Detail

save

@RequestMapping(value="",
                method=POST)
public TaskDefinitionResource save(@RequestParam(value="name")
                                                                                          String name,
                                                                                          @RequestParam(value="definition")
                                                                                          String dsl)

Parameters:: name - name the name of the task; dsl - DSL definition for the task
Returns:: the task definition

destroyTask

@RequestMapping(value="/{name}",
                method=DELETE)
 @ResponseStatus(value=OK)
public void destroyTask(@PathVariable(value="name")
                                                                                                                   String name)

Delete the task from the repository so that it can no longer be executed.

Parameters:: name - name of the task to be deleted

list

@RequestMapping(value="",
                method=GET)
 @ResponseStatus(value=OK)
public org.springframework.hateoas.PagedResources<TaskDefinitionResource> list(org.springframework.data.domain.Pageable pageable,
                                                                                                                                                                @RequestParam(required=false)
                                                                                                                                                                String search,
                                                                                                                                                                org.springframework.data.web.PagedResourcesAssembler<TaskDefinition> assembler)

Return a page-able list of TaskDefinitionResource defined tasks.

Parameters:: pageable - page-able collection of TaskDefinitionResource.; assembler - assembler for the TaskDefinition; search - optional findByNameLike parameter
Returns:: a list of task definitions

display

@RequestMapping(value="/{name}",
                method=GET)
 @ResponseStatus(value=OK)
public TaskDefinitionResource display(@PathVariable(value="name")
                                                                                                                              String name)

Return a given task definition resource.

Parameters:: name - the name of an existing task definition (required)
Returns:: the task definition

Class TaskDefinitionController