ImmutableSnapshotReplicationCopyPolicy (iland cloud Java SDK 1.0.45 API)

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

All Implemented Interfaces:: SnapshotReplicationCopyPolicy

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

Immutable implementation of SnapshotReplicationCopyPolicy.

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ImmutableSnapshotReplicationCopyPolicy.Builder
Builds instances of type ImmutableSnapshotReplicationCopyPolicy.

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ImmutableSnapshotReplicationCopyPolicy.Builder`	`builder()` Creates a builder for `ImmutableSnapshotReplicationCopyPolicy`.
`static ImmutableSnapshotReplicationCopyPolicy`	`copyOf(SnapshotReplicationCopyPolicy instance)` Creates an immutable copy of a `SnapshotReplicationCopyPolicy` value.
`boolean`	`copyPartial()` Specifies if Snapshots are copied from the first completely successful VCloudProtectionJob Run or the first partially successful VCloudProtectionJob Run occurring at the start of the replication schedule.
`long`	`daysToKeep()` Specifies the number of days to retain copied Snapshots on the target.
`boolean`	`equals(Object another)` This instance is equal to all instances of `ImmutableSnapshotReplicationCopyPolicy` that have equal attribute values.
`int`	`hashCode()` Computes a hash code from attributes: `copyPartial`, `daysToKeep`, `multiplier`, `periodicity`, `target`.
`int`	`multiplier()` Specifies a factor to multiply the periodicity by, to determine the copy schedule.
`ReplicationPeriodicity`	`periodicity()` Specifies the frequency that Snapshots should be copied to the specified target.
`ReplicationTargetSettings`	`target()` Specifies the replication target to copy the Snapshots to.
`String`	`toString()` Prints the immutable value `SnapshotReplicationCopyPolicy` with attribute values.
`ImmutableSnapshotReplicationCopyPolicy`	`withCopyPartial(boolean value)` Copy the current immutable object by setting a value for the `copyPartial` attribute.
`ImmutableSnapshotReplicationCopyPolicy`	`withDaysToKeep(long value)` Copy the current immutable object by setting a value for the `daysToKeep` attribute.
`ImmutableSnapshotReplicationCopyPolicy`	`withMultiplier(int value)` Copy the current immutable object by setting a value for the `multiplier` attribute.
`ImmutableSnapshotReplicationCopyPolicy`	`withPeriodicity(ReplicationPeriodicity value)` Copy the current immutable object by setting a value for the `periodicity` attribute.
`ImmutableSnapshotReplicationCopyPolicy`	`withTarget(ReplicationTargetSettings value)` Copy the current immutable object by setting a value for the `target` attribute.

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

- Method Detail
  - copyPartial
```
public boolean copyPartial()
```
    Specifies if Snapshots are copied from the first completely successful VCloudProtectionJob Run or the first partially successful VCloudProtectionJob Run occurring at the start of the replication schedule. If true, Snapshots are copied from the first VCloudProtectionJob Run occurring at the start of the replication schedule, even if first VCloudProtectionJob Run was not completely successful i.e. Snapshots were not captured for all Objects in the VCloudProtectionJob. If false, Snapshots are copied from the first VCloudProtectionJob Run occurring at the start of the replication schedule that was completely successful i.e. Snapshots for all the Objects in the VCloudProtectionJob were successfully captured.
    
    Specified by:
    
    copyPartial in interface SnapshotReplicationCopyPolicy
  - daysToKeep
```
public long daysToKeep()
```
    Specifies the number of days to retain copied Snapshots on the target.
    
    Specified by:
    
    daysToKeep in interface SnapshotReplicationCopyPolicy
  - multiplier
```
public int multiplier()
```
    Specifies a factor to multiply the periodicity by, to determine the copy schedule. For example if set to 2 and the periodicity is hourly, then Snapshots from the first eligible VCloudProtectionJob Run for every 2 hour period is copied.
    
    Specified by:
    
    multiplier in interface SnapshotReplicationCopyPolicy
  - periodicity
```
public ReplicationPeriodicity periodicity()
```
    Specifies the frequency that Snapshots should be copied to the specified target. Used in combination with multipiler.
    
    Specified by:
    
    periodicity in interface SnapshotReplicationCopyPolicy
  - target
```
public ReplicationTargetSettings target()
```
    Specifies the replication target to copy the Snapshots to.
    
    Specified by:
    
    target in interface SnapshotReplicationCopyPolicy
  - withCopyPartial
```
public final ImmutableSnapshotReplicationCopyPolicy withCopyPartial(boolean value)
```
    Copy the current immutable object by setting a value for the copyPartial attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for copyPartial
    
    Returns:
    
    A modified copy of the this object
  - withDaysToKeep
```
public final ImmutableSnapshotReplicationCopyPolicy 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
  - withMultiplier
```
public final ImmutableSnapshotReplicationCopyPolicy withMultiplier(int value)
```
    Copy the current immutable object by setting a value for the multiplier attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for multiplier
    
    Returns:
    
    A modified copy of the this object
  - withPeriodicity
```
public final ImmutableSnapshotReplicationCopyPolicy withPeriodicity(ReplicationPeriodicity value)
```
    Copy the current immutable object by setting a value for the periodicity attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for periodicity
    
    Returns:
    
    A modified copy of the this object
  - withTarget
```
public final ImmutableSnapshotReplicationCopyPolicy withTarget(ReplicationTargetSettings value)
```
    Copy the current immutable object by setting a value for the target attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for target
    
    Returns:
    
    A modified copy of the this object
  - equals
```
public boolean equals(@Nullable
                      Object another)
```
    This instance is equal to all instances of ImmutableSnapshotReplicationCopyPolicy 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: copyPartial, daysToKeep, multiplier, periodicity, target.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    hashCode value
  - toString
```
public String toString()
```
    Prints the immutable value SnapshotReplicationCopyPolicy with attribute values.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of the value
  - copyOf
```
public static ImmutableSnapshotReplicationCopyPolicy copyOf(SnapshotReplicationCopyPolicy instance)
```
    Creates an immutable copy of a SnapshotReplicationCopyPolicy 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 SnapshotReplicationCopyPolicy instance
  - builder
```
public static ImmutableSnapshotReplicationCopyPolicy.Builder builder()
```
    Creates a builder for ImmutableSnapshotReplicationCopyPolicy.
```
 ImmutableSnapshotReplicationCopyPolicy.builder()
    .copyPartial(boolean) // required copyPartial
    .daysToKeep(long) // required daysToKeep
    .multiplier(int) // required multiplier
    .periodicity(com.iland.cohesity.iaas.backups.policies.api.enums.ReplicationPeriodicity) // required periodicity
    .target(com.iland.cohesity.iaas.backups.common.model.ReplicationTargetSettings) // required target
    .build();
 
```
    Returns:
    
    A new ImmutableSnapshotReplicationCopyPolicy builder

Class ImmutableSnapshotReplicationCopyPolicy

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

copyPartial

daysToKeep

multiplier

periodicity

target

withCopyPartial

withDaysToKeep

withMultiplier

withPeriodicity

withTarget

equals

hashCode

toString

copyOf

builder