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

Interface BackupGroupV2Resource

All Superinterfaces:
com.iland.cohesity.iaas.backups.backupgroups.BackupGroupV2PlatformApi
@Path("/backup-groups-x") @Consumes("application/json") @Produces("application/vnd.ilandcloud.api.v1.0+json") public interface BackupGroupV2Resource extends com.iland.cohesity.iaas.backups.backupgroups.BackupGroupV2PlatformApi
Extended Backup Groups Public API.

  • Method Summary

    Modifier and Type
    Method
    Description
    com.iland.cohesity.iaas.backups.backupgroups.api.modelx.BackupGroupV2
    getBackupGroup(com.iland.cohesity.iaas.backups.common.model.BackupGroupUid backupGroupUid, boolean includeSummaryStats, boolean includeLastRun, boolean includeBackupPolicy)
    Gets a backup group.
    com.iland.cohesity.iaas.backups.backupgroups.api.modelx.BackupGroupV2
    setState(com.iland.cohesity.iaas.backups.common.model.BackupGroupUid backupGroupUid, com.iland.cohesity.iaas.backups.backupgroups.api.modelx.BackupGroupStateParams request)
    Pause or resume a backup group.
    com.iland.cohesity.iaas.backups.backupgroups.api.modelx.BackupGroupV2
    updateBackupGroup(com.iland.cohesity.iaas.backups.common.model.BackupGroupUid backupGroupUid, com.iland.cohesity.iaas.backups.backupgroups.api.modelx.BlockBasedBackupGroupWithCommonParams updateRequest)
    Update a block-based backup group.
    com.iland.cohesity.iaas.backups.backupgroups.api.modelx.BackupGroupV2
    updateBackupGroup(com.iland.cohesity.iaas.backups.common.model.BackupGroupUid backupGroupUid, com.iland.cohesity.iaas.backups.backupgroups.api.modelx.FileBasedBackupGroupWithCommonParams updateRequest)
    Update a file-based backup group.
    com.iland.cohesity.iaas.backups.backupgroups.api.modelx.BackupGroupV2
    updateBackupGroup(com.iland.cohesity.iaas.backups.common.model.BackupGroupUid backupGroupUid, com.iland.cohesity.iaas.backups.backupgroups.api.modelx.MssqlFileBasedBackupGroupWithCommonParams updateRequest)
    Update a MSSQL file-based backup group.
    com.iland.cohesity.iaas.backups.backupgroups.api.modelx.BackupGroupV2
    updateBackupGroup(com.iland.cohesity.iaas.backups.common.model.BackupGroupUid backupGroupUid, com.iland.cohesity.iaas.backups.backupgroups.api.modelx.MssqlNativeBasedBackupGroupWithCommonParams updateRequest)
    Update a MSSQL native-based backup group.
    com.iland.cohesity.iaas.backups.backupgroups.api.modelx.BackupGroupV2
    updateBackupGroup(com.iland.cohesity.iaas.backups.common.model.BackupGroupUid backupGroupUid, com.iland.cohesity.iaas.backups.backupgroups.api.modelx.MssqlVolumeBasedBackupGroupWithCommonParams updateRequest)
    Update a MSSQL volume-based backup group.
    com.iland.cohesity.iaas.backups.backupgroups.api.modelx.BackupGroupV2
    updateBackupGroup(com.iland.cohesity.iaas.backups.common.model.BackupGroupUid backupGroupUid, com.iland.cohesity.iaas.backups.backupgroups.api.modelx.OracleBasedBackupGroupWithCommonParams updateRequest)
    Update a Oracle native-based backup group.

  • Method Details

    • getBackupGroup

      @GET @Path("/{backupGroupUid}") com.iland.cohesity.iaas.backups.backupgroups.api.modelx.BackupGroupV2 getBackupGroup(@PathParam("backupGroupUid") com.iland.cohesity.iaas.backups.common.model.BackupGroupUid backupGroupUid, @QueryParam("includeSummaryStats") boolean includeSummaryStats, @QueryParam("includeLastRun") boolean includeLastRun, @QueryParam("includeBackupPolicy") boolean includeBackupPolicy)
      Gets a backup group.
      Specified by:
      getBackupGroup in interface com.iland.cohesity.iaas.backups.backupgroups.BackupGroupV2PlatformApi
      Parameters:
      backupGroupUid - the BackupGroupUid
      Returns:
      a backup group
      Throws:
      javax.ws.rs.NotFoundException - if the backup group is not found

    • updateBackupGroup

      @PUT @Path("/{backupGroupUid}/file") @Consumes("application/json") com.iland.cohesity.iaas.backups.backupgroups.api.modelx.BackupGroupV2 updateBackupGroup(@PathParam("backupGroupUid") com.iland.cohesity.iaas.backups.common.model.BackupGroupUid backupGroupUid, com.iland.cohesity.iaas.backups.backupgroups.api.modelx.FileBasedBackupGroupWithCommonParams updateRequest)
      Update a file-based backup group.
      Specified by:
      updateBackupGroup in interface com.iland.cohesity.iaas.backups.backupgroups.BackupGroupV2PlatformApi
      Parameters:
      backupGroupUid - the UID of the backup group
      updateRequest - the update request body
      Returns:
      BackupGroupResponse
      Throws:
      javax.ws.rs.NotFoundException - if the backup group is not found

    • updateBackupGroup

      @PUT @Path("/{backupGroupUid}/block") @Consumes("application/json") com.iland.cohesity.iaas.backups.backupgroups.api.modelx.BackupGroupV2 updateBackupGroup(@PathParam("backupGroupUid") com.iland.cohesity.iaas.backups.common.model.BackupGroupUid backupGroupUid, com.iland.cohesity.iaas.backups.backupgroups.api.modelx.BlockBasedBackupGroupWithCommonParams updateRequest)
      Update a block-based backup group.
      Specified by:
      updateBackupGroup in interface com.iland.cohesity.iaas.backups.backupgroups.BackupGroupV2PlatformApi
      Parameters:
      backupGroupUid - the UID of the backup group
      updateRequest - the update request body
      Returns:
      BackupGroupResponse
      Throws:
      javax.ws.rs.NotFoundException - if the backup group is not found

    • updateBackupGroup

      @PUT @Path("/{backupGroupUid}/mssql/file") @Consumes("application/json") com.iland.cohesity.iaas.backups.backupgroups.api.modelx.BackupGroupV2 updateBackupGroup(@PathParam("backupGroupUid") com.iland.cohesity.iaas.backups.common.model.BackupGroupUid backupGroupUid, com.iland.cohesity.iaas.backups.backupgroups.api.modelx.MssqlFileBasedBackupGroupWithCommonParams updateRequest)
      Update a MSSQL file-based backup group.
      Specified by:
      updateBackupGroup in interface com.iland.cohesity.iaas.backups.backupgroups.BackupGroupV2PlatformApi
      Parameters:
      backupGroupUid - the UID of the backup group
      updateRequest - the update request body
      Returns:
      BackupGroupResponse
      Throws:
      javax.ws.rs.NotFoundException - if the backup group is not found

    • updateBackupGroup

      @PUT @Path("/{backupGroupUid}/mssql/volume") @Consumes("application/json") com.iland.cohesity.iaas.backups.backupgroups.api.modelx.BackupGroupV2 updateBackupGroup(@PathParam("backupGroupUid") com.iland.cohesity.iaas.backups.common.model.BackupGroupUid backupGroupUid, com.iland.cohesity.iaas.backups.backupgroups.api.modelx.MssqlVolumeBasedBackupGroupWithCommonParams updateRequest)
      Update a MSSQL volume-based backup group.
      Specified by:
      updateBackupGroup in interface com.iland.cohesity.iaas.backups.backupgroups.BackupGroupV2PlatformApi
      Parameters:
      backupGroupUid - the UID of the backup group
      updateRequest - the update request body
      Returns:
      BackupGroupResponse
      Throws:
      javax.ws.rs.NotFoundException - if the backup group is not found

    • updateBackupGroup

      @PUT @Path("/{backupGroupUid}/mssql/native") @Consumes("application/json") com.iland.cohesity.iaas.backups.backupgroups.api.modelx.BackupGroupV2 updateBackupGroup(@PathParam("backupGroupUid") com.iland.cohesity.iaas.backups.common.model.BackupGroupUid backupGroupUid, com.iland.cohesity.iaas.backups.backupgroups.api.modelx.MssqlNativeBasedBackupGroupWithCommonParams updateRequest)
      Update a MSSQL native-based backup group.
      Specified by:
      updateBackupGroup in interface com.iland.cohesity.iaas.backups.backupgroups.BackupGroupV2PlatformApi
      Parameters:
      backupGroupUid - the UID of the backup group
      updateRequest - the update request body
      Returns:
      BackupGroupResponse
      Throws:
      javax.ws.rs.NotFoundException - if the backup group is not found

    • updateBackupGroup

      @PUT @Path("/{backupGroupUid}/oracle") @Consumes("application/json") com.iland.cohesity.iaas.backups.backupgroups.api.modelx.BackupGroupV2 updateBackupGroup(@PathParam("backupGroupUid") com.iland.cohesity.iaas.backups.common.model.BackupGroupUid backupGroupUid, com.iland.cohesity.iaas.backups.backupgroups.api.modelx.OracleBasedBackupGroupWithCommonParams updateRequest)
      Update a Oracle native-based backup group.
      Specified by:
      updateBackupGroup in interface com.iland.cohesity.iaas.backups.backupgroups.BackupGroupV2PlatformApi
      Parameters:
      backupGroupUid - the UID of the backup group
      updateRequest - the update request body
      Returns:
      BackupGroupResponse
      Throws:
      javax.ws.rs.NotFoundException - if the backup group is not found

    • setState

      @POST @Path("/{backupGroupUid}/state") com.iland.cohesity.iaas.backups.backupgroups.api.modelx.BackupGroupV2 setState(@PathParam("backupGroupUid") com.iland.cohesity.iaas.backups.common.model.BackupGroupUid backupGroupUid, com.iland.cohesity.iaas.backups.backupgroups.api.modelx.BackupGroupStateParams request)
      Pause or resume a backup group. After a backup group is paused, no new runs will be started but any existing runs will continue to execute.
      Specified by:
      setState in interface com.iland.cohesity.iaas.backups.backupgroups.BackupGroupV2PlatformApi
      Parameters:
      backupGroupUid - the UID of the backup group
      request - request containing the desired backup group state
      Returns:
      the updated BackupGroupV2
      Throws:
      javax.ws.rs.NotFoundException - if the backup group is not found