ImmutableBackupPolicy (iland cloud Java SDK 1.0.45 API)

java.lang.Object
- com.iland.cohesity.iaas.backups.policies.api.model.ImmutableBackupPolicy

All Implemented Interfaces:: BackupPolicy

@ParametersAreNonnullByDefault
 @Generated(value="org.immutables.processor.ProxyProcessor")
 @Immutable
 @CheckReturnValue
public final class ImmutableBackupPolicy
extends Object
implements BackupPolicy

Immutable implementation of BackupPolicy.

Use the builder to create immutable instances: ImmutableBackupPolicy.builder().

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ImmutableBackupPolicy.Builder
Builds instances of type ImmutableBackupPolicy.

Nested Classes
Modifier and Type	Class and Description
`static class`	`ImmutableBackupPolicy.Builder` Builds instances of type `ImmutableBackupPolicy`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.google.common.collect.ImmutableList<BlackoutPeriod>`	`blackoutPeriods()` Array of Blackout Periods.
`static ImmutableBackupPolicy.Builder`	`builder()` Creates a builder for `ImmutableBackupPolicy`.
`CompanyId`	`companyId()` Associated company ID.
`static ImmutableBackupPolicy`	`copyOf(BackupPolicy instance)` Creates an immutable copy of a `BackupPolicy` value.
`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.
`boolean`	`equals(Object another)` This instance is equal to all instances of `ImmutableBackupPolicy` that have equal attribute values.
`com.google.common.collect.ImmutableList<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.
`int`	`hashCode()` Computes a hash code from attributes: `blackoutPeriods`, `daysToKeep`, `daysToKeepLog`, `daysToKeepSystem`, `description`, `extendedRetentionPolicies`, `fullSchedulingPolicy`, `uid`, `incrementalSchedulingPolicy`, `lastModifiedTime`, `logSchedulingPolicy`, `systemSchedulingPolicy`, `name`, `retries`, `retryIntervalMins`, `skipIntervalMins`, `snapshotArchivalCopyPolicies`, `snapshotReplicationCopyPolicies`, `scopeType`, `locationId`, `companyId`, `orgUuid`, `vdcUuid`.
`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.
`com.google.common.collect.ImmutableList<SnapshotArchivalCopyPolicy>`	`snapshotArchivalCopyPolicies()` Array of External Targets.
`com.google.common.collect.ImmutableList<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.
`String`	`toString()` Prints the immutable value `BackupPolicy` with attribute values.
`PolicyUid`	`uid()` Specifies a unique Policy UID assigned by the Cohesity Cluster.
`Optional<VdcUuid>`	`vdcUuid()` Associated vDC UUID, if applicable.
`ImmutableBackupPolicy`	`withBlackoutPeriods(BlackoutPeriod... elements)` Copy the current immutable object with elements that replace the content of `blackoutPeriods`.
`ImmutableBackupPolicy`	`withBlackoutPeriods(Iterable<? extends BlackoutPeriod> elements)` Copy the current immutable object with elements that replace the content of `blackoutPeriods`.
`ImmutableBackupPolicy`	`withCompanyId(CompanyId value)` Copy the current immutable object by setting a value for the `companyId` attribute.
`ImmutableBackupPolicy`	`withDaysToKeep(long value)` Copy the current immutable object by setting a value for the `daysToKeep` attribute.
`ImmutableBackupPolicy`	`withDaysToKeepLog(long value)` Copy the current immutable object by setting a present value for the optional `daysToKeepLog` attribute.
`ImmutableBackupPolicy`	`withDaysToKeepLog(Optional<Long> optional)` Copy the current immutable object by setting an optional value for the `daysToKeepLog` attribute.
`ImmutableBackupPolicy`	`withDaysToKeepSystem(long value)` Copy the current immutable object by setting a present value for the optional `daysToKeepSystem` attribute.
`ImmutableBackupPolicy`	`withDaysToKeepSystem(Optional<Long> optional)` Copy the current immutable object by setting an optional value for the `daysToKeepSystem` attribute.
`ImmutableBackupPolicy`	`withDescription(Optional<String> optional)` Copy the current immutable object by setting an optional value for the `description` attribute.
`ImmutableBackupPolicy`	`withDescription(String value)` Copy the current immutable object by setting a present value for the optional `description` attribute.
`ImmutableBackupPolicy`	`withExtendedRetentionPolicies(ExtendedRetentionPolicy... elements)` Copy the current immutable object with elements that replace the content of `extendedRetentionPolicies`.
`ImmutableBackupPolicy`	`withExtendedRetentionPolicies(Iterable<? extends ExtendedRetentionPolicy> elements)` Copy the current immutable object with elements that replace the content of `extendedRetentionPolicies`.
`ImmutableBackupPolicy`	`withFullSchedulingPolicy(Optional<? extends SchedulingPolicy> optional)` Copy the current immutable object by setting an optional value for the `fullSchedulingPolicy` attribute.
`ImmutableBackupPolicy`	`withFullSchedulingPolicy(SchedulingPolicy value)` Copy the current immutable object by setting a present value for the optional `fullSchedulingPolicy` attribute.
`ImmutableBackupPolicy`	`withIncrementalSchedulingPolicy(SchedulingPolicy value)` Copy the current immutable object by setting a value for the `incrementalSchedulingPolicy` attribute.
`ImmutableBackupPolicy`	`withLastModifiedTime(Instant value)` Copy the current immutable object by setting a present value for the optional `lastModifiedTime` attribute.
`ImmutableBackupPolicy`	`withLastModifiedTime(Optional<? extends Instant> optional)` Copy the current immutable object by setting an optional value for the `lastModifiedTime` attribute.
`ImmutableBackupPolicy`	`withLocationId(LocationId value)` Copy the current immutable object by setting a value for the `locationId` attribute.
`ImmutableBackupPolicy`	`withLogSchedulingPolicy(Optional<? extends SchedulingPolicy> optional)` Copy the current immutable object by setting an optional value for the `logSchedulingPolicy` attribute.
`ImmutableBackupPolicy`	`withLogSchedulingPolicy(SchedulingPolicy value)` Copy the current immutable object by setting a present value for the optional `logSchedulingPolicy` attribute.
`ImmutableBackupPolicy`	`withName(String value)` Copy the current immutable object by setting a value for the `name` attribute.
`ImmutableBackupPolicy`	`withOrgUuid(OrgUuid value)` Copy the current immutable object by setting a value for the `orgUuid` attribute.
`ImmutableBackupPolicy`	`withRetries(int value)` Copy the current immutable object by setting a value for the `retries` attribute.
`ImmutableBackupPolicy`	`withRetryIntervalMins(int value)` Copy the current immutable object by setting a value for the `retryIntervalMins` attribute.
`ImmutableBackupPolicy`	`withScopeType(BackupPolicyScopeType value)` Copy the current immutable object by setting a value for the `scopeType` attribute.
`ImmutableBackupPolicy`	`withSkipIntervalMins(int value)` Copy the current immutable object by setting a present value for the optional `skipIntervalMins` attribute.
`ImmutableBackupPolicy`	`withSkipIntervalMins(Optional<Integer> optional)` Copy the current immutable object by setting an optional value for the `skipIntervalMins` attribute.
`ImmutableBackupPolicy`	`withSnapshotArchivalCopyPolicies(Iterable<? extends SnapshotArchivalCopyPolicy> elements)` Copy the current immutable object with elements that replace the content of `snapshotArchivalCopyPolicies`.
`ImmutableBackupPolicy`	`withSnapshotArchivalCopyPolicies(SnapshotArchivalCopyPolicy... elements)` Copy the current immutable object with elements that replace the content of `snapshotArchivalCopyPolicies`.
`ImmutableBackupPolicy`	`withSnapshotReplicationCopyPolicies(Iterable<? extends SnapshotReplicationCopyPolicy> elements)` Copy the current immutable object with elements that replace the content of `snapshotReplicationCopyPolicies`.
`ImmutableBackupPolicy`	`withSnapshotReplicationCopyPolicies(SnapshotReplicationCopyPolicy... elements)` Copy the current immutable object with elements that replace the content of `snapshotReplicationCopyPolicies`.
`ImmutableBackupPolicy`	`withSystemSchedulingPolicy(Optional<? extends SchedulingPolicy> optional)` Copy the current immutable object by setting an optional value for the `systemSchedulingPolicy` attribute.
`ImmutableBackupPolicy`	`withSystemSchedulingPolicy(SchedulingPolicy value)` Copy the current immutable object by setting a present value for the optional `systemSchedulingPolicy` attribute.
`ImmutableBackupPolicy`	`withUid(PolicyUid value)` Copy the current immutable object by setting a value for the `uid` attribute.
`ImmutableBackupPolicy`	`withVdcUuid(Optional<? extends VdcUuid> optional)` Copy the current immutable object by setting an optional value for the `vdcUuid` attribute.
`ImmutableBackupPolicy`	`withVdcUuid(VdcUuid value)` Copy the current immutable object by setting a present value for the optional `vdcUuid` attribute.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - blackoutPeriods
```
public com.google.common.collect.ImmutableList<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.
    
    Specified by:
    
    blackoutPeriods in interface BackupPolicy
  - daysToKeep
