com.iland.cohesity.iaas.backups.backupgroups

Interface BackupGroupRunsApi

public interface BackupGroupRunsApi

Exposes information related to backup group runs.

Author:

Cory Snyder

Method Summary

Modifier and Type	Method and Description
Optional<BackupGroupRun>	getBackupGroupRun(BackupRunUid backupRunUid) Gets a backup group run.
Optional<BackupGroupRun>	getLastBackupGroupRun(BackupGroupUid backupGroupUid) Gets the last backup group run for a specified backup group.
Stream<BackupGroupRun>	listBackupGroupRuns(VdcUuid vdcUuid, ListBackupGroupRunsParams params) Lists all backup group runs for a vDC, with optional parameters that permit further filtering.
Stream<BackupGroupRun>	listLastBackupGroupRunsForCompanyLocation(CompanyId companyId, LocationId locationId) Lists all backup group runs for all backup groups in a specified company-location.
Stream<BackupGroupRun>	listLastBackupGroupRunsForOrg(OrgUuid orgUuid) Lists the last backup group runs for all backup groups in a specified org.
Stream<BackupGroupRun>	listLastBackupGroupRunsForVdc(VdcUuid vdcUuid) Lists the last backup group runs for all backup groups in a specified VDC.
Stream<BackupGroupRun>	listLocationBackupGroupRuns(LocationId locationId, ListLocationBackupGroupRunsParams params) Lists all backup group runs for a vDC that have non-deleted snapshots, with optional parameters that permit further filtering.

Method Detail

getBackupGroupRun

Optional<BackupGroupRun> getBackupGroupRun(BackupRunUid backupRunUid)

Gets a backup group run.

Parameters:

backupRunUid - BackupRunUid

Returns:

Optional of BackupGroupRun

listBackupGroupRuns

Stream<BackupGroupRun> listBackupGroupRuns(VdcUuid vdcUuid,
                                           ListBackupGroupRunsParams params)

Lists all backup group runs for a vDC, with optional parameters that permit further filtering.

Parameters:

vdcUuid - VdcUuid

params - ListBackupGroupRunsParams

Returns:

Stream of BackupGroupRun

listLocationBackupGroupRuns

Stream<BackupGroupRun> listLocationBackupGroupRuns(LocationId locationId,
                                                   ListLocationBackupGroupRunsParams params)

Lists all backup group runs for a vDC that have non-deleted snapshots, with optional parameters that permit further filtering.

Parameters:

locationId - LocationId

params - ListLocationBackupGroupRunsParams

Returns:

Stream of BackupGroupRun

getLastBackupGroupRun

Optional<BackupGroupRun> getLastBackupGroupRun(BackupGroupUid backupGroupUid)

Gets the last backup group run for a specified backup group.

Parameters:

backupGroupUid - BackupGroupUid

Returns:

Optional of BackupGroupRun

listLastBackupGroupRunsForVdc

Stream<BackupGroupRun> listLastBackupGroupRunsForVdc(VdcUuid vdcUuid)

Lists the last backup group runs for all backup groups in a specified VDC.

Parameters:

vdcUuid - VdcUuid

Returns:

Stream of BackupGroupRun

listLastBackupGroupRunsForOrg

Stream<BackupGroupRun> listLastBackupGroupRunsForOrg(OrgUuid orgUuid)

Lists the last backup group runs for all backup groups in a specified org.

Parameters:

orgUuid - OrgUuid

Returns:

Stream of BackupGroupRun

listLastBackupGroupRunsForCompanyLocation

Stream<BackupGroupRun> listLastBackupGroupRunsForCompanyLocation(CompanyId companyId,
                                                                 LocationId locationId)

Lists all backup group runs for all backup groups in a specified company-location.

Parameters:

companyId - CompanyId

locationId - LocationId

Returns:

Stream of BackupGroupRun