Package com.iland.core.web.rest.api

Interface CompanyLocationResource

All Superinterfaces:
com.iland.cohesity.iaas.backups.backupgroups.BackupGroupV2PlatformCompanyLocationApi, com.iland.cohesity.iaas.backups.protectionsources.ProtectionSourcePlatformCompanyLocationApi
@Path("/companies/{companyId}/location") @Consumes("application/json") @Produces("application/vnd.ilandcloud.api.v1.0+json") public interface CompanyLocationResource extends com.iland.cohesity.iaas.backups.backupgroups.BackupGroupV2PlatformCompanyLocationApi, com.iland.cohesity.iaas.backups.protectionsources.ProtectionSourcePlatformCompanyLocationApi
Company Location ReST resource.
Author:
Cory Snyder

  • Method Details

    • getOrgs

      @GET @Path("/{location}/orgs") OrgListResponse getOrgs(@PathParam("companyId") String companyId, @PathParam("location") String locationId)
      Get the orgs for a datacenter location.
      Parameters:
      locationId - the location ID
      Returns:
      list of orgs

    • getVdcs

      @GET @Path("/{location}/vdcs") VdcListResponse getVdcs(@PathParam("companyId") String companyId, @PathParam("location") String locationId)
      Get the vDCs for a datacenter location.
      Parameters:
      locationId - the location ID
      Returns:
      list of vDCs

    • getVapps

      @GET @Path("/{location}/vapps") VappListResponse getVapps(@PathParam("companyId") String companyId, @PathParam("location") String locationId)
      Get the vApps for a datacenter location.
      Parameters:
      locationId - the location ID
      Returns:
      list of vApps

    • getVms

      @GET @Path("/{location}/vms") VmListResponse getVms(@PathParam("companyId") String companyId, @PathParam("location") String locationId)
      Get the VMs for a datacenter location.
      Parameters:
      locationId - the location ID
      Returns:
      list of VMs

    • getMediaForCompany

      @GET @Path("/{location}/media") MediaListResponse getMediaForCompany(@PathParam("companyId") String companyId, @PathParam("location") String locationId)
      Get the media for a datacenter location.
      Parameters:
      locationId - the location ID
      Returns:
      list of media

    • getVappTemplatesForCompany

      @GET @Path("/{location}/vapp-templates") VappTemplateListResponse getVappTemplatesForCompany(@PathParam("companyId") String companyId, @PathParam("location") String locationId)
      Get the vApp templates for a datacenter location.
      Parameters:
      locationId - the location ID
      Returns:
      list of vApp templates

    • getEdges

      @GET @Path("/{location}/edges") EdgeListResponse getEdges(@PathParam("companyId") String companyId, @PathParam("location") String locationId)
      Get the edges for a datacenter location.
      Parameters:
      locationId - the location ID
      Returns:
      list of edges

    • getVpgs

      @GET @Path("/{location}/vpgs") ExpandedVpgListResponse getVpgs(@PathParam("companyId") String companyId, @PathParam("location") String locationId, @QueryParam("expand") List<VpgSubEntityRequest> expand)
      Get the VPGs for a datacenter location.
      Parameters:
      locationId - the location ID
      Returns:
      list of VPGs

    • getVacCompanies

      @GET @Path("/{location}/vac-companies") BaCompanySetResponse getVacCompanies(@PathParam("companyId") String companyId, @PathParam("location") String locationId)
      Get the vac companies for a datacenter location.
      Parameters:
      locationId - location id
      Returns:
      list of vac cloud comopanies

    • getOrgVdcNetworks

      @GET @Path("/{location}/org-vdc-networks") OrgVdcNetworkListResponse getOrgVdcNetworks(@PathParam("companyId") String companyId, @PathParam("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("/{location}/vapp-networks") VappNetworkListResponse getVappNetworks(@PathParam("companyId") String companyId, @PathParam("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("/{location}/catalogs") CatalogListResponse getCatalogs(@PathParam("companyId") String companyId, @PathParam("location") String locationId)
      Get the catalogs for the datacenter location.
      Parameters:
      locationId - the location ID
      Returns:
      a list of catalogs

    • createVacCompany

      @POST @Path("/{locationId}/actions/create-vac-company") @Consumes("application/json") com.iland.core.web.rest.response.task.TaskResponse createVacCompany(@PathParam("locationId") String locationId, @PathParam("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("/{location}/o365-organizations") O365OrganizationSetResponse getO365Organizations(@PathParam("companyId") String companyId, @PathParam("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("/{locationId}/o365-billing") O365BillSetResponse getO365BillingHistory(@PathParam("companyId") String companyId, @PathParam("locationId") String locationId, @QueryParam("startYear") Integer startYear, @QueryParam("startMonth") Integer startMonth, @QueryParam("endYear") Integer endYear, @QueryParam("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("/{locationId}/actions/create-o365-org") @Consumes("application/json") O365OrganizationResponse createO365Organization(@PathParam("companyId") String companyId, @PathParam("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("/{locationId}/get-o365-repos-unassigned") O365BackupRepositorySetResponse getVboRepositoryUnassigned(@PathParam("companyId") String companyId, @PathParam("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("/{locationId}/actions/get-o365-device-code") @Consumes("application/json") O365DeviceCodeResponse getO365DeviceCode(@PathParam("companyId") String companyId, @PathParam("locationId") String locationId, @QueryParam("repoId") String repoId)
      Get a device code response from Microsoft Azure to validate in the Microsoft authentication portal. This is to be used while creating an org.
      Parameters:
      companyId - iland company id
      locationId - the location id
      repoId - the backup repository id
      Returns:
      a O365DeviceCodeResponse instance

    • listProtectionSourcesForCompanyLocationDeprecated

      @GET @Path("/companies/{companyId}/location/{location}/{hostType: (\\*|linux|windows)}/{environment: (\\*|sql)}") @Produces("application/vnd.ilandcloud.api.v1.0+json") com.iland.cohesity.iaas.backups.common.model.ListResponse<com.iland.cohesity.iaas.backups.protectionsources.PublicProtectionSource> listProtectionSourcesForCompanyLocationDeprecated(@PathParam("companyId") com.iland.cohesity.iaas.backups.common.model.CompanyId companyId, @PathParam("location") com.iland.cohesity.iaas.backups.common.model.LocationId locationId, @PathParam("hostType") String hostType, @PathParam("environment") String environment)
      Deprecated.
      Get the protection sources for the given org.
      Parameters:
      companyId - company ID
      locationId - location ID
      hostType - e.g. "linux" or "windows"
      environment - e.g. "*" or "sql"
      Returns:
      a list of protection sources

    • listProtectionSourcesForCompanyLocation

      @GET @Path("/{location}/{hostType: (\\*|linux|windows)}/{environment: (\\*|sql)}") @Produces("application/vnd.ilandcloud.api.v1.0+json") com.iland.cohesity.iaas.backups.common.model.ListResponse<com.iland.cohesity.iaas.backups.protectionsources.PublicProtectionSource> listProtectionSourcesForCompanyLocation(@PathParam("companyId") com.iland.cohesity.iaas.backups.common.model.CompanyId companyId, @PathParam("location") com.iland.cohesity.iaas.backups.common.model.LocationId locationId, @PathParam("hostType") String hostType, @PathParam("environment") String environment)
      Get the protection sources for the given org.
      Specified by:
      listProtectionSourcesForCompanyLocation in interface com.iland.cohesity.iaas.backups.protectionsources.ProtectionSourcePlatformCompanyLocationApi
      Parameters:
      companyId - company ID
      locationId - location ID
      hostType - e.g. "linux" or "windows"
      environment - e.g. "*" or "sql"
      Returns:
      a list of protection sources

    • listSqlProtectionSourcesForCompanyLocation

      @GET @Path("/{location}/sql-protection-sources") @Produces("application/vnd.ilandcloud.api.v1.0+json") com.iland.cohesity.iaas.backups.common.model.ListResponse<com.iland.cohesity.iaas.backups.protectionsources.SqlProtectionSourceModel> listSqlProtectionSourcesForCompanyLocation(@PathParam("companyId") com.iland.cohesity.iaas.backups.common.model.CompanyId companyId, @PathParam("location") com.iland.cohesity.iaas.backups.common.model.LocationId locationId)
      Get the SQL protection sources for the given org.
      Specified by:
      listSqlProtectionSourcesForCompanyLocation in interface com.iland.cohesity.iaas.backups.protectionsources.ProtectionSourcePlatformCompanyLocationApi
      Parameters:
      companyId - company ID
      locationId - location ID
      Returns:
      a list of SQL protection sources

    • listOracleProtectionSourcesForCompanyLocation

      @GET @Path("/{location}/oracle-protection-sources") @Produces("application/vnd.ilandcloud.api.v1.0+json") com.iland.cohesity.iaas.backups.common.model.ListResponse<com.iland.cohesity.iaas.backups.protectionsources.OracleProtectionSourceModel> listOracleProtectionSourcesForCompanyLocation(@PathParam("companyId") com.iland.cohesity.iaas.backups.common.model.CompanyId companyId, @PathParam("location") com.iland.cohesity.iaas.backups.common.model.LocationId locationId)
      Get the Oracle protection sources for the given org.
      Specified by:
      listOracleProtectionSourcesForCompanyLocation in interface com.iland.cohesity.iaas.backups.protectionsources.ProtectionSourcePlatformCompanyLocationApi
      Parameters:
      companyId - company ID
      locationId - location ID
      Returns:
      a list of SQL protection sources

    • listBackupGroups

      @GET @Path("/{location}/backup-groups") BackupGroupListResponse listBackupGroups(@PathParam("companyId") String companyId, @PathParam("location") String locationId, @QueryParam("includeDeleted") boolean includeDeleted, @QueryParam("includeSummaryStats") boolean includeSummaryStats, @QueryParam("includeLastRun") boolean includeLastRun, @QueryParam("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

    • listV2BackupGroups

      @GET @Path("/{location}/backup-groups-x") com.iland.cohesity.iaas.backups.common.model.ListResponse<com.iland.cohesity.iaas.backups.backupgroups.api.modelx.BackupGroupV2> listV2BackupGroups(@PathParam("companyId") com.iland.cohesity.iaas.backups.common.model.CompanyId companyId, @PathParam("location") com.iland.cohesity.iaas.backups.common.model.LocationId locationId, @QueryParam("includeDeleted") boolean includeDeleted, @QueryParam("includeSummaryStats") boolean includeSummaryStats, @QueryParam("includeLastRun") boolean includeLastRun, @QueryParam("includeBackupPolicy") boolean includeBackupPolicy, @QueryParam("includeLegacyVMware") boolean includeLegacyVMware)
      List the existing backup groups that are configured in a specified company-location.
      Specified by:
      listV2BackupGroups in interface com.iland.cohesity.iaas.backups.backupgroups.BackupGroupV2PlatformCompanyLocationApi
      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
      includeLegacyVMware - weather to include legacy VMware backup groups
      Returns:
      list of backup groups

    • getBackupStatus

      @GET @Path("/{location}/iaas-backup-status") CompanyLocationBackupStatusResponse getBackupStatus(@PathParam("companyId") String companyId, @PathParam("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("/{location}/iaas-integrated-backup-status") CompanyLocationIntegratedBackupStatusResponse getIntegratedBackupStatus(@PathParam("companyId") String companyId, @PathParam("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("/{location}/o365-audit-log") O365AuditLogEventSetResponse getO365AuditLog(@PathParam("companyId") String companyId, @PathParam("location") String locationId, @QueryParam("page") Integer page, @QueryParam("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("/{location}/o365-backup-repositories") O365BackupRepositorySetResponse getVboBackupRepositories(@PathParam("companyId") String companyId, @PathParam("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("/{location}/vms-protection-status-summary") VmProtectionStatusSummaryResponse getVmProtectionSummary(@PathParam("companyId") String companyId, @PathParam("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