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

Class ImmutableExtendedRetentionPolicy

java.lang.Object

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

All Implemented Interfaces:

ExtendedRetentionPolicy

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

Immutable implementation of ExtendedRetentionPolicy.

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
Optional<RunType>	backupRunType() Specifies the type of the backup run.
static ImmutableExtendedRetentionPolicy.Builder	builder() Creates a builder for ImmutableExtendedRetentionPolicy.
static ImmutableExtendedRetentionPolicy	copyOf(ExtendedRetentionPolicy instance) Creates an immutable copy of a ExtendedRetentionPolicy value.
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 ImmutableExtendedRetentionPolicy that have equal attribute values.
int	hashCode() Computes a hash code from attributes: backupRunType, daysToKeep, multiplier, periodicity.
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.
String	toString() Prints the immutable value ExtendedRetentionPolicy with attribute values.
ImmutableExtendedRetentionPolicy	withBackupRunType(Optional<? extends RunType> optional) Copy the current immutable object by setting an optional value for the backupRunType attribute.
ImmutableExtendedRetentionPolicy	withBackupRunType(RunType value) Copy the current immutable object by setting a present value for the optional backupRunType attribute.
ImmutableExtendedRetentionPolicy	withDaysToKeep(long value) Copy the current immutable object by setting a value for the daysToKeep attribute.
ImmutableExtendedRetentionPolicy	withMultiplier(int value) Copy the current immutable object by setting a value for the multiplier attribute.
ImmutableExtendedRetentionPolicy	withPeriodicity(ReplicationPeriodicity value) Copy the current immutable object by setting a value for the periodicity attribute.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

backupRunType

public Optional<RunType> backupRunType()

Specifies the type of the backup run.

Specified by:

backupRunType in interface ExtendedRetentionPolicy

daysToKeep

public long daysToKeep()

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

Specified by:

daysToKeep in interface ExtendedRetentionPolicy

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 ExtendedRetentionPolicy

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 ExtendedRetentionPolicy

withBackupRunType

public final ImmutableExtendedRetentionPolicy withBackupRunType(RunType value)

Copy the current immutable object by setting a present value for the optional backupRunType attribute.

Parameters:

value - The value for backupRunType

Returns:

A modified copy of this object

withBackupRunType

public final ImmutableExtendedRetentionPolicy withBackupRunType(Optional<? extends RunType> optional)

Copy the current immutable object by setting an optional value for the backupRunType 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 backupRunType

Returns:

A modified copy of this object

withDaysToKeep

public final ImmutableExtendedRetentionPolicy 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 ImmutableExtendedRetentionPolicy 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 ImmutableExtendedRetentionPolicy 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

equals

public boolean equals(@Nullable
                      Object another)

This instance is equal to all instances of ImmutableExtendedRetentionPolicy 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: backupRunType, daysToKeep, multiplier, periodicity.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value ExtendedRetentionPolicy with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static ImmutableExtendedRetentionPolicy copyOf(ExtendedRetentionPolicy instance)

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

builder

public static ImmutableExtendedRetentionPolicy.Builder builder()

Creates a builder for ImmutableExtendedRetentionPolicy.

 ImmutableExtendedRetentionPolicy.builder()
    .backupRunType(com.iland.cohesity.iaas.backups.common.enums.RunType) // optional backupRunType
    .daysToKeep(long) // required daysToKeep
    .multiplier(int) // required multiplier
    .periodicity(com.iland.cohesity.iaas.backups.policies.api.enums.ReplicationPeriodicity) // required periodicity
    .build();
 

Returns:

A new ImmutableExtendedRetentionPolicy builder