public interface TaskOperations
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,
String description)
Create a new task definition
|
Collection<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.
|
org.springframework.hateoas.PagedModel<TaskExecutionResource> |
executionList() |
org.springframework.hateoas.PagedModel<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,
String alternateComposedTaskRunnerApp)
Launch an already created task.
|
org.springframework.hateoas.PagedModel<TaskDefinitionResource> |
list() |
org.springframework.hateoas.PagedModel<LauncherResource> |
listPlatforms() |
void |
stop(String ids)
Request the stop of a group
TaskExecution s. |
void |
stop(String ids,
String platform)
Request the stop of a group
TaskExecution s. |
String |
taskExecutionLog(String externalExecutionId)
Return the task execution log.
|
String |
taskExecutionLog(String externalExecutionId,
String platform)
Return the task execution log.
|
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.
|
org.springframework.hateoas.PagedModel<TaskDefinitionResource> list()
org.springframework.hateoas.PagedModel<LauncherResource> listPlatforms()
TaskDefinitionResource create(String name, String definition, String description)
name
- the name of the taskdefinition
- the task definition DSLdescription
- the description of the task definitionlong launch(String name, Map<String,String> properties, List<String> arguments, String alternateComposedTaskRunnerApp)
name
- the name of the taskproperties
- the deployment propertiesarguments
- the command line argumentsalternateComposedTaskRunnerApp
- app to use when running composed tasks instead of defaultvoid stop(String ids)
TaskExecution
s.ids
- comma delimited set of TaskExecution
ids to stop.void stop(String ids, String platform)
TaskExecution
s.ids
- comma delimited set of TaskExecution
ids to stop.platform
- the platform name where the task is executing.void destroy(String name)
name
- the name of the taskorg.springframework.hateoas.PagedModel<TaskExecutionResource> executionList()
org.springframework.hateoas.PagedModel<TaskExecutionResource> executionListByTaskName(String taskName)
taskName
- of the executions.TaskExecutionResource taskExecutionStatus(long id)
TaskExecutionResource
for the id specified.id
- identifier of the task executionTaskExecutionResource
String taskExecutionLog(String externalExecutionId)
default
.externalExecutionId
- the external execution identifier of the task execution.String
containing the log.String taskExecutionLog(String externalExecutionId, String platform)
externalExecutionId
- the external execution identifier of the task execution.platform
- the platform from which to obtain the log.String
containing the log.Collection<CurrentTaskExecutionsResource> currentTaskExecutions()
CurrentTaskExecutionsResource
void cleanup(long id)
id
- identifier of the task executionTaskAppStatusResource validateTaskDefinition(String taskDefinitionName) throws OperationNotSupportedException
taskDefinitionName
- The name of the task definition to be validated.TaskAppStatusResource
containing the task app statuses.OperationNotSupportedException
- if the server does not support task validationvoid destroyAll()
Copyright © 2020 Pivotal Software, Inc.. All rights reserved.