```
public long daysToKeep()
```
    Specifies how many days to retain Snapshots on the Cohesity Cluster.
    
    Specified by:
    
    daysToKeep in interface BackupPolicy
  - daysToKeepLog
```
public Optional<Long> daysToKeepLog()
```
    Specifies the number of days to retain log run if Log Schedule exists.
    
    Specified by:
    
    daysToKeepLog in interface BackupPolicy
  - daysToKeepSystem
```
public Optional<Long> daysToKeepSystem()
```
    Specifies the number of days to retain BMR snapshots if System Schedule exists.
    
    Specified by:
    
    daysToKeepSystem in interface BackupPolicy
  - description
```
public Optional<String> description()
```
    Description of the Protection Policy.
    
    Specified by:
    
    description in interface BackupPolicy
  - extendedRetentionPolicies
```
public com.google.common.collect.ImmutableList<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.
    
    Specified by:
    
    extendedRetentionPolicies in interface BackupPolicy
  - fullSchedulingPolicy
```
public 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.
    
    Specified by:
    
    fullSchedulingPolicy in interface BackupPolicy
  - uid
```
public PolicyUid uid()
```
    Specifies a unique Policy UID assigned by the Cohesity Cluster.
    
    Specified by:
    
    uid in interface BackupPolicy
  - incrementalSchedulingPolicy
