Package com.iland.core.web.rest.api

Interface TaskResource

@Path("/tasks") @Consumes("application/json") @Produces("application/vnd.ilandcloud.api.v1.0+json") public interface TaskResource
Task Resource.
Author:
Brett Snyder

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    cancelTask(String uuid)
    Deprecated.
    Use cancelTask(String, String).
    void
    cancelTask(String locationId, String uuid)
    Cancel a task.
    com.iland.core.web.rest.response.task.TaskResponse
    getTask(String uuid)
    Get a task by its UUID.
    com.iland.core.web.rest.response.task.PagedTaskListResponse
    getTasks(com.iland.core.web.rest.response.task.TaskFilterParams filters)
    Allows a client to perform dynamic task queries.

  • Method Details

    • getTask

      @GET @Path("/{uuid}") com.iland.core.web.rest.response.task.TaskResponse getTask(@PathParam("uuid") String uuid)
      Get a task by its UUID.
      Parameters:
      uuid - task UUID
      Returns:
      the task details

    • getTasks

      @GET com.iland.core.web.rest.response.task.PagedTaskListResponse getTasks(@BeanParam com.iland.core.web.rest.response.task.TaskFilterParams filters)
      Allows a client to perform dynamic task queries.
      Returns:
      the list of queried tasks

    • cancelTask

      @POST @Path("/{uuid}/actions/cancel") @Deprecated(since="12.31") void cancelTask(@PathParam("uuid") String uuid)
      Deprecated.
      Use cancelTask(String, String).
      Cancel a task. Supported for catalog upload tasks only.
      Parameters:
      uuid - task UUID

    • cancelTask

      @POST @Path("{locationId}/{uuid}/actions/cancel") void cancelTask(@PathParam("locationId") String locationId, @PathParam("uuid") String uuid)
      Cancel a task. Supported for catalog upload tasks and Copy VM to another vApp tasks. The locationId determines the correct routing for tasks that are bound to a vendor instance location e.g vCloud tasks like copy VM.

      Returns 400 if the task type is not cancellable or the task is not running, 403 if the caller is not a system admin or the task initiator, and 404 if the task UUID is not found.

      Parameters:
      locationId - the location Id (e.g. dal22.ilandcloud.com)
      uuid - task UUID