CompanyLocationResource (iland cloud Java SDK 1.0.45 API)

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

Company Location ReST resource.

Author:: Cory Snyder

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`O365OrganizationResponse`	`createO365Organization(String companyId, String locationId, O365OrganizationCreateModifyRequest request)` Add a Microsoft Office 365 VBO organization.
`TaskResponse`	`createVacCompany(String locationId, String companyId, BaCompanyCreateRequest baCompanyCreateRequest)` Create a VAC company.
`CompanyLocationBackupStatusResponse`	`getBackupStatus(String companyId, String locationId)` Gets the backup status of entities within the company-location.
`CatalogListResponse`	`getCatalogs(String companyId, String locationId)` Get the catalogs for the datacenter location.
`EdgeListResponse`	`getEdges(String companyId, String locationId)` Get the edges for a datacenter location.
`CompanyLocationIntegratedBackupStatusResponse`	`getIntegratedBackupStatus(String companyId, String locationId)` Gets the integrated backup status of entities within the company-location.
`MediaListResponse`	`getMediaForCompany(String companyId, String locationId)` Get the media for a datacenter location.
`O365AuditLogEventSetResponse`	`getO365AuditLog(String companyId, String locationId, Integer page, Integer pageSize)` Get the Office 365 VBO audit log given a company and location.
`O365BillSetResponse`	`getO365BillingHistory(String companyId, String locationId, Integer startYear, Integer startMonth, Integer endYear, Integer endMonth)` Get the historical Office 365 billing for a given company.
`O365DeviceCodeResponse`	`getO365DeviceCode(String companyId, String locationId)` Get a device code response from Microsoft Azure to validate in the Microsoft authentication portal.
`O365OrganizationSetResponse`	`getO365Organizations(String companyId, String locationId)` Get the Office 365 VBO Organizations given a company and 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.
`BaCompanySetResponse`	`getVacCompanies(String companyId, String locationId)` Get the vac companies for a 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.
`O365BackupRepositorySetResponse`	`getVboBackupRepositories(String companyId, String locationId)` Get Office 365 VBO backup repositories for the company and location.
`O365BackupRepositorySetResponse`	`getVboRepositoryUnassigned(String companyId, String locationId)` Get a list of Vbo Repositories for the company not assigned to any org, if any exists.
`VdcListResponse`	`getVdcs(String companyId, String locationId)` Get the vDCs for a datacenter location.
`VmProtectionStatusSummaryResponse`	`getVmProtectionSummary(String companyId, String locationId)` Get the number of VMs protected and unprotected for a given company, location and user making request.
`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.
`BackupGroupListResponse`	`listBackupGroups(String companyId, String locationId, boolean includeDeleted, boolean includeSummaryStats, boolean includeLastRun, boolean includeBackupPolicy)` List the existing backup groups that are configured in a specified company-location.

Method Detail

getOrgs

@GET
 @Path(value="/{location}/orgs")
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")
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")
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")
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")
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")
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")
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")
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

getVacCompanies

@GET
 @Path(value="/{location}/vac-companies")
BaCompanySetResponse getVacCompanies(@PathParam(value="companyId")
                                                                                    String companyId,
                                                                                    @PathParam(value="location")
                                                                                    String locationId)

Get the vac companies for a datacenter location.

Parameters:: locationId - location id
Returns:: list of vac cloud comopanies

getOrgVdcNetworks

@GET
 @Path(value="/{location}/org-vdc-networks")
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")
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")
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

createVacCompany

@POST
 @Path(value="/{locationId}/actions/create-vac-company")
 @Consumes(value="application/json")
TaskResponse createVacCompany(@PathParam(value="locationId")
                                                                                                                                  String locationId,
                                                                                                                                  @PathParam(value="companyId")
                                                                                                                                  String companyId,
                                                                                                                                  BaCompanyCreateRequest baCompanyCreateRequest)

Create a VAC company.

Parameters:: locationId - location id; companyId - iland company id; baCompanyCreateRequest - backup company create request
Returns:: create VAC company task response

getO365Organizations

@GET
 @Path(value="/{location}/o365-organizations")
O365OrganizationSetResponse getO365Organizations(@PathParam(value="companyId")
                                                                                                     String companyId,
                                                                                                     @PathParam(value="location")
                                                                                                     String locationId)

Get the Office 365 VBO Organizations given a company and location.

Parameters:: companyId - the company identifier (aka CRM # id); locationId - the location identifier
Returns:: a O365OrganizationSetResponse instance.

getO365BillingHistory

@GET
 @Path(value="/{locationId}/o365-billing")
O365BillSetResponse getO365BillingHistory(@PathParam(value="companyId")
                                                                                          String companyId,
                                                                                          @PathParam(value="locationId")
                                                                                          String locationId,
                                                                                          @QueryParam(value="startYear")
                                                                                          Integer startYear,
                                                                                          @QueryParam(value="startMonth")
                                                                                          Integer startMonth,
                                                                                          @QueryParam(value="endYear")
                                                                                          Integer endYear,
                                                                                          @QueryParam(value="endMonth")
                                                                                          Integer endMonth)

Get the historical Office 365 billing for a given company.

Parameters:: companyId - the company identifier; locationId - the location identifier; startYear - the year to start; startMonth - the month to start (1-12); endYear - the year to end with; endMonth - the month to end (1-12)
Returns:: set of office 365 bills

createO365Organization

@POST
 @Path(value="/{locationId}/actions/create-o365-org")
 @Consumes(value="application/json")
O365OrganizationResponse createO365Organization(@PathParam(value="companyId")
                                                                                                                                                 String companyId,
                                                                                                                                                 @PathParam(value="locationId")
                                                                                                                                                 String locationId,
                                                                                                                                                 O365OrganizationCreateModifyRequest request)

Add a Microsoft Office 365 VBO organization. This only supports the Office365 online type and not on-premises / hybrid type.

Parameters:: companyId - iland company id; locationId - the location id; request - the organization create request
Returns:: a O365OrganizationResponse instance

getVboRepositoryUnassigned

@GET
 @Path(value="/{locationId}/get-o365-repos-unassigned")
O365BackupRepositorySetResponse getVboRepositoryUnassigned(@PathParam(value="companyId")
                                                                                                                        String companyId,
                                                                                                                        @PathParam(value="locationId")
                                                                                                                        String locationId)

Get a list of Vbo Repositories for the company not assigned to any org, if any exists.

Parameters:: companyId - iland company id; locationId - the location id
Returns:: a O365BackupRepositorySetResponse instance

getO365DeviceCode

@GET
 @Path(value="/{locationId}/actions/get-o365-device-code")
 @Consumes(value="application/json")
O365DeviceCodeResponse getO365DeviceCode(@PathParam(value="companyId")
                                                                                                                                              String companyId,
                                                                                                                                              @PathParam(value="locationId")
                                                                                                                                              String locationId)

Get a device code response from Microsoft Azure to validate in the Microsoft authentication portal. This is to be used while creating an org.

Returns:: a O365DeviceCodeResponse instance

listBackupGroups

@GET
 @Path(value="/{location}/backup-groups")
BackupGroupListResponse listBackupGroups(@PathParam(value="companyId")
                                                                                        String companyId,
                                                                                        @PathParam(value="location")
                                                                                        String locationId,
                                                                                        @QueryParam(value="includeDeleted")
                                                                                        boolean includeDeleted,
                                                                                        @QueryParam(value="includeSummaryStats")
                                                                                        boolean includeSummaryStats,
                                                                                        @QueryParam(value="includeLastRun")
                                                                                        boolean includeLastRun,
                                                                                        @QueryParam(value="includeBackupPolicy")
                                                                                        boolean includeBackupPolicy)

List the existing backup groups that are configured in a specified company-location.

Parameters:: locationId - the location ID; companyId - the company ID; includeDeleted - whether to include deleted backup groups; includeSummaryStats - whether to include backup summary stats; includeLastRun - whether to include last run info in the response; includeBackupPolicy - whether to include backup policy info in the response
Returns:: BackupGroupListResponse

getBackupStatus

@GET
 @Path(value="/{location}/iaas-backup-status")
CompanyLocationBackupStatusResponse getBackupStatus(@PathParam(value="companyId")
                                                                                                        String companyId,
                                                                                                        @PathParam(value="location")
                                                                                                        String locationId)

Gets the backup status of entities within the company-location.

Parameters:: locationId - the location ID; companyId - the company ID
Returns:: backup status details

getIntegratedBackupStatus

@GET
 @Path(value="/{location}/iaas-integrated-backup-status")
CompanyLocationIntegratedBackupStatusResponse getIntegratedBackupStatus(@PathParam(value="companyId")
                                                                                                                                       String companyId,
                                                                                                                                       @PathParam(value="location")
                                                                                                                                       String locationId)

Gets the integrated backup status of entities within the company-location.

Parameters:: locationId - the location ID; companyId - the company ID
Returns:: backup status details

getO365AuditLog

@GET
 @Path(value="/{location}/o365-audit-log")
O365AuditLogEventSetResponse getO365AuditLog(@PathParam(value="companyId")
                                                                                             String companyId,
                                                                                             @PathParam(value="location")
                                                                                             String locationId,
                                                                                             @QueryParam(value="page")
                                                                                             Integer page,
                                                                                             @QueryParam(value="pageSize")
                                                                                             Integer pageSize)

Get the Office 365 VBO audit log given a company and location.

Parameters:: companyId - the company identifier (aka CRM # id); locationId - the location identifier; page - the page number; pageSize - the page size
Returns:: office 365 audit log

getVboBackupRepositories

@GET
 @Path(value="/{location}/o365-backup-repositories")
O365BackupRepositorySetResponse getVboBackupRepositories(@PathParam(value="companyId")
                                                                                                                   String companyId,
                                                                                                                   @PathParam(value="location")
                                                                                                                   String locationId)

Get Office 365 VBO backup repositories for the company and location.

Parameters:: companyId - the company identifier (aka CRM # id); locationId - the location identifier
Returns:: the O365BackupRepositorySetResponse

getVmProtectionSummary

@GET
 @Path(value="/{location}/vms-protection-status-summary")
VmProtectionStatusSummaryResponse getVmProtectionSummary(@PathParam(value="companyId")
                                                                                                                        String companyId,
                                                                                                                        @PathParam(value="location")
                                                                                                                        String locationId)

Get the number of VMs protected and unprotected for a given company, location and user making request.

Parameters:: companyId - the company identifier (aka CRM # id); locationId - the location identifier
Returns:: number of protected and unprotected VMs

Interface CompanyLocationResource