```
public 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.
    
    Specified by:
    
    incrementalSchedulingPolicy in interface BackupPolicy
  - lastModifiedTime
```
public Optional<Instant> lastModifiedTime()
```
    Specifies the time that the policy was last modified.
    
    Specified by:
    
    lastModifiedTime in interface BackupPolicy
  - logSchedulingPolicy
```
public Optional<SchedulingPolicy> logSchedulingPolicy()
```
    Specifies settings that define a backup schedule for a Protection backup group.
    
    Specified by:
    
    logSchedulingPolicy in interface BackupPolicy
  - systemSchedulingPolicy
```
public 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.
    
    Specified by:
    
    systemSchedulingPolicy in interface BackupPolicy
  - name
```
public String name()
```
    Specifies the name of the Protection Policy.
    
    Specified by:
    
    name in interface BackupPolicy
  - retries
```
public int retries()
```
    Specifies the number of times to retry capturing Snapshots before the backup group Run fails.
    
    Specified by:
    
    retries in interface BackupPolicy
  - retryIntervalMins
```
public int retryIntervalMins()
```
    Specifies the number of minutes before retrying a failed Protection backup group.
    
    Specified by:
    
    retryIntervalMins in interface BackupPolicy
  - skipIntervalMins
```
public 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.
    
    Specified by:
    
    skipIntervalMins in interface BackupPolicy
  - snapshotArchivalCopyPolicies
```
public com.google.common.collect.ImmutableList<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.
    
    Specified by:
    
    snapshotArchivalCopyPolicies in interface BackupPolicy
  - snapshotReplicationCopyPolicies
