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

Class TaskExecutionController

java.lang.Object

org.springframework.cloud.dataflow.server.controller.TaskExecutionController

@RestController
@RequestMapping("/tasks/executions")
@ExposesResourceFor(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, Christian Tzolov, David Turanski, Gunnar Hillert, Corneil du Plessis

Constructor Summary

Constructors

Constructor	Description
TaskExecutionController(DataflowTaskExplorer explorer, TaskExecutionService taskExecutionService, TaskDefinitionRepository taskDefinitionRepository, TaskExecutionInfoService taskExecutionInfoService, TaskDeleteService taskDeleteService, TaskJobService taskJobService)	Creates a TaskExecutionController that retrieves Task Execution information from a the TaskExplorer

Method Summary

Modifier and Type	Method	Description
void	cleanup(Set<Long> ids, TaskExecutionControllerDeleteAction[] actions)	Cleanup resources associated with one or more task executions, specified by id(s).
void	cleanupAll(TaskExecutionControllerDeleteAction[] actions, boolean completed, String taskName, Integer days)	Cleanup resources associated with one or more task executions.
Collection<CurrentTaskExecutionsResource>	getCurrentTaskExecutionsInfo()
long	launch(String taskName, String properties, String arguments)	Request the launching of an existing task definition.
LaunchResponseResource	launchBoot3(String taskName, String properties, String arguments)
org.springframework.hateoas.PagedModel<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.PagedModel<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
void	stop(Set<Long> ids, String platform)	Stop a set of task executions.
TaskExecutionResource	view(Long id)	View the details of a single task execution, specified by id.
TaskExecutionResource	viewByExternal(String externalExecutionId, String platform)

Methods inherited from class java.lang.Object

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

Constructor Details

TaskExecutionController

public TaskExecutionController(DataflowTaskExplorer explorer,
 TaskExecutionService taskExecutionService,
 TaskDefinitionRepository taskDefinitionRepository,
 TaskExecutionInfoService taskExecutionInfoService,
 TaskDeleteService taskDeleteService,
 TaskJobService taskJobService)

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.

taskExecutionService - used to launch tasks

taskDefinitionRepository - the task definition repository

taskExecutionInfoService - the task execution information service

taskDeleteService - the task deletion service

taskJobService - the task job service

Method Details

list

@GetMapping("")
@ResponseStatus(OK)
public org.springframework.hateoas.PagedModel<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

@GetMapping(value="",
            params="name")
@ResponseStatus(OK)
public org.springframework.hateoas.PagedModel<TaskExecutionResource> retrieveTasksByName(@RequestParam("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

@PostMapping(value="",
             params="name")
@ResponseStatus(CREATED)
public long launch(@RequestParam("name")
 String taskName,
 @RequestParam(required=false)
 String properties,
 @RequestParam(required=false)
 String arguments)

Request the launching of an existing task definition. The task definition will be created from a registered task application if `spring.cloud.dataflow.task.auto-create-task-definitions` is true. The name must be included in the path.

Parameters:

taskName - the name of the 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

launchBoot3

@PostMapping(value="/launch",
             params="name")
@ResponseStatus(CREATED)
public LaunchResponseResource launchBoot3(@RequestParam("name")
 String taskName,
 @RequestParam(required=false)
 String properties,
 @RequestParam(required=false)
 String arguments)

view

@GetMapping("/{id}")
@ResponseStatus(OK)
public TaskExecutionResource view(@PathVariable
 Long id)

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

Parameters:

id - the id of the requested TaskExecution

Returns:

the TaskExecution

viewByExternal

@GetMapping("/external/{externalExecutionId}")
@ResponseStatus(OK)
public TaskExecutionResource viewByExternal(@PathVariable
 String externalExecutionId,
 @RequestParam(required=false)
 String platform)

getCurrentTaskExecutionsInfo

@GetMapping("/current")
@ResponseStatus(OK)
public Collection<CurrentTaskExecutionsResource> getCurrentTaskExecutionsInfo()

cleanup

@DeleteMapping("/{id}")
@ResponseStatus(OK)
public void cleanup(@PathVariable("id")
 Set<Long> ids,
 @RequestParam(defaultValue="CLEANUP",name="action")
 TaskExecutionControllerDeleteAction[] actions)

Cleanup resources associated with one or more task executions, specified by id(s). The optional actions parameter can be used to not only clean up task execution resources, but can also trigger the deletion of task execution and job data in the persistence store.

Parameters:

ids - The id of the TaskExecutions to clean up

actions - Defaults to "CLEANUP" if not specified

cleanupAll

@DeleteMapping
@ResponseStatus(OK)
@Async("dataflowAsyncExecutor")
public void cleanupAll(@RequestParam(defaultValue="CLEANUP",name="action")
 TaskExecutionControllerDeleteAction[] actions,
 @RequestParam(defaultValue="false")
 boolean completed,
 @RequestParam(defaultValue="",name="name")
 String taskName,
 @RequestParam(required=false)
 Integer days)

Cleanup resources associated with one or more task executions. The optional actions and completed parameters can be used to not only clean up task execution resources, but can also trigger the deletion of task execution and job data in the persistence store.

When the spring.cloud.dataflow.async.enabled property is set to true the cleanup will happen asynchronously.

Parameters:

actions - the actions to perform (default 'CLEANUP')

completed - whether to include only completed task executions (default false)

taskName - name of the task (default '')

days - only include tasks that have ended at least this many days ago (default null)

stop

@PostMapping("/{id}")
@ResponseStatus(OK)
public void stop(@PathVariable("id")
 Set<Long> ids,
 @RequestParam(defaultValue="")
 String platform)

Stop a set of task executions.

Parameters:

ids - the ids of the TaskExecutions to stop

platform - the platform name