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

Interface O365JobResource

@Path("/o365-jobs") @Consumes("application/json") @Produces("application/vnd.ilandcloud.api.v1.0+json") public interface O365JobResource
Office 365 VBO Job Resource.
Author:
Julien Anguenot

  • Method Details

    • getJobByUuid

      @GET @Path("/{uuid}") O365JobResponse getJobByUuid(@PathParam("uuid") String uuid)
      Get an Office 365 VBO Job.
      Parameters:
      uuid - The Office 365 VBO Job UUID
      Returns:
      a O365JobResponse instance

    • getJobSessions

      @GET @Path("/{uuid}/job-sessions") O365JobSessionSetResponse getJobSessions(@PathParam("uuid") String uuid, @QueryParam("page") Integer page, @QueryParam("pageSize") Integer pageSize)
      Get Office 365 VBO Job Sessions given a Job UUID.
      Parameters:
      uuid - The Office 365 VBO Job UUID
      page - the page
      pageSize - the page size
      Returns:
      a O365JobSessionSetResponse instance

    • startRestoreSession

      @POST @Path("/{uuid}/actions/start-restore-session") @Consumes("application/json") O365RestoreSessionResponse startRestoreSession(@PathParam("uuid") String uuid, O365RestoreSessionStartRequest request)
      Starts a restore session for exploring and performing restore operations with backups.
      Parameters:
      uuid - The Office 365 VBO Job UUID
      request - a O365RestoreSessionStartRequest
      Returns:
      a O365RestoreSessionResponse instance

    • startJob

      @POST @Path("/{uuid}/actions/start-backup-job") @Consumes("application/json") O365JobResponse startJob(@PathParam("uuid") String uuid)
      Start a backup job given its UUID.
      Parameters:
      uuid - The Office 365 VBO Job UUID
      Returns:
      a O365JobResponse instance

    • stopJob

      @POST @Path("/{uuid}/actions/stop-backup-job") @Consumes("application/json") O365JobResponse stopJob(@PathParam("uuid") String uuid)
      Stop a backup job given its UUID.
      Parameters:
      uuid - The Office 365 VBO Job UUID
      Returns:
      a O365JobResponse instance

    • enableJob

      @POST @Path("/{uuid}/actions/enable") @Consumes("application/json") O365JobResponse enableJob(@PathParam("uuid") String uuid)
      Enable a backup job given its UUID.
      Parameters:
      uuid - The Office 365 VBO Job UUID
      Returns:
      a O365JobResponse instance

    • disableJob

      @POST @Path("/{uuid}/actions/disable") @Consumes("application/json") O365JobResponse disableJob(@PathParam("uuid") String uuid)
      Disable a backup job given its UUID.
      Parameters:
      uuid - The Office 365 VBO Job UUID
      Returns:
      a O365JobResponse instance

    • modifyJob

      @PUT @Path("/{uuid}/actions/modifyJob") @Consumes("application/json") O365JobResponse modifyJob(@PathParam("uuid") String uuid, O365JobRequest modifyRequest)
      Modify a backup job given its UUID.
      Parameters:
      uuid - The Office 365 VBO Job UUID
      modifyRequest - the O365JobRequest instance
      Returns:
      a O365JobResponse instance

    • modifyJobSchedulePolicy

      @PUT @Path("/{uuid}/actions/modify") @Consumes("application/json") O365JobResponse modifyJobSchedulePolicy(@PathParam("uuid") String uuid, O365JobSchedulePolicyRequest schedulePolicyRequest)
      Modify a backup job given its UUID. Currently only modification of schedule policy is supported.
      Parameters:
      uuid - The Office 365 VBO Job UUID
      schedulePolicyRequest - the O365JobSchedulePolicyRequest instance
      Returns:
      a O365JobResponse instance

    • removeJob

      @DELETE @Path("/{uuid}") @Consumes("application/json") void removeJob(@PathParam("uuid") String uuid)
      Remove a backup job given its UUID.
      Parameters:
      uuid - The Office 365 VBO Job UUID

    • createCopyJob

      @POST @Consumes("application/json") @Path("/{uuid}/actions/create-copy-job") O365CopyJobResponse createCopyJob(@PathParam("uuid") String uuid, O365CopyJobCreateRequest o365CopyJobCreateRequest)
      Create a backup copy job.
      Parameters:
      uuid - The Office 365 VBO copy Job UUID
      o365CopyJobCreateRequest - O365CopyJobCreateRequest copy job create request
      Returns:
      O365CopyJobResponse copy job response

    • removeCopyJob

      @DELETE @Path("/copy-job/{uuid}") @Consumes("application/json") void removeCopyJob(@PathParam("uuid") String uuid)
      Delete a backup copy job.
      Parameters:
      uuid - The Office 365 VBO Job UUID

    • getCopyJob

      @GET @Path("/copy-job/{uuid}") @Consumes("application/json") O365CopyJobResponse getCopyJob(@PathParam("uuid") String uuid)
      Get a backup copy job.
      Parameters:
      uuid - The Office 365 VBO Job UUID

    • startCopyJobRestoreSession

      @POST @Path("/copy-job/{uuid}") @Consumes("application/json") O365RestoreSessionResponse startCopyJobRestoreSession(@PathParam("uuid") String uuid, O365CopyJobRestoreSessionRequest o365CopyJobRestoreSessionRequest)
      Start a restore session for a copy job.
      Parameters:
      uuid - The Office 365 VBO Copy Job UUID
      o365CopyJobRestoreSessionRequest - copy job restore session request
      Returns:
      restore session response

    • modifyCopyJobSchedulePolicy

      @PUT @Path("/copy-job/{uuid}/actions/modify") @Consumes("application/json") O365CopyJobResponse modifyCopyJobSchedulePolicy(@PathParam("uuid") String uuid, O365CopyJobSchedulePolicyRequest schedulePolicyRequest)
      Modify a copy job's schedule policy.
      Parameters:
      uuid - The Office 365 VBO Copy Job UUID
      schedulePolicyRequest - copy job schedule policy request
      Returns:
      modified copy job

    • exportJobSessions

      @POST @Path("/{uuid}/sessions-export") @Consumes("application/json") @Produces("application/vnd.ilandcloud.api.v1.0+octet-stream") InputStream exportJobSessions(@PathParam("uuid") String uuid)
      Download all the given job sessions as CSV file.
      Parameters:
      uuid - The Office 365 VBO job UUID
      Returns:
      a InputStream representing the job sessions file.