```
public com.google.common.collect.ImmutableList<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.
    
    Specified by:
    
    snapshotReplicationCopyPolicies in interface BackupPolicy
  - scopeType
```
public BackupPolicyScopeType scopeType()
```
    The scope type of the backup policy. Policies may be scoped to either organizations or virtual datacenters.
    
    Specified by:
    
    scopeType in interface BackupPolicy
    
    Returns:
    
    BackupPolicyScopeType
  - locationId
```
public LocationId locationId()
```
    Associated datacenter location ID.
    
    Specified by:
    
    locationId in interface BackupPolicy
    
    Returns:
    
    LocationId
  - companyId
```
public CompanyId companyId()
```
    Associated company ID.
    
    Specified by:
    
    companyId in interface BackupPolicy
    
    Returns:
    
    CompanyId
  - orgUuid
```
public OrgUuid orgUuid()
```
    Associated org UUID.
    
    Specified by:
    
    orgUuid in interface BackupPolicy
    
    Returns:
    
    OrgUuid
  - vdcUuid
```
public Optional<VdcUuid> vdcUuid()
```
    Associated vDC UUID, if applicable. Will be empty if the BackupPolicy.scopeType() is BackupPolicyScopeType.ORG.
    
    Specified by:
    
    vdcUuid in interface BackupPolicy
    
    Returns:
    
    Optional of VdcUuid
  - withBlackoutPeriods
```
public final ImmutableBackupPolicy withBlackoutPeriods(BlackoutPeriod... elements)
```
    Copy the current immutable object with elements that replace the content of blackoutPeriods.
    
    Parameters:
    
    elements - The elements to set
    
    Returns:
    
    A modified copy of this object
  - withBlackoutPeriods
```
public final ImmutableBackupPolicy withBlackoutPeriods(Iterable<? extends BlackoutPeriod> elements)
```
    Copy the current immutable object with elements that replace the content of blackoutPeriods. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    elements - An iterable of blackoutPeriods elements to set
    
    Returns:
    
    A modified copy of this object
  - withDaysToKeep
```
public final ImmutableBackupPolicy withDaysToKeep(long value)
```
    Copy the current immutable object by setting a value for the daysToKeep attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for daysToKeep
    
    Returns:
    
    A modified copy of the this object
  - withDaysToKeepLog
```
public final ImmutableBackupPolicy withDaysToKeepLog(long value)
```
    Copy the current immutable object by setting a present value for the optional daysToKeepLog attribute.
    
    Parameters:
    
    value - The value for daysToKeepLog
    
    Returns:
    
    A modified copy of this object
  - withDaysToKeepLog
```
public final ImmutableBackupPolicy withDaysToKeepLog(Optional<Long> optional)
```
    Copy the current immutable object by setting an optional value for the daysToKeepLog attribute. An equality check is used on inner nullable value to prevent copying of the same value by returning this.
    
    Parameters:
    
    optional - A value for daysToKeepLog
    
    Returns:
    
    A modified copy of this object
  - withDaysToKeepSystem
```
public final ImmutableBackupPolicy withDaysToKeepSystem(long value)
```
    Copy the current immutable object by setting a present value for the optional daysToKeepSystem attribute.
    
    Parameters:
    
    value - The value for daysToKeepSystem
    
    Returns:
    
    A modified copy of this object
  - withDaysToKeepSystem
```
public final ImmutableBackupPolicy withDaysToKeepSystem(Optional<Long> optional)
```
    Copy the current immutable object by setting an optional value for the daysToKeepSystem attribute. An equality check is used on inner nullable value to prevent copying of the same value by returning this.
    
    Parameters:
    
    optional - A value for daysToKeepSystem
    
    Returns:
    
    A modified copy of this object
  - withDescription
```
public final ImmutableBackupPolicy withDescription(String value)
```
    Copy the current immutable object by setting a present value for the optional description attribute.
    
    Parameters:
    
    value - The value for description
    
    Returns:
    
    A modified copy of this object
  - withDescription
```
public final ImmutableBackupPolicy withDescription(Optional<String> optional)
```
    Copy the current immutable object by setting an optional value for the description attribute. An equality check is used on inner nullable value to prevent copying of the same value by returning this.
    
    Parameters:
    
    optional - A value for description
    
    Returns:
    
    A modified copy of this object
  - withExtendedRetentionPolicies
```
public final ImmutableBackupPolicy withExtendedRetentionPolicies(ExtendedRetentionPolicy... elements)
```
    Copy the current immutable object with elements that replace the content of extendedRetentionPolicies.
    
    Parameters:
    
    elements - The elements to set
    
    Returns:
    
    A modified copy of this object
  - withExtendedRetentionPolicies
```
public final ImmutableBackupPolicy withExtendedRetentionPolicies(Iterable<? extends ExtendedRetentionPolicy> elements)
```
    Copy the current immutable object with elements that replace the content of extendedRetentionPolicies. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    elements - An iterable of extendedRetentionPolicies elements to set
    
    Returns:
    
    A modified copy of this object
  - withFullSchedulingPolicy
```
public final ImmutableBackupPolicy withFullSchedulingPolicy(SchedulingPolicy value)
```
    Copy the current immutable object by setting a present value for the optional fullSchedulingPolicy attribute.
    
    Parameters:
    
    value - The value for fullSchedulingPolicy
    
    Returns:
    
    A modified copy of this object
  - withFullSchedulingPolicy
```
public final ImmutableBackupPolicy withFullSchedulingPolicy(Optional<? extends SchedulingPolicy> optional)
```
    Copy the current immutable object by setting an optional value for the fullSchedulingPolicy attribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returning this.
    
    Parameters:
    
    optional - A value for fullSchedulingPolicy
    
    Returns:
    
    A modified copy of this object
  - withUid
```
public final ImmutableBackupPolicy withUid(PolicyUid value)
```
    Copy the current immutable object by setting a value for the uid attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for uid
    
    Returns:
    
    A modified copy of the this object
  - withIncrementalSchedulingPolicy
```
public final ImmutableBackupPolicy withIncrementalSchedulingPolicy(SchedulingPolicy value)
```
    Copy the current immutable object by setting a value for the incrementalSchedulingPolicy attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for incrementalSchedulingPolicy
    
    Returns:
    
    A modified copy of the this object
  - withLastModifiedTime
```
public final ImmutableBackupPolicy withLastModifiedTime(Instant value)
```
    Copy the current immutable object by setting a present value for the optional lastModifiedTime attribute.
    
    Parameters:
    
    value - The value for lastModifiedTime
    
    Returns:
    
    A modified copy of this object
  - withLastModifiedTime
```
public final ImmutableBackupPolicy withLastModifiedTime(Optional<? extends Instant> optional)
```
    Copy the current immutable object by setting an optional value for the lastModifiedTime attribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returning this.
    
    Parameters:
    
    optional - A value for lastModifiedTime
    
    Returns:
    
    A modified copy of this object
  - withLogSchedulingPolicy
```
public final ImmutableBackupPolicy withLogSchedulingPolicy(SchedulingPolicy value)
```
    Copy the current immutable object by setting a present value for the optional logSchedulingPolicy attribute.
    
    Parameters:
    
    value - The value for logSchedulingPolicy
    
    Returns:
    
    A modified copy of this object
  - withLogSchedulingPolicy
```
public final ImmutableBackupPolicy withLogSchedulingPolicy(Optional<? extends SchedulingPolicy> optional)
```
    Copy the current immutable object by setting an optional value for the logSchedulingPolicy attribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returning this.
    
    Parameters:
    
    optional - A value for logSchedulingPolicy
    
    Returns:
    
    A modified copy of this object
  - withSystemSchedulingPolicy
```
public final ImmutableBackupPolicy withSystemSchedulingPolicy(SchedulingPolicy value)
```
    Copy the current immutable object by setting a present value for the optional systemSchedulingPolicy attribute.
    
    Parameters:
    
    value - The value for systemSchedulingPolicy
    
    Returns:
    
    A modified copy of this object
  - withSystemSchedulingPolicy
```
public final ImmutableBackupPolicy withSystemSchedulingPolicy(Optional<? extends SchedulingPolicy> optional)
```
    Copy the current immutable object by setting an optional value for the systemSchedulingPolicy attribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returning this.
    
    Parameters:
    
    optional - A value for systemSchedulingPolicy
    
    Returns:
    
    A modified copy of this object
  - withName
```
public final ImmutableBackupPolicy withName(String value)
```
    Copy the current immutable object by setting a value for the name attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for name
    
    Returns:
    
    A modified copy of the this object
  - withRetries
```
public final ImmutableBackupPolicy withRetries(int value)
```
    Copy the current immutable object by setting a value for the retries attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for retries
    
    Returns:
    
    A modified copy of the this object
  - withRetryIntervalMins
```
public final ImmutableBackupPolicy withRetryIntervalMins(int value)
```
    Copy the current immutable object by setting a value for the retryIntervalMins attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for retryIntervalMins
    
    Returns:
    
    A modified copy of the this object
  - withSkipIntervalMins
```
public final ImmutableBackupPolicy withSkipIntervalMins(int value)
```
    Copy the current immutable object by setting a present value for the optional skipIntervalMins attribute.
    
    Parameters:
    
    value - The value for skipIntervalMins
    
    Returns:
    
    A modified copy of this object
  - withSkipIntervalMins
```
public final ImmutableBackupPolicy withSkipIntervalMins(Optional<Integer> optional)
```
    Copy the current immutable object by setting an optional value for the skipIntervalMins attribute. An equality check is used on inner nullable value to prevent copying of the same value by returning this.
    
    Parameters:
    
    optional - A value for skipIntervalMins
    
    Returns:
    
    A modified copy of this object
  - withSnapshotArchivalCopyPolicies
```
public final ImmutableBackupPolicy withSnapshotArchivalCopyPolicies(SnapshotArchivalCopyPolicy... elements)
```
    Copy the current immutable object with elements that replace the content of snapshotArchivalCopyPolicies.
    
    Parameters:
    
    elements - The elements to set
    
    Returns:
    
    A modified copy of this object
  - withSnapshotArchivalCopyPolicies
```
public final ImmutableBackupPolicy withSnapshotArchivalCopyPolicies(Iterable<? extends SnapshotArchivalCopyPolicy> elements)
```
    Copy the current immutable object with elements that replace the content of snapshotArchivalCopyPolicies. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    elements - An iterable of snapshotArchivalCopyPolicies elements to set
    
    Returns:
    
    A modified copy of this object
  - withSnapshotReplicationCopyPolicies
```
public final ImmutableBackupPolicy withSnapshotReplicationCopyPolicies(SnapshotReplicationCopyPolicy... elements)
```
    Copy the current immutable object with elements that replace the content of snapshotReplicationCopyPolicies.
    
    Parameters:
    
    elements - The elements to set
    
    Returns:
    
    A modified copy of this object
  - withSnapshotReplicationCopyPolicies
```
public final ImmutableBackupPolicy withSnapshotReplicationCopyPolicies(Iterable<? extends SnapshotReplicationCopyPolicy> elements)
```
    Copy the current immutable object with elements that replace the content of snapshotReplicationCopyPolicies. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    elements - An iterable of snapshotReplicationCopyPolicies elements to set
    
    Returns:
    
    A modified copy of this object
  - withScopeType
```
public final ImmutableBackupPolicy withScopeType(BackupPolicyScopeType value)
```
    Copy the current immutable object by setting a value for the scopeType attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for scopeType
    
    Returns:
    
    A modified copy of the this object
  - withLocationId
```
public final ImmutableBackupPolicy withLocationId(LocationId value)
```
    Copy the current immutable object by setting a value for the locationId attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for locationId
    
    Returns:
    
    A modified copy of the this object
  - withCompanyId
```
public final ImmutableBackupPolicy withCompanyId(CompanyId value)
```
    Copy the current immutable object by setting a value for the companyId attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for companyId
    
    Returns:
    
    A modified copy of the this object
  - withOrgUuid
```
public final ImmutableBackupPolicy withOrgUuid(OrgUuid value)
```
    Copy the current immutable object by setting a value for the orgUuid attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for orgUuid
    
    Returns:
    
    A modified copy of the this object
  - withVdcUuid
```
public final ImmutableBackupPolicy withVdcUuid(VdcUuid value)
```
    Copy the current immutable object by setting a present value for the optional vdcUuid attribute.
    
    Parameters:
    
    value - The value for vdcUuid
    
    Returns:
    
    A modified copy of this object
  - withVdcUuid
```
public final ImmutableBackupPolicy withVdcUuid(Optional<? extends VdcUuid> optional)
```
    Copy the current immutable object by setting an optional value for the vdcUuid attribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returning this.
    
    Parameters:
    
    optional - A value for vdcUuid
    
    Returns:
    
    A modified copy of this object
  - equals
```
public boolean equals(@Nullable
                      Object another)
