org.springframework.cloud.dataflow.server.controller

Class TaskExecutionController

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, TaskDefinitionRepository taskDefinitionRepository) Creates a TaskExecutionController that retrieves Task Execution information from a the TaskExplorer

Method Summary

Modifier and Type	Method and Description
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,
                               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.

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

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