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

Interface VacCompanyResource

@Path("/vac-companies") @Consumes("application/json") @Produces("application/vnd.ilandcloud.api.v1.0+json") public interface VacCompanyResource
VAC Company resource.
Author:
Nick Kasprzak

  • Method Details

    • getVacCompany

      @GET @Path("/{uuid}") BaCompanyResponse getVacCompany(@PathParam("uuid") String uuid)
      Gets a VAC company by its uuid.
      Parameters:
      uuid - vac company uuid
      Returns:
      vac company

    • deleteVacCompany

      @DELETE @Path("/{uuid}") com.iland.core.web.rest.response.task.TaskResponse deleteVacCompany(@PathParam("uuid") String uuid)
      Delete a VAC company given its uuid.
      Parameters:
      uuid - vac company uuid
      Returns:
      delete vac company task

    • getStorageUsage

      @GET @Path("/{uuid}/storage-usage") VacPerfSampleListResponse getStorageUsage(@PathParam("uuid") String uuid, @QueryParam("start") Long start, @QueryParam("end") Long end, @QueryParam("limit") Integer limit, @QueryParam("interval") PerfIntervalRequest interval)
      Get the storage usage performance samples for a given company, timeframe and performance sampling interval.

      If no interval is explicitly specified, an 'HOUR' interval is assumed.

      Parameters:
      uuid - the company uuid
      start - The start timestamp, in epoch milliseconds. Defaults to the past day when the interval=HOUR and to the past 90 days when interval=DAY.
      end - The end timestamp, in epoch milliseconds. Defaults to the current time.
      limit - sample limit
      interval - perf interval
      Returns:
      list of storage usage performance samples

    • resetVacCompanyPassword

      @POST @Path("/{uuid}/actions/update-password") @Consumes("application/json") void resetVacCompanyPassword(@PathParam("uuid") String uuid, BaCompanyPasswordResetRequest passwordResetRequest)
      Update the password for the VAC company.
      Parameters:
      uuid - vac company uuid
      passwordResetRequest - password reset request

    • requestContractUpgrade

      @POST @Path("/{uuid}/actions/request-upgrade-contract") @Consumes("application/json") void requestContractUpgrade(@PathParam("uuid") String companyUuid, BaCompanyContractUpgradeRequest updateContractRequest)
      Upgrade the contract associated with a particular VAC company.
      Parameters:
      companyUuid - the vac company uuid
      updateContractRequest - of changes to be made

    • updateVacCompany

      @PUT @Path("/{uuid}") @Consumes("application/json") com.iland.core.web.rest.response.task.TaskResponse updateVacCompany(@PathParam("uuid") String uuid, BaCompanyUpdateRequest baCompanyUpdateRequest)
      Update the VAC company.
      Parameters:
      uuid - the UUID of the vac company
      baCompanyUpdateRequest - VAC company update request

    • updateVacCompanyStorageQuota

      @PUT @Path("/{uuid}/actions/update-storage-quota") @Consumes("application/json") com.iland.core.web.rest.response.task.TaskResponse updateVacCompanyStorageQuota(@PathParam("uuid") String uuid, BaBackupResourceUpdateRequest baBackupResourceUpdateRequest)
      Update the VAC company's storage quota.

      Backup resource storage quota cannot exceed contracted value nor can be updated in a VAC company with multiple backup resources. Contact iland support to update storage quota in those cases.

      Parameters:
      uuid - the UUID of the vac company
      baBackupResourceUpdateRequest - backup resource update request

    • getVacBackupDirectories

      @GET @Path("/{uuid}/vac-backup-directories") @Consumes("application/json") BaBackupDirectoryListResponse getVacBackupDirectories(@PathParam("uuid") String uuid, @BeanParam BaBackupDirectoryFilterParams filterParams)
      Get a list of backup directories given a VAC company uuid.
      Parameters:
      uuid - the UUID of the vac company
      Returns:
      list of vac backup directories

    • getVacBackupFiles

      @GET @Path("/{uuid}/{backupDirectoryUuid}/vac-backup-files") @Consumes("application/json") BaBackupFileListResponse getVacBackupFiles(@PathParam("uuid") String uuid, @PathParam("backupDirectoryUuid") String backupDirectoryUuid, @BeanParam BaBackupFileFilterParams filterParams)
      Get a list of backup files given a VAC company uuid and backup directory uuid.
      Parameters:
      uuid - the UUID of the vac company
      backupDirectoryUuid - the UUID of the backup directory
      Returns:
      list of vac backup files

    • getVacCompanyJobs

      @GET @Path("/{uuid}/jobs") BaJobListResponse getVacCompanyJobs(@PathParam("uuid") String uuid)
      Get a list of VAC jobs for a given VAC company.
      Parameters:
      uuid - the UUID of a vac company
      Returns:
      a list of vac jobs for the given company

    • getVacCompanyCreationRequirements

      @GET @Path("/vac-company-creation-requirements") BaCompanyCreationRequirementsResponse getVacCompanyCreationRequirements()
      Get the minimum size for VAC company creation in GB.
      Returns:
      the minimum size of a VAC company creation in GB