```
    This instance is equal to all instances of ImmutableBackupPolicy that have equal attribute values.
    
    Overrides:
    
    equals in class Object
    
    Returns:
    
    true if this is equal to another instance
  - hashCode
```
public int hashCode()
```
    Computes a hash code from attributes: blackoutPeriods, daysToKeep, daysToKeepLog, daysToKeepSystem, description, extendedRetentionPolicies, fullSchedulingPolicy, uid, incrementalSchedulingPolicy, lastModifiedTime, logSchedulingPolicy, systemSchedulingPolicy, name, retries, retryIntervalMins, skipIntervalMins, snapshotArchivalCopyPolicies, snapshotReplicationCopyPolicies, scopeType, locationId, companyId, orgUuid, vdcUuid.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    hashCode value
  - toString
```
public String toString()
```
    Prints the immutable value BackupPolicy with attribute values.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of the value
  - copyOf
```
public static ImmutableBackupPolicy copyOf(BackupPolicy instance)
```
    Creates an immutable copy of a BackupPolicy value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.
    
    Parameters:
    
    instance - The instance to copy
    
    Returns:
    
    A copied immutable BackupPolicy instance
  - builder
```
public static ImmutableBackupPolicy.Builder builder()
```
    Creates a builder for ImmutableBackupPolicy.
```
 ImmutableBackupPolicy.builder()
    .addBlackoutPeriods|addAllBlackoutPeriods(com.iland.cohesity.iaas.backups.policies.api.model.BlackoutPeriod) // blackoutPeriods elements
    .daysToKeep(long) // required daysToKeep
    .daysToKeepLog(Long) // optional daysToKeepLog
    .daysToKeepSystem(Long) // optional daysToKeepSystem
    .description(String) // optional description
    .addExtendedRetentionPolicies|addAllExtendedRetentionPolicies(com.iland.cohesity.iaas.backups.policies.api.model.ExtendedRetentionPolicy) // extendedRetentionPolicies elements
    .fullSchedulingPolicy(com.iland.cohesity.iaas.backups.policies.api.model.SchedulingPolicy) // optional fullSchedulingPolicy
    .uid(com.iland.cohesity.iaas.backups.common.model.PolicyUid) // required uid
    .incrementalSchedulingPolicy(com.iland.cohesity.iaas.backups.policies.api.model.SchedulingPolicy) // required incrementalSchedulingPolicy
    .lastModifiedTime(java.time.Instant) // optional lastModifiedTime
    .logSchedulingPolicy(com.iland.cohesity.iaas.backups.policies.api.model.SchedulingPolicy) // optional logSchedulingPolicy
    .systemSchedulingPolicy(com.iland.cohesity.iaas.backups.policies.api.model.SchedulingPolicy) // optional systemSchedulingPolicy
    .name(String) // required name
    .retries(int) // required retries
    .retryIntervalMins(int) // required retryIntervalMins
    .skipIntervalMins(Integer) // optional skipIntervalMins
    .addSnapshotArchivalCopyPolicies|addAllSnapshotArchivalCopyPolicies(com.iland.cohesity.iaas.backups.policies.api.model.SnapshotArchivalCopyPolicy) // snapshotArchivalCopyPolicies elements
    .addSnapshotReplicationCopyPolicies|addAllSnapshotReplicationCopyPolicies(com.iland.cohesity.iaas.backups.policies.api.model.SnapshotReplicationCopyPolicy) // snapshotReplicationCopyPolicies elements
    .scopeType(com.iland.cohesity.iaas.backups.common.enums.BackupPolicyScopeType) // required scopeType
    .locationId(com.iland.cohesity.iaas.backups.common.model.LocationId) // required locationId
    .companyId(com.iland.cohesity.iaas.backups.common.model.CompanyId) // required companyId
    .orgUuid(com.iland.cohesity.iaas.backups.common.model.OrgUuid) // required orgUuid
    .vdcUuid(com.iland.cohesity.iaas.backups.common.model.VdcUuid) // optional vdcUuid
    .build();
 
```
    Returns:
    
    A new ImmutableBackupPolicy builder

Class ImmutableBackupPolicy

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

withBlackoutPeriods

withBlackoutPeriods

withDaysToKeep

withDaysToKeepLog

withDaysToKeepLog

withDaysToKeepSystem

withDaysToKeepSystem

withDescription

withDescription

withExtendedRetentionPolicies

withExtendedRetentionPolicies

withFullSchedulingPolicy

withFullSchedulingPolicy

withUid

withIncrementalSchedulingPolicy

withLastModifiedTime

withLastModifiedTime

withLogSchedulingPolicy

withLogSchedulingPolicy

withSystemSchedulingPolicy

withSystemSchedulingPolicy

withName

withRetries

withRetryIntervalMins

withSkipIntervalMins

withSkipIntervalMins

withSnapshotArchivalCopyPolicies

withSnapshotArchivalCopyPolicies

withSnapshotReplicationCopyPolicies

withSnapshotReplicationCopyPolicies

withScopeType

withLocationId

withCompanyId

withOrgUuid

withVdcUuid

withVdcUuid

equals

hashCode

toString

copyOf

builder