BackupPolicy (iland cloud Java SDK 1.0.45 API)

All Known Implementing Classes:

ImmutableBackupPolicy
```
public interface BackupPolicy
```
IaaS Backup Protection Policy.

Author:

Cory Snyder

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`List<BlackoutPeriod>`	`blackoutPeriods()` Array of Blackout Periods.
`CompanyId`	`companyId()` Associated company ID.
`long`	`daysToKeep()` Specifies how many days to retain Snapshots on the Cohesity Cluster.
`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 backup group and how long Snapshots captured by this schedule are retained on the Cohesity Cluster.
`SchedulingPolicy`	`incrementalSchedulingPolicy()` Specifies the CBT-based backup schedule of a Protection backup group and how long Snapshots captured by this schedule are retained on the Cohesity Cluster.
`Optional<Instant>`	`lastModifiedTime()` Specifies the time that the policy was last modified.
`LocationId`	`locationId()` Associated datacenter location ID.
`Optional<SchedulingPolicy>`	`logSchedulingPolicy()` Specifies settings that define a backup schedule for a Protection backup group.
`String`	`name()` Specifies the name of the Protection Policy.
`OrgUuid`	`orgUuid()` Associated org UUID.
`int`	`retries()` Specifies the number of times to retry capturing Snapshots before the backup group Run fails.
`int`	`retryIntervalMins()` Specifies the number of minutes before retrying a failed Protection backup group.
`BackupPolicyScopeType`	`scopeType()` The scope type of the backup policy.
`Optional<Integer>`	`skipIntervalMins()` Specifies the period of time before skipping the execution of new backup group Runs if an existing queued backup group Run of the same Protection backup group 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.
`PolicyUid`	`uid()` Specifies a unique Policy UID assigned by the Cohesity Cluster.
`Optional<VdcUuid>`	`vdcUuid()` Associated vDC UUID, if applicable.

- Method Detail
  - blackoutPeriods
```
List<BlackoutPeriod> blackoutPeriods()
```
    Array of Blackout Periods.
    If specified, this field defines black periods when new backup group Runs are not started. If a backup group 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 on the Cohesity Cluster.
  - daysToKeepLog
```
Optional<Long> daysToKeepLog()
```
    Specifies the number of days to retain log run if Log Schedule exists.
  - daysToKeepSystem
```
Optional<Long> daysToKeepSystem()
```
    Specifies the number of days to retain BMR snapshots if System 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 backup group and how long Snapshots captured by this schedule are retained on the Cohesity Cluster.
  - uid
```
PolicyUid uid()
```
    Specifies a unique Policy UID assigned by the Cohesity Cluster.
  - incrementalSchedulingPolicy
```
SchedulingPolicy incrementalSchedulingPolicy()
```
    Specifies the CBT-based backup schedule of a Protection backup group and how long Snapshots captured by this schedule are retained on the Cohesity Cluster.
  - lastModifiedTime
```
Optional<Instant> lastModifiedTime()
```
    Specifies the time that the policy was last modified.
  - logSchedulingPolicy
```
Optional<SchedulingPolicy> logSchedulingPolicy()
```
    Specifies settings that define a backup schedule for a Protection backup group.
  - 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.
  - name
```
String name()
```
    Specifies the name of the Protection Policy.
  - retries
```
int retries()
```
    Specifies the number of times to retry capturing Snapshots before the backup group Run fails.
  - retryIntervalMins
```
int retryIntervalMins()
```
    Specifies the number of minutes before retrying a failed Protection backup group.
  - skipIntervalMins
```
Optional<Integer> skipIntervalMins()
```
    Specifies the period of time before skipping the execution of new backup group Runs if an existing queued backup group Run of the same Protection backup group has not started. For example if this field is set to 30 minutes and a backup group 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 backup group Run does not start by 5:30AM, the Cohesity Cluster will skip the new backup group Run. If the original backup group Run completes before 5:30AM the next day, a new backup group 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 AWS or Tape). It also defines the retention of copied Snapshots on an External Targets such as AWS and Tape.
  - 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.
  - scopeType
```
BackupPolicyScopeType scopeType()
```
    The scope type of the backup policy. Policies may be scoped to either organizations or virtual datacenters.
    
    Returns:
    
    BackupPolicyScopeType
  - locationId
```
LocationId locationId()
```
    Associated datacenter location ID.
    
    Returns:
    
    LocationId
  - companyId
```
CompanyId companyId()
```
    Associated company ID.
    
    Returns:
    
    CompanyId
  - orgUuid
```
OrgUuid orgUuid()
```
    Associated org UUID.
    
    Returns:
    
    OrgUuid
  - vdcUuid
```
Optional<VdcUuid> vdcUuid()
```
    Associated vDC UUID, if applicable. Will be empty if the scopeType() is BackupPolicyScopeType.ORG.
    
    Returns:
    
    Optional of VdcUuid

Interface BackupPolicy

Method Summary

Method Detail

blackoutPeriods

daysToKeep

daysToKeepLog

daysToKeepSystem

description

extendedRetentionPolicies

fullSchedulingPolicy

uid

incrementalSchedulingPolicy

lastModifiedTime

logSchedulingPolicy

systemSchedulingPolicy

name

retries

retryIntervalMins

skipIntervalMins

snapshotArchivalCopyPolicies

snapshotReplicationCopyPolicies

scopeType

locationId

companyId

orgUuid

vdcUuid