com.iland.cohesity.iaas.backups.backupgroups

Interface BackupGroupApi

public interface BackupGroupApi

API for retrieving, updating, and deleting backup groups. A backup group represents a grouping of virtual servers that are configured with common backup attributes.

Author:

Cory Snyder

Method Summary

Modifier and Type	Method and Description
BackupGroup	createBackupGroup(VdcUuid vdcUuid, BackupGroupParams params) Creates a new backup group within a designated vCloud vDC.
void	deleteBackupGroup(BackupGroupUid backupGroupUid, BackupGroupDeletionParams params) Deletes a backup group.
Optional<BackupGroup>	getBackupGroup(BackupGroupUid backupGroupUid) Gets a vCloud backup group.
Stream<BackupGroup>	listBackupGroupsForCompanyLocation(CompanyId companyId, LocationId locationId) Lists backup groups that exist within a company-location.
Stream<BackupGroup>	listBackupGroupsForLocation(LocationId locationId) Lists backup groups that exist for a vCloud instance in a specified location.
Stream<BackupGroup>	listBackupGroupsForOrg(OrgUuid orgUuid) Lists backup groups that exist within a vCloud org.
Stream<BackupGroup>	listBackupGroupsForVdc(VdcUuid vdcUuid) Lists backup groups that exist within a vCloud vDC.
BackupGroup	updateBackupGroup(BackupGroupUid backupGroupUid, BackupGroupParams params) Updates the configuration of an existing backup group.

Method Detail

getBackupGroup

Optional<BackupGroup> getBackupGroup(BackupGroupUid backupGroupUid)

Gets a vCloud backup group.

Parameters:

backupGroupUid - the BackupGroupUid

Returns:

Optional of BackupGroup. An empty optional indicates that the backup group was not found.

listBackupGroupsForLocation

Stream<BackupGroup> listBackupGroupsForLocation(LocationId locationId)

Lists backup groups that exist for a vCloud instance in a specified location.

Parameters:

locationId - the LocationId

Returns:

Stream of BackupGroup

listBackupGroupsForOrg

Stream<BackupGroup> listBackupGroupsForOrg(OrgUuid orgUuid)

Lists backup groups that exist within a vCloud org.

Parameters:

orgUuid - the OrgUuid

Returns:

Stream of BackupGroup

listBackupGroupsForVdc

Stream<BackupGroup> listBackupGroupsForVdc(VdcUuid vdcUuid)

Lists backup groups that exist within a vCloud vDC.

Parameters:

vdcUuid - the VdcUuid

Returns:

Stream of BackupGroup.

listBackupGroupsForCompanyLocation

Stream<BackupGroup> listBackupGroupsForCompanyLocation(CompanyId companyId,
                                                       LocationId locationId)

Lists backup groups that exist within a company-location.

Returns:

@link Stream} of BackupGroup.

createBackupGroup

BackupGroup createBackupGroup(VdcUuid vdcUuid,
                              BackupGroupParams params)

Creates a new backup group within a designated vCloud vDC.

Parameters:

vdcUuid - the VdcUuid

params - the BackupGroupParams

Returns:

the new BackupGroup

Throws:

ValidationException - if there is a problem during request validation

updateBackupGroup

BackupGroup updateBackupGroup(BackupGroupUid backupGroupUid,
                              BackupGroupParams params)

Updates the configuration of an existing backup group.

Parameters:

backupGroupUid - the BackupGroupUid

params - the BackupGroupParams

Returns:

the updated BackupGroup

Throws:

ValidationException - if there is a problem during request validation

deleteBackupGroup

void deleteBackupGroup(BackupGroupUid backupGroupUid,
                       BackupGroupDeletionParams params)

Deletes a backup group.

Parameters:

backupGroupUid - the BackupGroupUid

params - the BackupGroupDeletionParams