com.iland.core.web.rest.api

Interface TaskResource

@Path(value="/tasks")
 @Consumes(value="application/json")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
public interface TaskResource

Task Resource.

Author:

Brett Snyder

Method Summary

Modifier and Type	Method and Description
void	cancelTask(String uuid) Cancel a task.
TaskResponse	getTask(String uuid) Get a task by its UUID.
TaskListResponse	getTasks(TaskFilterParams filters) Allows a client to perform dynamic task queries.

Method Detail

getTask

@GET
 @Path(value="/{uuid}")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
TaskResponse getTask(@PathParam(value="uuid")
                                                                                                               String uuid)

Get a task by its UUID.

Parameters:

uuid - task UUID

Returns:

the task details

getTasks

@GET
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
TaskListResponse getTasks(@BeanParam
                                                                                            TaskFilterParams filters)

Allows a client to perform dynamic task queries.

Returns:

the list of queried tasks

cancelTask

@POST
 @Path(value="/{uuid}/actions/cancel")
void cancelTask(@PathParam(value="uuid")
                                                             String uuid)

Cancel a task. This operation is currently only supported for catalog upload tasks.

Parameters:

uuid - task UUID