com.iland.cohesity.iaas.backups.policies

Interface PolicyApi

public interface PolicyApi

API for retrieving, updating, and deleting backup policies. A backup policy encapsulates settings for backup schedules, retention, archiving, etc.

Author:

Cory Snyder

Method Summary

Modifier and Type	Method and Description
BackupPolicy	createBackupPolicy(OrgUuid orgUuid, BackupPolicyParams params) Creates a new backup policy that is scoped to a designated vCloud Org.
BackupPolicy	createBackupPolicy(VdcUuid vdcUuid, BackupPolicyParams params) Creates a new backup policy that is scoped to a designated vCloud vDC.
void	deleteBackupPolicy(PolicyUid policyUid) Deletes a backup policy.
Optional<BackupPolicy>	getBackupPolicy(PolicyUid policyUid) Gets a backup policy by UID.
Stream<BackupPolicy>	listBackupPoliciesForLocation(LocationId locationId) Lists backup policies that exist for a vCloud instance in a specified location.
Stream<BackupPolicy>	listBackupPoliciesForOrg(OrgUuid orgUuid, boolean includeVdcScopedPolicies) Lists backup policies that exist within a vCloud org.
Stream<BackupPolicy>	listBackupPoliciesForVdc(VdcUuid vdcUuid) Lists backup polices that exist within a vCloud vDC.
BackupPolicy	updateBackupPolicy(PolicyUid policyUid, BackupPolicyParams params) Updates the configuration of an existing backup policy.

Method Detail

getBackupPolicy

Optional<BackupPolicy> getBackupPolicy(PolicyUid policyUid)

Gets a backup policy by UID.

Parameters:

policyUid - the PolicyUid

Returns:

Optional of BackupPolicy. An empty optional indicates that the backup policy was not found.

listBackupPoliciesForLocation

Stream<BackupPolicy> listBackupPoliciesForLocation(LocationId locationId)

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

Parameters:

locationId - the LocationId

Returns:

Stream of BackupPolicy

listBackupPoliciesForOrg

Stream<BackupPolicy> listBackupPoliciesForOrg(OrgUuid orgUuid,
                                              boolean includeVdcScopedPolicies)

Lists backup policies that exist within a vCloud org.

Parameters:

orgUuid - the OrgUuid

includeVdcScopedPolicies - whether to include policies that are scoped to child vDCs of the specified org

Returns:

Stream of BackupPolicy

listBackupPoliciesForVdc

Stream<BackupPolicy> listBackupPoliciesForVdc(VdcUuid vdcUuid)

Lists backup polices that exist within a vCloud vDC.

Parameters:

vdcUuid - the VdcUuid

Returns:

Optional Stream of BackupPolicy. Optional will be empty if the specifed vDC is not bound to a backup tenant.

createBackupPolicy

BackupPolicy createBackupPolicy(VdcUuid vdcUuid,
                                BackupPolicyParams params)

Creates a new backup policy that is scoped to a designated vCloud vDC.

Parameters:

vdcUuid - the VdcUuid

params - the BackupPolicyParams

Returns:

the new BackupPolicy

Throws:

ValidationException - if params are invalid

createBackupPolicy

BackupPolicy createBackupPolicy(OrgUuid orgUuid,
                                BackupPolicyParams params)

Creates a new backup policy that is scoped to a designated vCloud Org.

Parameters:

orgUuid - the OrgUuid

params - the BackupPolicyParams

Returns:

the new BackupPolicy

Throws:

ValidationException - if params are invalid

updateBackupPolicy

BackupPolicy updateBackupPolicy(PolicyUid policyUid,
                                BackupPolicyParams params)

Updates the configuration of an existing backup policy.

Parameters:

policyUid - the PolicyUid

params - the BackupPolicyParams

Returns:

the updated BackupPolicy

Throws:

ValidationException - if params are invalid

deleteBackupPolicy

void deleteBackupPolicy(PolicyUid policyUid)

Deletes a backup policy.

Parameters:

policyUid - the PolicyUid