com.iland.core.web.rest.api

Interface VacCompanyResource

@Path(value="/vac-companies")
 @Consumes(value="application/json")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
public interface VacCompanyResource

VAC Company resource.

Author:

Nick Kasprzak

Method Summary

Modifier and Type	Method and Description
TaskResponse	deleteVacCompany(String uuid) Delete a VAC company given its uuid.
VacPerfSampleListResponse	getStorageUsage(String uuid, Long start, Long end, Integer limit, PerfIntervalRequest interval) Get the storage usage performance samples for a given company, timeframe and performance sampling interval.
BaBackupDirectoryListResponse	getVacBackupDirectories(String uuid, BaBackupDirectoryFilterParams filterParams) Get a list of backup directories given a VAC company uuid.
BaBackupFileListResponse	getVacBackupFiles(String uuid, String backupDirectoryUuid, BaBackupFileFilterParams filterParams) Get a list of backup files given a VAC company uuid and backup directory uuid.
BaCompanyResponse	getVacCompany(String uuid) Gets a VAC company by its uuid.
BaCompanyCreationRequirementsResponse	getVacCompanyCreationRequirements() Get the minimum size for VAC company creation in GB.
BaJobListResponse	getVacCompanyJobs(String uuid) Get a list of VAC jobs for a given VAC company.
void	requestContractUpgrade(String companyUuid, BaCompanyContractUpgradeRequest updateContractRequest) Upgrade the contract associated with a particular VAC company.
void	resetVacCompanyPassword(String uuid, BaCompanyPasswordResetRequest passwordResetRequest) Update the password for the VAC company.
TaskResponse	updateVacCompany(String uuid, BaCompanyUpdateRequest baCompanyUpdateRequest) Update the VAC company.
TaskResponse	updateVacCompanyStorageQuota(String uuid, BaBackupResourceUpdateRequest baBackupResourceUpdateRequest) Update the VAC company's storage quota.

Method Detail

getVacCompany

@GET
 @Path(value="/{uuid}")
BaCompanyResponse getVacCompany(@PathParam(value="uuid")
                                                             String uuid)

Gets a VAC company by its uuid.

Parameters:

uuid - vac company uuid

Returns:

vac company

deleteVacCompany

@DELETE
 @Path(value="/{uuid}")
TaskResponse deleteVacCompany(@PathParam(value="uuid")
                                                              String uuid)

Delete a VAC company given its uuid.

Parameters:

uuid - vac company uuid

Returns:

delete vac company task

getStorageUsage

@GET
 @Path(value="/{uuid}/storage-usage")
VacPerfSampleListResponse getStorageUsage(@PathParam(value="uuid")
                                                                                     String uuid,
                                                                                     @QueryParam(value="start")
                                                                                     Long start,
                                                                                     @QueryParam(value="end")
                                                                                     Long end,
                                                                                     @QueryParam(value="limit")
                                                                                     Integer limit,
                                                                                     @QueryParam(value="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(value="/{uuid}/actions/update-password")
 @Consumes(value="application/json")
void resetVacCompanyPassword(@PathParam(value="uuid")
                                                                                                                        String uuid,
                                                                                                                        BaCompanyPasswordResetRequest passwordResetRequest)

Update the password for the VAC company.

Parameters:

uuid - vac company uuid

passwordResetRequest - password reset request

requestContractUpgrade

@POST
 @Path(value="/{uuid}/actions/request-upgrade-contract")
 @Consumes(value="application/json")
void requestContractUpgrade(@PathParam(value="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(value="/{uuid}")
 @Consumes(value="application/json")
TaskResponse updateVacCompany(@PathParam(value="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(value="/{uuid}/actions/update-storage-quota")
 @Consumes(value="application/json")
TaskResponse updateVacCompanyStorageQuota(@PathParam(value="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(value="/{uuid}/vac-backup-directories")
 @Consumes(value="application/json")
BaBackupDirectoryListResponse getVacBackupDirectories(@PathParam(value="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(value="/{uuid}/{backupDirectoryUuid}/vac-backup-files")
 @Consumes(value="application/json")
BaBackupFileListResponse getVacBackupFiles(@PathParam(value="uuid")
                                                                                                                                                    String uuid,
                                                                                                                                                    @PathParam(value="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(value="/{uuid}/jobs")
BaJobListResponse getVacCompanyJobs(@PathParam(value="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(value="/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