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

Class ImmutableSnapshotArchivalCopyPolicy

java.lang.Object

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

All Implemented Interfaces:

SnapshotArchivalCopyPolicy

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

Immutable implementation of SnapshotArchivalCopyPolicy.

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ImmutableSnapshotArchivalCopyPolicy.Builder Builds instances of type ImmutableSnapshotArchivalCopyPolicy.

Method Summary

Modifier and Type	Method and Description
static ImmutableSnapshotArchivalCopyPolicy.Builder	builder() Creates a builder for ImmutableSnapshotArchivalCopyPolicy.
static ImmutableSnapshotArchivalCopyPolicy	copyOf(SnapshotArchivalCopyPolicy instance) Creates an immutable copy of a SnapshotArchivalCopyPolicy value.
boolean	copyPartial() Specifies if Snapshots are copied from the first completely successful backup group Run or the first partially successful backup group 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 ImmutableSnapshotArchivalCopyPolicy 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.
ArchivalExternalTarget	target() Specifies the archival target to copy the Snapshots to.
String	toString() Prints the immutable value SnapshotArchivalCopyPolicy with attribute values.
ImmutableSnapshotArchivalCopyPolicy	withCopyPartial(boolean value) Copy the current immutable object by setting a value for the copyPartial attribute.
ImmutableSnapshotArchivalCopyPolicy	withDaysToKeep(long value) Copy the current immutable object by setting a value for the daysToKeep attribute.
ImmutableSnapshotArchivalCopyPolicy	withMultiplier(int value) Copy the current immutable object by setting a value for the multiplier attribute.
ImmutableSnapshotArchivalCopyPolicy	withPeriodicity(ReplicationPeriodicity value) Copy the current immutable object by setting a value for the periodicity attribute.
ImmutableSnapshotArchivalCopyPolicy	withTarget(ArchivalExternalTarget 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 backup group Run or the first partially successful backup group Run occurring at the start of the replication schedule. If true, Snapshots are copied from the first backup group Run occurring at the start of the replication schedule, even if first backup group Run was not completely successful i.e. Snapshots were not captured for all Objects in the backup group. If false, Snapshots are copied from the first backup group Run occurring at the start of the replication schedule that was completely successful i.e. Snapshots for all the Objects in the backup group were successfully captured.

Specified by:

copyPartial in interface SnapshotArchivalCopyPolicy

daysToKeep

public long daysToKeep()

Specifies the number of days to retain copied Snapshots on the target.

Specified by:

daysToKeep in interface SnapshotArchivalCopyPolicy

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 backup group Run for every 2 hour period is copied.

Specified by:

multiplier in interface SnapshotArchivalCopyPolicy

periodicity

public ReplicationPeriodicity periodicity()

Specifies the frequency that Snapshots should be copied to the specified target. Used in combination with multiplier.

Specified by:

periodicity in interface SnapshotArchivalCopyPolicy

target

public ArchivalExternalTarget target()

Specifies the archival target to copy the Snapshots to.

Specified by:

target in interface SnapshotArchivalCopyPolicy

withCopyPartial

public final ImmutableSnapshotArchivalCopyPolicy 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 ImmutableSnapshotArchivalCopyPolicy 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 ImmutableSnapshotArchivalCopyPolicy 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 ImmutableSnapshotArchivalCopyPolicy 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 ImmutableSnapshotArchivalCopyPolicy withTarget(ArchivalExternalTarget 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 ImmutableSnapshotArchivalCopyPolicy 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 SnapshotArchivalCopyPolicy with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static ImmutableSnapshotArchivalCopyPolicy copyOf(SnapshotArchivalCopyPolicy instance)

Creates an immutable copy of a SnapshotArchivalCopyPolicy 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 SnapshotArchivalCopyPolicy instance

builder

public static ImmutableSnapshotArchivalCopyPolicy.Builder builder()

Creates a builder for ImmutableSnapshotArchivalCopyPolicy.

 ImmutableSnapshotArchivalCopyPolicy.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.ArchivalExternalTarget) // required target
    .build();
 

Returns:

A new ImmutableSnapshotArchivalCopyPolicy builder