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

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

```
@RestController
 @RequestMapping(value="/tasks/executions")
 @ExposesResourceFor(value=TaskExecutionResource.class)
public class TaskExecutionController
extends Object
```
Controller for operations on TaskExecution. This includes obtaining task execution information from the task explorer.

Author:

Glenn Renfro, Michael Minella, Ilayaperumal Gopinathan

Constructor Summary

Constructors
Constructor and Description
`TaskExecutionController(org.springframework.cloud.task.repository.TaskExplorer explorer, TaskService taskService, TaskDefinitionRepository taskDefinitionRepository)` Creates a `TaskExecutionController` that retrieves Task Execution information from a the `TaskExplorer`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`cleanup(long id)` Cleanup resources associated with a single task execution, specified by id.
`long`	`launch(String taskName, String properties, List<String> arguments)` Request the launching of an existing task definition.
`org.springframework.hateoas.PagedResources<TaskExecutionResource>`	`list(org.springframework.data.domain.Pageable pageable, org.springframework.data.web.PagedResourcesAssembler<TaskJobExecutionRel> assembler)` Return a page-able list of `TaskExecutionResource` defined tasks.
`org.springframework.hateoas.PagedResources<TaskExecutionResource>`	`retrieveTasksByName(String taskName, org.springframework.data.domain.Pageable pageable, org.springframework.data.web.PagedResourcesAssembler<TaskJobExecutionRel> assembler)` Retrieve all task executions with the task name specified
`TaskExecutionResource`	`view(long id)` View the details of a single task execution, specified by id.

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

Constructor Detail
- TaskExecutionController
```
public TaskExecutionController(org.springframework.cloud.task.repository.TaskExplorer explorer,
                               TaskService taskService,
                               TaskDefinitionRepository taskDefinitionRepository)
```
  Creates a TaskExecutionController that retrieves Task Execution information from a the TaskExplorer
  
  Parameters:
  
  explorer - the explorer this controller will use for retrieving task execution information.
  
  taskService - used to launch tasks
  
  taskDefinitionRepository - the task definition repository

Method Detail

list

@RequestMapping(value="",
                method=GET)
 @ResponseStatus(value=OK)
public org.springframework.hateoas.PagedResources<TaskExecutionResource> list(org.springframework.data.domain.Pageable pageable,
                                                                                                                                                               org.springframework.data.web.PagedResourcesAssembler<TaskJobExecutionRel> assembler)

Return a page-able list of TaskExecutionResource defined tasks.

Parameters:: pageable - page-able collection of TaskExecutions.; assembler - for the TaskExecutions
Returns:: a list of task executions

retrieveTasksByName

@RequestMapping(value="",
                method=GET,
                params="name")
 @ResponseStatus(value=OK)
public org.springframework.hateoas.PagedResources<TaskExecutionResource> retrieveTasksByName(@RequestParam(value="name")
                                                                                                                                                                                                             String taskName,
                                                                                                                                                                                                             org.springframework.data.domain.Pageable pageable,
                                                                                                                                                                                                             org.springframework.data.web.PagedResourcesAssembler<TaskJobExecutionRel> assembler)

Retrieve all task executions with the task name specified

Parameters:: taskName - name of the task; pageable - page-able collection of TaskExecutions.; assembler - for the TaskExecutions
Returns:: the paged list of task executions

launch

@RequestMapping(value="",
                method=POST,
                params="name")
 @ResponseStatus(value=CREATED)
public long launch(@RequestParam(value="name")
                                                                                                                                         String taskName,
                                                                                                                                         @RequestParam(required=false)
                                                                                                                                         String properties,
                                                                                                                                         @RequestParam(required=false)
                                                                                                                                         List<String> arguments)

Request the launching of an existing task definition. The name must be included in the path.

Parameters:: taskName - the name of the existing task to be executed (required); properties - the runtime properties for the task, as a comma-delimited list of key=value pairs; arguments - the runtime commandline arguments
Returns:: the taskExecutionId for the executed task

view

@RequestMapping(value="/{id}",
                method=GET)
 @ResponseStatus(value=OK)
public TaskExecutionResource view(@PathVariable(value="id")
                                                                                                                        long id)

View the details of a single task execution, specified by id.

Parameters:: id - the id of the requested TaskExecution
Returns:: the TaskExecution

cleanup

@RequestMapping(value="/{id}",
                method=DELETE)
 @ResponseStatus(value=OK)
public void cleanup(@PathVariable(value="id")
                                                                                                             long id)

Cleanup resources associated with a single task execution, specified by id.

Parameters:: id - the id of the TaskExecution to clean up

Class TaskExecutionController