com.iland.core.web.rest.api

Interface LocationResource

@Path(value="/locations")
 @Consumes(value="application/json")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
public interface LocationResource

Location ReST resource.

Author:

Cory Snyder

Method Summary

Modifier and Type	Method and Description
LocationListResponse	getLocations() Get all the locations.
Map<String,String>	getLocationsNames() Get location names.
CatalogListResponse	getPublicCatalogs(String locationId) Get the public catalogs for a data center location.
MediaListResponse	getPublicMedia(String locationId) Get the public media for a data center location.
VappTemplateListResponse	getPublicVappTemplates(String locationId) Get the public vapp templates for a data center location.
StatusResponse	getStatus(String locationId, ServiceStatusRequest service) Given a location, get the services status.
CurrencyCodeResponse	getVacBillingCurrencyCode(String locationId, String companyId) Get the VAC billing currency code for the given company id and location id.
VacContractListResponse	getVacContractsForCompany(String locationId, String companyId) Get the VAC contracts given the location id and company id.
VacCompanyQuotaStatusResponse	getVacQuotaStatus(String locationId, String companyId) Get the VAC quota status of a company which includes total storage quota, used storage quota and the contracted storage quota values.
VmConfigurationLimitsResponse	getVmConfigurationLimits(String locationId) Given a location, get the CPU, memory, and disk limits.
void	requestContractUpgrade(String locationId, String companyId, BaCompanyContractUpgradeRequest updateRequest) Request a VAC storage upgrade for given a company and it's location.

Method Detail

getPublicCatalogs

@GET
 @Path(value="/{location}/public-catalogs")
CatalogListResponse getPublicCatalogs(@PathParam(value="location")
                                                                                       String locationId)

Get the public catalogs for a data center location.

Parameters:

locationId - the location ID

Returns:

list of public catalogs

getPublicVappTemplates

@GET
 @Path(value="/{location}/public-vapp-templates")
VappTemplateListResponse getPublicVappTemplates(@PathParam(value="location")
                                                                                                       String locationId)

Get the public vapp templates for a data center location.

Parameters:

locationId - the location ID

Returns:

list of public vapp templates

getPublicMedia

@GET
 @Path(value="/{location}/public-media")
MediaListResponse getPublicMedia(@PathParam(value="location")
                                                                               String locationId)

Get the public media for a data center location.

Parameters:

locationId - the location ID

Returns:

list of public media

getStatus

@GET
 @Path(value="/{locationId}/status")
StatusResponse getStatus(@PathParam(value="locationId")
                                                                   String locationId,
                                                                   @QueryParam(value="service")
                                                                   ServiceStatusRequest service)

Given a location, get the services status.

Parameters:

locationId - a valid location identifier.

service - a ServiceStatusRequest

Returns:

service statuses

getVmConfigurationLimits

@GET
 @Path(value="/{locationId}/vm-configuration-limits")
VmConfigurationLimitsResponse getVmConfigurationLimits(@PathParam(value="locationId")
                                                                                                                  String locationId)

Given a location, get the CPU, memory, and disk limits.

Parameters:

locationId - location id

Returns:

cpu, memory and disk limits

getVacQuotaStatus

@GET
 @Path(value="/{locationId}/{companyId}/vac-storage-status")
VacCompanyQuotaStatusResponse getVacQuotaStatus(@PathParam(value="locationId")
                                                                                                                  String locationId,
                                                                                                                  @PathParam(value="companyId")
                                                                                                                  String companyId)

Get the VAC quota status of a company which includes total storage quota, used storage quota and the contracted storage quota values.

Parameters:

companyId - company id

locationId - location id

Returns:

vac quota status response

getVacBillingCurrencyCode

@GET
 @Path(value="/{locationId}/{companyId}/vac-currency-code")
CurrencyCodeResponse getVacBillingCurrencyCode(@PathParam(value="locationId")
                                                                                                                String locationId,
                                                                                                                @PathParam(value="companyId")
                                                                                                                String companyId)

Get the VAC billing currency code for the given company id and location id.

Parameters:

locationId - location id

companyId - company id

Returns:

vac billing currency code

getVacContractsForCompany

@GET
 @Path(value="/{locationId}/{companyId}/vac-contracts")
VacContractListResponse getVacContractsForCompany(@PathParam(value="locationId")
                                                                                                               String locationId,
                                                                                                               @PathParam(value="companyId")
                                                                                                               String companyId)

Get the VAC contracts given the location id and company id.

Parameters:

locationId - location id

companyId - company id

Returns:

vac contract list response

requestContractUpgrade

@POST
 @Path(value="/{locationId}/{companyId}/request-upgrade-contract")
void requestContractUpgrade(@PathParam(value="locationId")
                                                                                                     String locationId,
                                                                                                     @PathParam(value="companyId")
                                                                                                     String companyId,
                                                                                                     BaCompanyContractUpgradeRequest updateRequest)

Request a VAC storage upgrade for given a company and it's location.

Parameters:

locationId - location id id

companyId - company id

updateRequest - update request

getLocations

@GET
 @Path(value="/")
LocationListResponse getLocations()

Get all the locations.

Returns:

a list of all locations

getLocationsNames

@GET
 @Path(value="/names")
Map<String,String> getLocationsNames()

Get location names.

Returns:

a map of all locations