com.iland.cohesity.iaas.backups.policies.api.model

Interface BackupPolicyParams

All Known Implementing Classes:

ImmutableBackupPolicyParams

public interface BackupPolicyParams

Specifies information about a Protection Policy.

Author:

Cory Snyder

Method Summary

Modifier and Type	Method and Description
List<BlackoutPeriod>	blackoutPeriods() Array of Blackout Periods.
long	daysToKeep() Specifies how many days to retain Snapshots.
Optional<Long>	daysToKeepLog() Specifies the number of days to retain log run if Log Schedule exists.
Optional<Long>	daysToKeepSystem() Specifies the number of days to retain BMR snapshots if System Schedule exists.
Optional<String>	description() Description of the Protection Policy.
List<ExtendedRetentionPolicy>	extendedRetentionPolicies() Specifies additional retention policies that should be applied to the backup snapshots.
Optional<SchedulingPolicy>	fullSchedulingPolicy() Specifies the Full (no CBT) backup schedule of a Protection VCloudProtectionJob and how long Snapshots captured by this schedule are retained.
SchedulingPolicy	incrementalSchedulingPolicy() Specifies the CBT-based backup schedule of a Protection VCloudProtectionJob and how long Snapshots captured by this schedule are retained.
Optional<SchedulingPolicy>	logSchedulingPolicy() Specifies settings that define a backup schedule for a Protection VCloudProtectionJob.
String	name() Specifies the name of the Protection Policy.
int	retries() Specifies the number of times to retry capturing Snapshots before the VCloudProtectionJob Run fails.
int	retryIntervalMins() Specifies the number of minutes before retrying a failed Protection VCloudProtectionJob.
Optional<Integer>	skipIntervalMins() Specifies the period of time before skipping the execution of new VCloudProtectionJob Runs if an existing queued VCloudProtectionJob Run of the same Protection VCloudProtectionJob has not started.
List<SnapshotArchivalCopyPolicy>	snapshotArchivalCopyPolicies() Array of External Targets.
List<SnapshotReplicationCopyPolicy>	snapshotReplicationCopyPolicies() Array of Remote Clusters.
Optional<SchedulingPolicy>	systemSchedulingPolicy() Specifies the backup schedule of a BMR, or Bare Metal Recovery, VCloudProtectionJob and how long Snapshots captured by this schedule are retained.

Method Detail

blackoutPeriods

List<BlackoutPeriod> blackoutPeriods()

Array of Blackout Periods.

If specified, this field defines black periods when new VCloudProtectionJob Runs are not started. If a VCloudProtectionJob Run has been scheduled but not yet executed and the blackout period starts, the behavior depends on the policy field AbortInBlackoutPeriod.

daysToKeep

long daysToKeep()

Specifies how many days to retain Snapshots.

daysToKeepLog

Optional<Long> daysToKeepLog()

Specifies the number of days to retain log run if Log Schedule exists.

description

Optional<String> description()

Description of the Protection Policy.

extendedRetentionPolicies

List<ExtendedRetentionPolicy> extendedRetentionPolicies()

Specifies additional retention policies that should be applied to the backup snapshots. A backup snapshot will be retained up to a time that is the maximum of all retention policies that are applicable to it.

fullSchedulingPolicy

Optional<SchedulingPolicy> fullSchedulingPolicy()

Specifies the Full (no CBT) backup schedule of a Protection VCloudProtectionJob and how long Snapshots captured by this schedule are retained.

incrementalSchedulingPolicy

SchedulingPolicy incrementalSchedulingPolicy()

Specifies the CBT-based backup schedule of a Protection VCloudProtectionJob and how long Snapshots captured by this schedule are retained.

logSchedulingPolicy

Optional<SchedulingPolicy> logSchedulingPolicy()

Specifies settings that define a backup schedule for a Protection VCloudProtectionJob.

name

String name()

Specifies the name of the Protection Policy.

retries

int retries()

Specifies the number of times to retry capturing Snapshots before the VCloudProtectionJob Run fails.

retryIntervalMins

int retryIntervalMins()

Specifies the number of minutes before retrying a failed Protection VCloudProtectionJob.

skipIntervalMins

Optional<Integer> skipIntervalMins()

Specifies the period of time before skipping the execution of new VCloudProtectionJob Runs if an existing queued VCloudProtectionJob Run of the same Protection VCloudProtectionJob has not started. For example if this field is set to 30 minutes and a VCloudProtectionJob Run is scheduled to start at 5:00 AM every day but does not start due to conflicts (such as too many Jobs are running). If the new VCloudProtectionJob Run does not start by 5:30AM, iland will skip the new VCloudProtectionJob Run. If the original VCloudProtectionJob Run completes before 5:30AM the next day, a new VCloudProtectionJob Run is created and starts executing. This field is optional.

snapshotArchivalCopyPolicies

List<SnapshotArchivalCopyPolicy> snapshotArchivalCopyPolicies()

Array of External Targets.

Specifies settings for copying Snapshots to Archival External Targets (such as S3 object storage).

snapshotReplicationCopyPolicies

List<SnapshotReplicationCopyPolicy> snapshotReplicationCopyPolicies()

Array of Remote Clusters.

Specifies settings for copying Snapshots to Remote Clusters. It also defines the retention of copied Snapshots on a Remote Cluster.

daysToKeepSystem

Optional<Long> daysToKeepSystem()

Specifies the number of days to retain BMR snapshots if System Schedule exists.

systemSchedulingPolicy

Optional<SchedulingPolicy> systemSchedulingPolicy()

Specifies the backup schedule of a BMR, or Bare Metal Recovery, VCloudProtectionJob and how long Snapshots captured by this schedule are retained.