com.iland.core.web.rest.api

Interface VacCompanyResource

All Superinterfaces:

Serializable

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

VAC Company resource.

Author:

Nick Kasprzak

Method Summary

Modifier and Type	Method and Description
BaCompanyBackupHistoryListResponse	getBackupHistoryFor(String companyUuid, Integer offset, Integer limit) Get the backup history for a given VAC company.
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.
BaCompanyResponse	getVacCompany(String uuid) Gets a VAC company by its uuid.
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.
BaCompanyResponse	updateVacCompany(String uuid, BaCompanyUpdateRequest baCompanyUpdateRequest) Update the VAC company.
void	updateVacCompanyStorageQuota(String uuid, BaBackupResourceUpdateRequest baBackupResourceUpdateRequest) Update the VAC company's storage quota.

Method Detail

getVacCompany

@GET
 @Path(value="/{uuid}")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
BaCompanyResponse getVacCompany(@PathParam(value="uuid")
                                                                                                                          String uuid)

Gets a VAC company by its uuid.

Parameters:

uuid - vac company uuid

Returns:

vac company

getStorageUsage

@GET
 @Path(value="/{uuid}/storage-usage")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
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")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+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

getBackupHistoryFor

@GET
 @Path(value="/{uuid}/backup-history")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
BaCompanyBackupHistoryListResponse getBackupHistoryFor(@PathParam(value="uuid")
                                                                                                                                                                String companyUuid,
                                                                                                                                                                @QueryParam(value="offset")
                                                                                                                                                                Integer offset,
                                                                                                                                                                @QueryParam(value="limit")
                                                                                                                                                                Integer limit)

Get the backup history for a given VAC company.

Offset and limit must be a positive integer. Limit's max value is 100. Default offset is 50 and default limit is 10.

Parameters:

companyUuid - the UUID of the vac company

offset - the offset

limit - the limit

Returns:

list of vac company backup history

requestContractUpgrade

@POST
 @Path(value="/{uuid}/actions/request-upgrade-contract")
 @Consumes(value="application/json")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+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")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
BaCompanyResponse 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")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
void 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