@ParametersAreNonnullByDefault @Generated(value="org.immutables.processor.ProxyProcessor") @Immutable @CheckReturnValue public final class ImmutableBackupPolicyParams extends Object implements BackupPolicyParams
BackupPolicyParams
.
Use the builder to create immutable instances:
ImmutableBackupPolicyParams.builder()
.
Modifier and Type | Class and Description |
---|---|
static class |
ImmutableBackupPolicyParams.Builder
Builds instances of type
ImmutableBackupPolicyParams . |
Modifier and Type | Method and Description |
---|---|
com.google.common.collect.ImmutableList<BlackoutPeriod> |
blackoutPeriods()
Array of Blackout Periods.
|
static ImmutableBackupPolicyParams.Builder |
builder()
Creates a builder for
ImmutableBackupPolicyParams . |
static ImmutableBackupPolicyParams |
copyOf(BackupPolicyParams instance)
Creates an immutable copy of a
BackupPolicyParams value. |
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.
|
boolean |
equals(Object another)
This instance is equal to all instances of
ImmutableBackupPolicyParams 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
VCloudProtectionJob and how long Snapshots captured by this schedule are
retained.
|
int |
hashCode()
Computes a hash code from attributes:
blackoutPeriods , daysToKeep , daysToKeepLog , description , extendedRetentionPolicies , fullSchedulingPolicy , incrementalSchedulingPolicy , logSchedulingPolicy , name , retries , retryIntervalMins , skipIntervalMins , snapshotArchivalCopyPolicies , snapshotReplicationCopyPolicies , daysToKeepSystem , systemSchedulingPolicy . |
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.
|
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
BackupPolicyParams with attribute values. |
ImmutableBackupPolicyParams |
withBlackoutPeriods(BlackoutPeriod... elements)
Copy the current immutable object with elements that replace the content of
blackoutPeriods . |
ImmutableBackupPolicyParams |
withBlackoutPeriods(Iterable<? extends BlackoutPeriod> elements)
Copy the current immutable object with elements that replace the content of
blackoutPeriods . |
ImmutableBackupPolicyParams |
withDaysToKeep(long value)
Copy the current immutable object by setting a value for the
daysToKeep attribute. |
ImmutableBackupPolicyParams |
withDaysToKeepLog(long value)
Copy the current immutable object by setting a present value for the optional
daysToKeepLog attribute. |
ImmutableBackupPolicyParams |
withDaysToKeepLog(Optional<Long> optional)
Copy the current immutable object by setting an optional value for the
daysToKeepLog attribute. |
ImmutableBackupPolicyParams |
withDaysToKeepSystem(long value)
Copy the current immutable object by setting a present value for the optional
daysToKeepSystem attribute. |
ImmutableBackupPolicyParams |
withDaysToKeepSystem(Optional<Long> optional)
Copy the current immutable object by setting an optional value for the
daysToKeepSystem attribute. |
ImmutableBackupPolicyParams |
withDescription(Optional<String> optional)
Copy the current immutable object by setting an optional value for the
description attribute. |
ImmutableBackupPolicyParams |
withDescription(String value)
Copy the current immutable object by setting a present value for the optional
description attribute. |
ImmutableBackupPolicyParams |
withExtendedRetentionPolicies(ExtendedRetentionPolicy... elements)
Copy the current immutable object with elements that replace the content of
extendedRetentionPolicies . |
ImmutableBackupPolicyParams |
withExtendedRetentionPolicies(Iterable<? extends ExtendedRetentionPolicy> elements)
Copy the current immutable object with elements that replace the content of
extendedRetentionPolicies . |
ImmutableBackupPolicyParams |
withFullSchedulingPolicy(Optional<? extends SchedulingPolicy> optional)
Copy the current immutable object by setting an optional value for the
fullSchedulingPolicy attribute. |
ImmutableBackupPolicyParams |
withFullSchedulingPolicy(SchedulingPolicy value)
Copy the current immutable object by setting a present value for the optional
fullSchedulingPolicy attribute. |
ImmutableBackupPolicyParams |
withIncrementalSchedulingPolicy(SchedulingPolicy value)
Copy the current immutable object by setting a value for the
incrementalSchedulingPolicy attribute. |
ImmutableBackupPolicyParams |
withLogSchedulingPolicy(Optional<? extends SchedulingPolicy> optional)
Copy the current immutable object by setting an optional value for the
logSchedulingPolicy attribute. |
ImmutableBackupPolicyParams |
withLogSchedulingPolicy(SchedulingPolicy value)
Copy the current immutable object by setting a present value for the optional
logSchedulingPolicy attribute. |
ImmutableBackupPolicyParams |
withName(String value)
Copy the current immutable object by setting a value for the
name attribute. |
ImmutableBackupPolicyParams |
withRetries(int value)
Copy the current immutable object by setting a value for the
retries attribute. |
ImmutableBackupPolicyParams |
withRetryIntervalMins(int value)
Copy the current immutable object by setting a value for the
retryIntervalMins attribute. |
ImmutableBackupPolicyParams |
withSkipIntervalMins(int value)
Copy the current immutable object by setting a present value for the optional
skipIntervalMins attribute. |
ImmutableBackupPolicyParams |
withSkipIntervalMins(Optional<Integer> optional)
Copy the current immutable object by setting an optional value for the
skipIntervalMins attribute. |
ImmutableBackupPolicyParams |
withSnapshotArchivalCopyPolicies(Iterable<? extends SnapshotArchivalCopyPolicy> elements)
Copy the current immutable object with elements that replace the content of
snapshotArchivalCopyPolicies . |
ImmutableBackupPolicyParams |
withSnapshotArchivalCopyPolicies(SnapshotArchivalCopyPolicy... elements)
Copy the current immutable object with elements that replace the content of
snapshotArchivalCopyPolicies . |
ImmutableBackupPolicyParams |
withSnapshotReplicationCopyPolicies(Iterable<? extends SnapshotReplicationCopyPolicy> elements)
Copy the current immutable object with elements that replace the content of
snapshotReplicationCopyPolicies . |
ImmutableBackupPolicyParams |
withSnapshotReplicationCopyPolicies(SnapshotReplicationCopyPolicy... elements)
Copy the current immutable object with elements that replace the content of
snapshotReplicationCopyPolicies . |
ImmutableBackupPolicyParams |
withSystemSchedulingPolicy(Optional<? extends SchedulingPolicy> optional)
Copy the current immutable object by setting an optional value for the
systemSchedulingPolicy attribute. |
ImmutableBackupPolicyParams |
withSystemSchedulingPolicy(SchedulingPolicy value)
Copy the current immutable object by setting a present value for the optional
systemSchedulingPolicy attribute. |
public com.google.common.collect.ImmutableList<BlackoutPeriod> blackoutPeriods()
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.
blackoutPeriods
in interface BackupPolicyParams
public long daysToKeep()
daysToKeep
in interface BackupPolicyParams
public Optional<Long> daysToKeepLog()
daysToKeepLog
in interface BackupPolicyParams
public Optional<String> description()
description
in interface BackupPolicyParams
public com.google.common.collect.ImmutableList<ExtendedRetentionPolicy> extendedRetentionPolicies()
extendedRetentionPolicies
in interface BackupPolicyParams
public Optional<SchedulingPolicy> fullSchedulingPolicy()
fullSchedulingPolicy
in interface BackupPolicyParams
public SchedulingPolicy incrementalSchedulingPolicy()
incrementalSchedulingPolicy
in interface BackupPolicyParams
public Optional<SchedulingPolicy> logSchedulingPolicy()
logSchedulingPolicy
in interface BackupPolicyParams
public String name()
name
in interface BackupPolicyParams
public int retries()
retries
in interface BackupPolicyParams
public int retryIntervalMins()
retryIntervalMins
in interface BackupPolicyParams
public Optional<Integer> skipIntervalMins()
skipIntervalMins
in interface BackupPolicyParams
public com.google.common.collect.ImmutableList<SnapshotArchivalCopyPolicy> snapshotArchivalCopyPolicies()
Specifies settings for copying Snapshots to Archival External Targets (such as S3 object storage).
snapshotArchivalCopyPolicies
in interface BackupPolicyParams
public com.google.common.collect.ImmutableList<SnapshotReplicationCopyPolicy> snapshotReplicationCopyPolicies()
Specifies settings for copying Snapshots to Remote Clusters. It also defines the retention of copied Snapshots on a Remote Cluster.
snapshotReplicationCopyPolicies
in interface BackupPolicyParams
public Optional<Long> daysToKeepSystem()
daysToKeepSystem
in interface BackupPolicyParams
public Optional<SchedulingPolicy> systemSchedulingPolicy()
systemSchedulingPolicy
in interface BackupPolicyParams
public final ImmutableBackupPolicyParams withBlackoutPeriods(BlackoutPeriod... elements)
blackoutPeriods
.elements
- The elements to setthis
objectpublic final ImmutableBackupPolicyParams withBlackoutPeriods(Iterable<? extends BlackoutPeriod> elements)
blackoutPeriods
.
A shallow reference equality check is used to prevent copying of the same value by returning this
.elements
- An iterable of blackoutPeriods elements to setthis
objectpublic final ImmutableBackupPolicyParams withDaysToKeep(long value)
daysToKeep
attribute.
A value equality check is used to prevent copying of the same value by returning this
.value
- A new value for daysToKeepthis
objectpublic final ImmutableBackupPolicyParams withDaysToKeepLog(long value)
daysToKeepLog
attribute.value
- The value for daysToKeepLogthis
objectpublic final ImmutableBackupPolicyParams withDaysToKeepLog(Optional<Long> optional)
daysToKeepLog
attribute.
An equality check is used on inner nullable value to prevent copying of the same value by returning this
.optional
- A value for daysToKeepLogthis
objectpublic final ImmutableBackupPolicyParams withDescription(String value)
description
attribute.value
- The value for descriptionthis
objectpublic final ImmutableBackupPolicyParams withDescription(Optional<String> optional)
description
attribute.
An equality check is used on inner nullable value to prevent copying of the same value by returning this
.optional
- A value for descriptionthis
objectpublic final ImmutableBackupPolicyParams withExtendedRetentionPolicies(ExtendedRetentionPolicy... elements)
extendedRetentionPolicies
.elements
- The elements to setthis
objectpublic final ImmutableBackupPolicyParams withExtendedRetentionPolicies(Iterable<? extends ExtendedRetentionPolicy> elements)
extendedRetentionPolicies
.
A shallow reference equality check is used to prevent copying of the same value by returning this
.elements
- An iterable of extendedRetentionPolicies elements to setthis
objectpublic final ImmutableBackupPolicyParams withFullSchedulingPolicy(SchedulingPolicy value)
fullSchedulingPolicy
attribute.value
- The value for fullSchedulingPolicythis
objectpublic final ImmutableBackupPolicyParams withFullSchedulingPolicy(Optional<? extends SchedulingPolicy> optional)
fullSchedulingPolicy
attribute.
A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returning this
.optional
- A value for fullSchedulingPolicythis
objectpublic final ImmutableBackupPolicyParams withIncrementalSchedulingPolicy(SchedulingPolicy value)
incrementalSchedulingPolicy
attribute.
A shallow reference equality check is used to prevent copying of the same value by returning this
.value
- A new value for incrementalSchedulingPolicythis
objectpublic final ImmutableBackupPolicyParams withLogSchedulingPolicy(SchedulingPolicy value)
logSchedulingPolicy
attribute.value
- The value for logSchedulingPolicythis
objectpublic final ImmutableBackupPolicyParams withLogSchedulingPolicy(Optional<? extends SchedulingPolicy> optional)
logSchedulingPolicy
attribute.
A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returning this
.optional
- A value for logSchedulingPolicythis
objectpublic final ImmutableBackupPolicyParams withName(String value)
name
attribute.
An equals check used to prevent copying of the same value by returning this
.value
- A new value for namethis
objectpublic final ImmutableBackupPolicyParams withRetries(int value)
retries
attribute.
A value equality check is used to prevent copying of the same value by returning this
.value
- A new value for retriesthis
objectpublic final ImmutableBackupPolicyParams withRetryIntervalMins(int value)
retryIntervalMins
attribute.
A value equality check is used to prevent copying of the same value by returning this
.value
- A new value for retryIntervalMinsthis
objectpublic final ImmutableBackupPolicyParams withSkipIntervalMins(int value)
skipIntervalMins
attribute.value
- The value for skipIntervalMinsthis
objectpublic final ImmutableBackupPolicyParams withSkipIntervalMins(Optional<Integer> optional)
skipIntervalMins
attribute.
An equality check is used on inner nullable value to prevent copying of the same value by returning this
.optional
- A value for skipIntervalMinsthis
objectpublic final ImmutableBackupPolicyParams withSnapshotArchivalCopyPolicies(SnapshotArchivalCopyPolicy... elements)
snapshotArchivalCopyPolicies
.elements
- The elements to setthis
objectpublic final ImmutableBackupPolicyParams withSnapshotArchivalCopyPolicies(Iterable<? extends SnapshotArchivalCopyPolicy> elements)
snapshotArchivalCopyPolicies
.
A shallow reference equality check is used to prevent copying of the same value by returning this
.elements
- An iterable of snapshotArchivalCopyPolicies elements to setthis
objectpublic final ImmutableBackupPolicyParams withSnapshotReplicationCopyPolicies(SnapshotReplicationCopyPolicy... elements)
snapshotReplicationCopyPolicies
.elements
- The elements to setthis
objectpublic final ImmutableBackupPolicyParams withSnapshotReplicationCopyPolicies(Iterable<? extends SnapshotReplicationCopyPolicy> elements)
snapshotReplicationCopyPolicies
.
A shallow reference equality check is used to prevent copying of the same value by returning this
.elements
- An iterable of snapshotReplicationCopyPolicies elements to setthis
objectpublic final ImmutableBackupPolicyParams withDaysToKeepSystem(long value)
daysToKeepSystem
attribute.value
- The value for daysToKeepSystemthis
objectpublic final ImmutableBackupPolicyParams withDaysToKeepSystem(Optional<Long> optional)
daysToKeepSystem
attribute.
An equality check is used on inner nullable value to prevent copying of the same value by returning this
.optional
- A value for daysToKeepSystemthis
objectpublic final ImmutableBackupPolicyParams withSystemSchedulingPolicy(SchedulingPolicy value)
systemSchedulingPolicy
attribute.value
- The value for systemSchedulingPolicythis
objectpublic final ImmutableBackupPolicyParams withSystemSchedulingPolicy(Optional<? extends SchedulingPolicy> optional)
systemSchedulingPolicy
attribute.
A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returning this
.optional
- A value for systemSchedulingPolicythis
objectpublic boolean equals(@Nullable Object another)
ImmutableBackupPolicyParams
that have equal attribute values.public int hashCode()
blackoutPeriods
, daysToKeep
, daysToKeepLog
, description
, extendedRetentionPolicies
, fullSchedulingPolicy
, incrementalSchedulingPolicy
, logSchedulingPolicy
, name
, retries
, retryIntervalMins
, skipIntervalMins
, snapshotArchivalCopyPolicies
, snapshotReplicationCopyPolicies
, daysToKeepSystem
, systemSchedulingPolicy
.public String toString()
BackupPolicyParams
with attribute values.public static ImmutableBackupPolicyParams copyOf(BackupPolicyParams instance)
BackupPolicyParams
value.
Uses accessors to get values to initialize the new immutable instance.
If an instance is already immutable, it is returned as is.instance
- The instance to copypublic static ImmutableBackupPolicyParams.Builder builder()
ImmutableBackupPolicyParams
.
ImmutableBackupPolicyParams.builder() .addBlackoutPeriods|addAllBlackoutPeriods(com.iland.cohesity.iaas.backups.policies.api.model.BlackoutPeriod) //blackoutPeriods
elements .daysToKeep(long) // requireddaysToKeep
.daysToKeepLog(Long) // optionaldaysToKeepLog
.description(String) // optionaldescription
.addExtendedRetentionPolicies|addAllExtendedRetentionPolicies(com.iland.cohesity.iaas.backups.policies.api.model.ExtendedRetentionPolicy) //extendedRetentionPolicies
elements .fullSchedulingPolicy(com.iland.cohesity.iaas.backups.policies.api.model.SchedulingPolicy) // optionalfullSchedulingPolicy
.incrementalSchedulingPolicy(com.iland.cohesity.iaas.backups.policies.api.model.SchedulingPolicy) // requiredincrementalSchedulingPolicy
.logSchedulingPolicy(com.iland.cohesity.iaas.backups.policies.api.model.SchedulingPolicy) // optionallogSchedulingPolicy
.name(String) // requiredname
.retries(int) // requiredretries
.retryIntervalMins(int) // requiredretryIntervalMins
.skipIntervalMins(Integer) // optionalskipIntervalMins
.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 .daysToKeepSystem(Long) // optionaldaysToKeepSystem
.systemSchedulingPolicy(com.iland.cohesity.iaas.backups.policies.api.model.SchedulingPolicy) // optionalsystemSchedulingPolicy
.build();
Copyright © 2023 iland Internet Solutions, Corp. All rights reserved.