org.springframework.cloud.dataflow.rest.client

Interface TaskOperations

All Known Implementing Classes:

TaskTemplate

public interface TaskOperations

Interface defining operations available against tasks.

Author:

Glenn Renfro, Michael Minella, Gunnar Hillert

Method Summary

Modifier and Type	Method and Description
void	cleanup(long id) Cleanup any resources associated with the execution for the id specified.
TaskDefinitionResource	create(String name, String definition) Create a new task definition
void	destroy(String name) Destroy an existing task.
org.springframework.hateoas.PagedResources<TaskExecutionResource>	executionList()
org.springframework.hateoas.PagedResources<TaskExecutionResource>	executionListByTaskName(String taskName) List task executions known to the system filtered by task name.
long	launch(String name, Map<String,String> properties, List<String> arguments) Launch an already created task.
org.springframework.hateoas.PagedResources<TaskDefinitionResource>	list()
TaskExecutionResource	taskExecutionStatus(long id) Return the TaskExecutionResource for the id specified.

Method Detail

list

org.springframework.hateoas.PagedResources<TaskDefinitionResource> list()

Returns:

the list tasks known to the system.

create

TaskDefinitionResource create(String name,
                              String definition)

Create a new task definition

Parameters:

name - the name of the task

definition - the task definition DSL

Returns:

the task definition

launch

long launch(String name,
            Map<String,String> properties,
            List<String> arguments)

Launch an already created task.

Parameters:

name - the name of the task

properties - the deployment properties

arguments - the command line arguments

Returns:

long containing the TaskExecutionId

destroy

void destroy(String name)

Destroy an existing task.

Parameters:

name - the name of the task

executionList

org.springframework.hateoas.PagedResources<TaskExecutionResource> executionList()

Returns:

the list task executions known to the system.

executionListByTaskName

org.springframework.hateoas.PagedResources<TaskExecutionResource> executionListByTaskName(String taskName)

List task executions known to the system filtered by task name.

Parameters:

taskName - of the executions.

Returns:

the paged list of task executions for the given task name

taskExecutionStatus

TaskExecutionResource taskExecutionStatus(long id)

Return the TaskExecutionResource for the id specified.

Parameters:

id - identifier of the task execution

Returns:

TaskExecutionResource

cleanup

void cleanup(long id)

Cleanup any resources associated with the execution for the id specified.

Parameters:

id - identifier of the task execution