com.iland.core.web.rest.api

Interface CompanyLocationResource

All Superinterfaces:

Serializable

@Path(value="/companies/{companyId}/location")
 @Consumes(value="application/json")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
public interface CompanyLocationResource
extends Serializable

Company Location ReST resource.

Author:

Cory Snyder

Method Summary

Modifier and Type	Method and Description
CatalogListResponse	getCatalogs(String companyId, String locationId) Get the catalogs for the datacenter location.
VccBackupTenantListResponse	getCloudTenants(String companyId, String locationId) Get the vcc cloud tenants for a datacenter location.
EdgeListResponse	getEdges(String companyId, String locationId) Get the edges for a datacenter location.
MediaListResponse	getMediaForCompany(String companyId, String locationId) Get the media for a datacenter location.
OrgListResponse	getOrgs(String companyId, String locationId) Get the orgs for a datacenter location.
OrgVdcNetworkListResponse	getOrgVdcNetworks(String companyId, String locationId) Get the org vdc networks for the datacenter location.
VappNetworkListResponse	getVappNetworks(String companyId, String locationId) Get the vapp networks for the datacenter location.
VappListResponse	getVapps(String companyId, String locationId) Get the vApps for a datacenter location.
VappTemplateListResponse	getVappTemplatesForCompany(String companyId, String locationId) Get the vApp templates for a datacenter location.
VdcListResponse	getVdcs(String companyId, String locationId) Get the vDCs for a datacenter location.
VmListResponse	getVms(String companyId, String locationId) Get the VMs for a datacenter location.
ExpandedVpgListResponse	getVpgs(String companyId, String locationId, List<VpgSubEntityRequest> expand) Get the VPGs for a datacenter location.

Method Detail

getOrgs

@GET
 @Path(value="/{location}/orgs")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
OrgListResponse getOrgs(@PathParam(value="companyId")
                                                                                                                           String companyId,
                                                                                                                           @PathParam(value="location")
                                                                                                                           String locationId)

Get the orgs for a datacenter location.

Parameters:

locationId - the location ID

Returns:

list of orgs

getVdcs

@GET
 @Path(value="/{location}/vdcs")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
VdcListResponse getVdcs(@PathParam(value="companyId")
                                                                                                                           String companyId,
                                                                                                                           @PathParam(value="location")
                                                                                                                           String locationId)

Get the vDCs for a datacenter location.

Parameters:

locationId - the location ID

Returns:

list of vDCs

getVapps

@GET
 @Path(value="/{location}/vapps")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
VappListResponse getVapps(@PathParam(value="companyId")
                                                                                                                              String companyId,
                                                                                                                              @PathParam(value="location")
                                                                                                                              String locationId)

Get the vApps for a datacenter location.

Parameters:

locationId - the location ID

Returns:

list of vApps

getVms

@GET
 @Path(value="/{location}/vms")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
VmListResponse getVms(@PathParam(value="companyId")
                                                                                                                        String companyId,
                                                                                                                        @PathParam(value="location")
                                                                                                                        String locationId)

Get the VMs for a datacenter location.

Parameters:

locationId - the location ID

Returns:

list of VMs

getMediaForCompany

@GET
 @Path(value="/{location}/media")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
MediaListResponse getMediaForCompany(@PathParam(value="companyId")
                                                                                                                                         String companyId,
                                                                                                                                         @PathParam(value="location")
                                                                                                                                         String locationId)

Get the media for a datacenter location.

Parameters:

locationId - the location ID

Returns:

list of media

getVappTemplatesForCompany

@GET
 @Path(value="/{location}/vapp-templates")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
VappTemplateListResponse getVappTemplatesForCompany(@PathParam(value="companyId")
                                                                                                                                                                 String companyId,
                                                                                                                                                                 @PathParam(value="location")
                                                                                                                                                                 String locationId)

Get the vApp templates for a datacenter location.

Parameters:

locationId - the location ID

Returns:

list of vApp templates

getEdges

@GET
 @Path(value="/{location}/edges")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
EdgeListResponse getEdges(@PathParam(value="companyId")
                                                                                                                              String companyId,
                                                                                                                              @PathParam(value="location")
                                                                                                                              String locationId)

Get the edges for a datacenter location.

Parameters:

locationId - the location ID

Returns:

list of edges

getVpgs

@GET
 @Path(value="/{location}/vpgs")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
ExpandedVpgListResponse getVpgs(@PathParam(value="companyId")
                                                                                                                                   String companyId,
                                                                                                                                   @PathParam(value="location")
                                                                                                                                   String locationId,
                                                                                                                                   @QueryParam(value="expand")
                                                                                                                                   List<VpgSubEntityRequest> expand)

Get the VPGs for a datacenter location.

Parameters:

locationId - the location ID

Returns:

list of VPGs

getCloudTenants

@GET
 @Path(value="/{location}/vcc-backup-tenants")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
VccBackupTenantListResponse getCloudTenants(@PathParam(value="companyId")
                                                                                                                                                             String companyId,
                                                                                                                                                             @PathParam(value="location")
                                                                                                                                                             String locationId)

Get the vcc cloud tenants for a datacenter location.

Parameters:

locationId - the location ID

Returns:

list of cloud tenants

getOrgVdcNetworks

@GET
 @Path(value="/{location}/org-vdc-networks")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
OrgVdcNetworkListResponse getOrgVdcNetworks(@PathParam(value="companyId")
                                                                                                                                                           String companyId,
                                                                                                                                                           @PathParam(value="location")
                                                                                                                                                           String locationId)

Get the org vdc networks for the datacenter location.

Parameters:

locationId - the location ID

Returns:

a list of org vdc networks

getVappNetworks

@GET
 @Path(value="/{location}/vapp-networks")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
VappNetworkListResponse getVappNetworks(@PathParam(value="companyId")
                                                                                                                                                    String companyId,
                                                                                                                                                    @PathParam(value="location")
                                                                                                                                                    String locationId)

Get the vapp networks for the datacenter location.

Parameters:

locationId - the location ID

Returns:

a list of org vdc networks

getCatalogs

@GET
 @Path(value="/{location}/catalogs")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
CatalogListResponse getCatalogs(@PathParam(value="companyId")
                                                                                                                                       String companyId,
                                                                                                                                       @PathParam(value="location")
                                                                                                                                       String locationId)

Get the catalogs for the datacenter location.

Parameters:

locationId - the location ID

Returns:

a list of catalogs