org.springframework.cloud.dataflow.rest.client

Class TaskTemplate

java.lang.Object

org.springframework.cloud.dataflow.rest.client.TaskTemplate

All Implemented Interfaces:

TaskOperations

public class TaskTemplate
extends Object
implements TaskOperations

Implementation for TaskOperations.

Author:

Glenn Renfro, Michael Minella, Gunnar Hillert, David Turanski

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
CurrentTaskExecutionsResource	currentTaskExecutions() Return information including the count of currently executing tasks and task execution limits.
void	destroy(String name) Destroy an existing task.
void	destroyAll() Destroy all existing tasks.
TaskExecutionResource.Page	executionList()
TaskExecutionResource.Page	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.
TaskDefinitionResource.Page	list()
LauncherResource.Page	listPlatforms()
TaskExecutionResource	taskExecutionStatus(long id) Return the TaskExecutionResource for the id specified.
TaskAppStatusResource	validateTaskDefinition(String taskDefinitionName) Return the validation status for the tasks in an definition.

Methods inherited from class java.lang.Object

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

Method Detail

list

public TaskDefinitionResource.Page list()

Specified by:

list in interface TaskOperations

Returns:

the list tasks known to the system.

listPlatforms

public LauncherResource.Page listPlatforms()

Specified by:

listPlatforms in interface TaskOperations

Returns:

the list of platform accounts for tasks.

create

public TaskDefinitionResource create(String name,
                                     String definition)

Description copied from interface: TaskOperations

Create a new task definition

Specified by:

create in interface TaskOperations

Parameters:

name - the name of the task

definition - the task definition DSL

Returns:

the task definition

launch

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

Description copied from interface: TaskOperations

Launch an already created task.

Specified by:

launch in interface TaskOperations

Parameters:

name - the name of the task

properties - the deployment properties

arguments - the command line arguments

Returns:

long containing the TaskExecutionId

destroy

public void destroy(String name)

Description copied from interface: TaskOperations

Destroy an existing task.

Specified by:

destroy in interface TaskOperations

Parameters:

name - the name of the task

destroyAll

public void destroyAll()

Description copied from interface: TaskOperations

Destroy all existing tasks.

Specified by:

destroyAll in interface TaskOperations

executionList

public TaskExecutionResource.Page executionList()

Specified by:

executionList in interface TaskOperations

Returns:

the list task executions known to the system.

executionListByTaskName

public TaskExecutionResource.Page executionListByTaskName(String taskName)

Description copied from interface: TaskOperations

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

Specified by:

executionListByTaskName in interface TaskOperations

Parameters:

taskName - of the executions.

Returns:

the paged list of task executions for the given task name

taskExecutionStatus

public TaskExecutionResource taskExecutionStatus(long id)

Description copied from interface: TaskOperations

Return the TaskExecutionResource for the id specified.

Specified by:

taskExecutionStatus in interface TaskOperations

Parameters:

id - identifier of the task execution

Returns:

TaskExecutionResource

currentTaskExecutions

public CurrentTaskExecutionsResource currentTaskExecutions()

Description copied from interface: TaskOperations

Return information including the count of currently executing tasks and task execution limits.

Specified by:

currentTaskExecutions in interface TaskOperations

Returns:

CurrentTaskExecutionsResource

cleanup

public void cleanup(long id)

Description copied from interface: TaskOperations

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

Specified by:

cleanup in interface TaskOperations

Parameters:

id - identifier of the task execution

validateTaskDefinition

public TaskAppStatusResource validateTaskDefinition(String taskDefinitionName)
                                             throws OperationNotSupportedException

Description copied from interface: TaskOperations

Return the validation status for the tasks in an definition.

Specified by:

validateTaskDefinition in interface TaskOperations

Parameters:

taskDefinitionName - The name of the task definition to be validated.

Returns:

TaskAppStatusResource containing the task app statuses.

Throws:

OperationNotSupportedException - if the server does not support task validation