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

Interface SwaggerVacJobResource

@Path("/vac-jobs") @Consumes("application/json") @Produces("application/vnd.ilandcloud.api.v1.0+json") public interface SwaggerVacJobResource

  • Method Summary

    Modifier and Type
    Method
    Description
    com.iland.core.web.rest.response.task.TaskResponse
    disableVacJob(String jobUuid)
    Disable a VAC job.
    com.iland.core.web.rest.response.task.TaskResponse
    enableVacJob(String jobUuid)
    Enable a VAC job.
    BaJobResponse
    getVacJob(String jobUuid)
    Get a VAC job given a VAC company uuid and the job's uuid.
    BaJobListResponse
    getVacJobHistory(String jobUuid, Long start, Long end)
    Get the history for a VAC job given a start and end date.
    com.iland.core.web.rest.response.task.TaskResponse
    retryVacJob(String jobUuid)
    Retry a VAC job.
    com.iland.core.web.rest.response.task.TaskResponse
    startVacJob(String jobUuid)
    Start a VAC job.
    com.iland.core.web.rest.response.task.TaskResponse
    stopVacJob(String jobUuid)
    Stop a VAC job.

  • Method Details

    • getVacJob

      @GET @Path("/{jobUuid}") BaJobResponse getVacJob(@PathParam("jobUuid") String jobUuid)
      Get a VAC job given a VAC company uuid and the job's uuid.
      Parameters:
      jobUuid - the job UUID of vac company
      Returns:
      a list of vac jobs for the given company

    • enableVacJob

      @POST @Path("/{jobUuid}/action/enable") com.iland.core.web.rest.response.task.TaskResponse enableVacJob(@PathParam("jobUuid") String jobUuid)
      Enable a VAC job.
      Parameters:
      jobUuid - the job UUID of vac job
      Returns:
      a core task

    • disableVacJob

      @POST @Path("/{jobUuid}/action/disable") com.iland.core.web.rest.response.task.TaskResponse disableVacJob(@PathParam("jobUuid") String jobUuid)
      Disable a VAC job.
      Parameters:
      jobUuid - the job UUID of vac job
      Returns:
      a core task

    • startVacJob

      @POST @Path("/{jobUuid}/action/start") com.iland.core.web.rest.response.task.TaskResponse startVacJob(@PathParam("jobUuid") String jobUuid)
      Start a VAC job.
      Parameters:
      jobUuid - the job UUID of vac job
      Returns:
      a message indicating that the VAC job was started

    • stopVacJob

      @POST @Path("/{jobUuid}/action/stop") com.iland.core.web.rest.response.task.TaskResponse stopVacJob(@PathParam("jobUuid") String jobUuid)
      Stop a VAC job.
      Parameters:
      jobUuid - the job UUID of vac job
      Returns:
      a message indicating that the VAC job was stopped

    • retryVacJob

      @POST @Path("/{jobUuid}/action/retry") com.iland.core.web.rest.response.task.TaskResponse retryVacJob(@PathParam("jobUuid") String jobUuid)
      Retry a VAC job.
      Parameters:
      jobUuid - the job UUID of vac job
      Returns:
      a message indicating that the VAC job was retried

    • getVacJobHistory

      @GET @Path("/{jobUuid}/history") BaJobListResponse getVacJobHistory(@PathParam("jobUuid") String jobUuid, @QueryParam("start") Long start, @QueryParam("end") Long end)
      Get the history for a VAC job given a start and end date. If start or end is not passed then it defaults start to a week ago and sets end as current time.
      Parameters:
      jobUuid - the job UUID of vac job
      start - the start of the vac job history
      end - the end of the vac job history
      Returns:
      the vac job's history