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

Class ImmutableBackupGroupParams

java.lang.Object

com.iland.cohesity.iaas.backups.backupgroups.api.model.ImmutableBackupGroupParams

All Implemented Interfaces:

BackupGroupParams

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

Immutable implementation of BackupGroupParams.

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
boolean	abortInBlackoutPeriod() If true, aborts any currently executing Job Runs of this backup group when a blackout period specified for this Job starts, even if the Job Run started before the blackout period began.
static ImmutableBackupGroupParams.Builder	builder() Creates a builder for ImmutableBackupGroupParams.
boolean	continueOnQuiesceFailure() Whether to continue backing up on quiesce failure.
static ImmutableBackupGroupParams	copyOf(BackupGroupParams instance) Creates an immutable copy of a BackupGroupParams value.
Optional<String>	description() Specifies a text description about the backup group.
Optional<Instant>	endTime() Specifies the time after which the backup group becomes dormant.
boolean	equals(Object another) This instance is equal to all instances of ImmutableBackupGroupParams that have equal attribute values.
com.google.common.collect.ImmutableList<BackupGroupDiskUnit>	excludedDisks() Specifies the list of Disks to be excluded from backing up.
boolean	fallbackToCrashConsistent() If true, takes a crash-consistent snapshot when app-consistent snapshot fails.
long	fullProtectionSlaTimeMins() If specified, this setting is number of minutes that a backup group Run of a Full (no CBT) backup schedule is expected to complete, which is known as a Service-Level Agreement (SLA).
int	hashCode() Computes a hash code from attributes: name, description, endTime, excludedDisks, fallbackToCrashConsistent, skipPhysicalRdmDisks, fullProtectionSlaTimeMins, incrementalProtectionSlaTimeMins, indexingPolicy, policyId, priority, qosType, vcloudExcludedSources, vcloudProtectedSources, startTime, timezone, abortInBlackoutPeriod, continueOnQuiesceFailure, quiesce.
long	incrementalProtectionSlaTimeMins() If specified, this setting is number of minutes that a backup group Run of a CBT-based backup schedule is expected to complete, which is known as a Service-Level Agreement (SLA).
Optional<BackupGroupIndexingPolicy>	indexingPolicy() Specifies settings for indexing files found in an Object (such as a VM) so these files can be searched and recovered.
String	name() Specifies the name of the backup group.
PolicyUid	policyId() Specifies the unique id of the Protection Policy associated with the backup group.
BackupGroupPriority	priority() Specifies the priority of execution for a backup group.
BackupGroupQosType	qosType() Specifies the QoS policy type to use for this Protection backup group.
boolean	quiesce() Indicates if the App-Consistent option is enabled for this backup group.
boolean	skipPhysicalRdmDisks() If true, skip physical RDM disks when backing up VMs.
TimeOfDay	startTime() Specifies the time of day to start the Protection Schedule.
String	timezone() Specifies the timezone to use when calculating time for this Protection backup group such as the backup group start time.
String	toString() Prints the immutable value BackupGroupParams with attribute values.
com.google.common.collect.ImmutableSet<VCloudProtectionSourceRef>	vcloudExcludedSources() Array of Excluded vCloud Source Objects.
com.google.common.collect.ImmutableSet<VCloudProtectionSourceRef>	vcloudProtectedSources() Array of Protected vCloud Source Objects.
ImmutableBackupGroupParams	withAbortInBlackoutPeriod(boolean value) Copy the current immutable object by setting a value for the abortInBlackoutPeriod attribute.
ImmutableBackupGroupParams	withContinueOnQuiesceFailure(boolean value) Copy the current immutable object by setting a value for the continueOnQuiesceFailure attribute.
ImmutableBackupGroupParams	withDescription(Optional<String> optional) Copy the current immutable object by setting an optional value for the description attribute.
ImmutableBackupGroupParams	withDescription(String value) Copy the current immutable object by setting a present value for the optional description attribute.
ImmutableBackupGroupParams	withEndTime(Instant value) Copy the current immutable object by setting a present value for the optional endTime attribute.
ImmutableBackupGroupParams	withEndTime(Optional<? extends Instant> optional) Copy the current immutable object by setting an optional value for the endTime attribute.
ImmutableBackupGroupParams	withExcludedDisks(BackupGroupDiskUnit... elements) Copy the current immutable object with elements that replace the content of excludedDisks.
ImmutableBackupGroupParams	withExcludedDisks(Iterable<? extends BackupGroupDiskUnit> elements) Copy the current immutable object with elements that replace the content of excludedDisks.
ImmutableBackupGroupParams	withFallbackToCrashConsistent(boolean value) Copy the current immutable object by setting a value for the fallbackToCrashConsistent attribute.
ImmutableBackupGroupParams	withFullProtectionSlaTimeMins(long value) Copy the current immutable object by setting a value for the fullProtectionSlaTimeMins attribute.
ImmutableBackupGroupParams	withIncrementalProtectionSlaTimeMins(long value) Copy the current immutable object by setting a value for the incrementalProtectionSlaTimeMins attribute.
ImmutableBackupGroupParams	withIndexingPolicy(BackupGroupIndexingPolicy value) Copy the current immutable object by setting a present value for the optional indexingPolicy attribute.
ImmutableBackupGroupParams	withIndexingPolicy(Optional<? extends BackupGroupIndexingPolicy> optional) Copy the current immutable object by setting an optional value for the indexingPolicy attribute.
ImmutableBackupGroupParams	withName(String value) Copy the current immutable object by setting a value for the name attribute.
ImmutableBackupGroupParams	withPolicyId(PolicyUid value) Copy the current immutable object by setting a value for the policyId attribute.
ImmutableBackupGroupParams	withPriority(BackupGroupPriority value) Copy the current immutable object by setting a value for the priority attribute.
ImmutableBackupGroupParams	withQosType(BackupGroupQosType value) Copy the current immutable object by setting a value for the qosType attribute.
ImmutableBackupGroupParams	withQuiesce(boolean value) Copy the current immutable object by setting a value for the quiesce attribute.
ImmutableBackupGroupParams	withSkipPhysicalRdmDisks(boolean value) Copy the current immutable object by setting a value for the skipPhysicalRdmDisks attribute.
ImmutableBackupGroupParams	withStartTime(TimeOfDay value) Copy the current immutable object by setting a value for the startTime attribute.
ImmutableBackupGroupParams	withTimezone(String value) Copy the current immutable object by setting a value for the timezone attribute.
ImmutableBackupGroupParams	withVcloudExcludedSources(Iterable<? extends VCloudProtectionSourceRef> elements) Copy the current immutable object with elements that replace the content of vcloudExcludedSources.
ImmutableBackupGroupParams	withVcloudExcludedSources(VCloudProtectionSourceRef... elements) Copy the current immutable object with elements that replace the content of vcloudExcludedSources.
ImmutableBackupGroupParams	withVcloudProtectedSources(Iterable<? extends VCloudProtectionSourceRef> elements) Copy the current immutable object with elements that replace the content of vcloudProtectedSources.
ImmutableBackupGroupParams	withVcloudProtectedSources(VCloudProtectionSourceRef... elements) Copy the current immutable object with elements that replace the content of vcloudProtectedSources.

Methods inherited from class java.lang.Object

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

Method Detail

name

public String name()

Specifies the name of the backup group.

Specified by:

name in interface BackupGroupParams

description

public Optional<String> description()

Specifies a text description about the backup group.

Specified by:

description in interface BackupGroupParams

endTime

public Optional<Instant> endTime()

Specifies the time after which the backup group becomes dormant.

Specified by:

endTime in interface BackupGroupParams

excludedDisks

public com.google.common.collect.ImmutableList<BackupGroupDiskUnit> excludedDisks()

Specifies the list of Disks to be excluded from backing up. These disks are excluded from all Protection Sources in the backup group

Specified by:

excludedDisks in interface BackupGroupParams

fallbackToCrashConsistent

public boolean fallbackToCrashConsistent()

If true, takes a crash-consistent snapshot when app-consistent snapshot fails. Otherwise, the snapshot attempt is marked failed.

Specified by:

fallbackToCrashConsistent in interface BackupGroupParams

skipPhysicalRdmDisks

public boolean skipPhysicalRdmDisks()

If true, skip physical RDM disks when backing up VMs. Otherwise, backup of VMs having physical RDM will fail.

Specified by:

skipPhysicalRdmDisks in interface BackupGroupParams

fullProtectionSlaTimeMins

public long fullProtectionSlaTimeMins()

If specified, this setting is number of minutes that a backup group Run of a Full (no CBT) backup schedule is expected to complete, which is known as a Service-Level Agreement (SLA). A SLA violation is reported when the run time of a backup group Run exceeds the SLA time period specified for this backup schedule.

Specified by:

fullProtectionSlaTimeMins in interface BackupGroupParams

incrementalProtectionSlaTimeMins

public long incrementalProtectionSlaTimeMins()

If specified, this setting is number of minutes that a backup group Run of a CBT-based backup schedule is expected to complete, which is known as a Service-Level Agreement (SLA). A SLA violation is reported when the run time of a backup group Run exceeds the SLA time period specified for this backup schedule.

Specified by:

incrementalProtectionSlaTimeMins in interface BackupGroupParams

indexingPolicy

public Optional<BackupGroupIndexingPolicy> indexingPolicy()

Specifies settings for indexing files found in an Object (such as a VM) so these files can be searched and recovered. This also specifies inclusion and exclusion rules that determine the directories to index.

Specified by:

indexingPolicy in interface BackupGroupParams

policyId

public PolicyUid policyId()

Specifies the unique id of the Protection Policy associated with the backup group. The Policy provides retry settings, Protection Schedules, Priority, SLA, etc. The backup group defines the Storage Domain, the Objects to Protect (if applicable), Start Time, Indexing settings, etc.

Specified by:

policyId in interface BackupGroupParams

priority

public BackupGroupPriority priority()

Specifies the priority of execution for a backup group. iland Supports concurrent backups but if the number of Jobs exceeds the ability to process Jobs, the specified priority determines the execution backup group priority. This field also specifies the replication priority. 'LOW' indicates lowest execution priority for a backup group. 'MEDIUM' indicates medium execution priority for a backup group. 'HIGH' indicates highest execution priority for a backup group.

Specified by:

priority in interface BackupGroupParams

qosType

public BackupGroupQosType qosType()

Specifies the QoS policy type to use for this Protection backup group. 'HDD' indicates that data is written directly to the HDD tier for this job. This is the recommended setting. 'SSD' indicates that data is written directly to the SSD tier for this job. Only specify this policy if you need fast ingest speed for a small number of backup groups.

Specified by:

qosType in interface BackupGroupParams

vcloudExcludedSources

public com.google.common.collect.ImmutableSet<VCloudProtectionSourceRef> vcloudExcludedSources()

Array of Excluded vCloud Source Objects.

List of sources from a Protection Source that should not be protected and are excluded from being backed up by the job. Leaf and non-leaf Objects may be in this list and an Object in this list must have an ancestor in the BackupGroupParams.vcloudProtectedSources() list.

Specified by:

vcloudExcludedSources in interface BackupGroupParams

vcloudProtectedSources

public com.google.common.collect.ImmutableSet<VCloudProtectionSourceRef> vcloudProtectedSources()

Array of Protected vCloud Source Objects.

Specifies the list of Objects to protect (or back up) by the Protection backup group. An Object in this list may be descendant of another Object in this list.

Specified by:

vcloudProtectedSources in interface BackupGroupParams

startTime

public TimeOfDay startTime()

Specifies the time of day to start the Protection Schedule. This is optional and only applicable if the Protection Policy defines a monthly or a daily Protection Schedule.

Specified by:

startTime in interface BackupGroupParams

timezone

public String timezone()

Specifies the timezone to use when calculating time for this Protection backup group such as the backup group start time. Specify the timezone in the following format: "Area/Location", for example: "America/New_York".

Specified by:

timezone in interface BackupGroupParams

abortInBlackoutPeriod

public boolean abortInBlackoutPeriod()

If true, aborts any currently executing Job Runs of this backup group when a blackout period specified for this Job starts, even if the Job Run started before the blackout period began. If false, a backup group Run continues to execute, if the Job Run started before the blackout period starts.

Specified by:

abortInBlackoutPeriod in interface BackupGroupParams

continueOnQuiesceFailure

public boolean continueOnQuiesceFailure()

Whether to continue backing up on quiesce failure.

Specified by:

continueOnQuiesceFailure in interface BackupGroupParams

quiesce

public boolean quiesce()

Indicates if the App-Consistent option is enabled for this backup group. If the option is enabled, quiesces the file system and applications before taking Application-Consistent Snapshots. VMware Tools must be installed on the guest Operating System.

Specified by:

quiesce in interface BackupGroupParams

withName

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

withDescription

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

withEndTime

public final ImmutableBackupGroupParams withEndTime(Instant value)

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

Parameters:

value - The value for endTime

Returns:

A modified copy of this object

withEndTime

public final ImmutableBackupGroupParams withEndTime(Optional<? extends Instant> optional)

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

Returns:

A modified copy of this object

withExcludedDisks

public final ImmutableBackupGroupParams withExcludedDisks(BackupGroupDiskUnit... elements)

Copy the current immutable object with elements that replace the content of excludedDisks.

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withExcludedDisks

public final ImmutableBackupGroupParams withExcludedDisks(Iterable<? extends BackupGroupDiskUnit> elements)

Copy the current immutable object with elements that replace the content of excludedDisks. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

elements - An iterable of excludedDisks elements to set

Returns:

A modified copy of this object

withFallbackToCrashConsistent

public final ImmutableBackupGroupParams withFallbackToCrashConsistent(boolean value)

Copy the current immutable object by setting a value for the fallbackToCrashConsistent attribute. A value equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for fallbackToCrashConsistent

Returns:

A modified copy of the this object

withSkipPhysicalRdmDisks

public final ImmutableBackupGroupParams withSkipPhysicalRdmDisks(boolean value)

Copy the current immutable object by setting a value for the skipPhysicalRdmDisks attribute. A value equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for skipPhysicalRdmDisks

Returns:

A modified copy of the this object

withFullProtectionSlaTimeMins

public final ImmutableBackupGroupParams withFullProtectionSlaTimeMins(long value)

Copy the current immutable object by setting a value for the fullProtectionSlaTimeMins attribute. A value equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for fullProtectionSlaTimeMins

Returns:

A modified copy of the this object

withIncrementalProtectionSlaTimeMins

public final ImmutableBackupGroupParams withIncrementalProtectionSlaTimeMins(long value)

Copy the current immutable object by setting a value for the incrementalProtectionSlaTimeMins attribute. A value equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for incrementalProtectionSlaTimeMins

Returns:

A modified copy of the this object

withIndexingPolicy

public final ImmutableBackupGroupParams withIndexingPolicy(BackupGroupIndexingPolicy value)

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

Parameters:

value - The value for indexingPolicy

Returns:

A modified copy of this object

withIndexingPolicy

public final ImmutableBackupGroupParams withIndexingPolicy(Optional<? extends BackupGroupIndexingPolicy> optional)

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

Returns:

A modified copy of this object

withPolicyId

public final ImmutableBackupGroupParams withPolicyId(PolicyUid value)

Copy the current immutable object by setting a value for the policyId attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for policyId

Returns:

A modified copy of the this object

withPriority

public final ImmutableBackupGroupParams withPriority(BackupGroupPriority value)

Copy the current immutable object by setting a value for the priority attribute. A value equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for priority

Returns:

A modified copy of the this object

withQosType

public final ImmutableBackupGroupParams withQosType(BackupGroupQosType value)

Copy the current immutable object by setting a value for the qosType attribute. A value equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for qosType

Returns:

A modified copy of the this object

withVcloudExcludedSources

public final ImmutableBackupGroupParams withVcloudExcludedSources(VCloudProtectionSourceRef... elements)

Copy the current immutable object with elements that replace the content of vcloudExcludedSources.

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withVcloudExcludedSources

public final ImmutableBackupGroupParams withVcloudExcludedSources(Iterable<? extends VCloudProtectionSourceRef> elements)

Copy the current immutable object with elements that replace the content of vcloudExcludedSources. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

elements - An iterable of vcloudExcludedSources elements to set

Returns:

A modified copy of this object

withVcloudProtectedSources

public final ImmutableBackupGroupParams withVcloudProtectedSources(VCloudProtectionSourceRef... elements)

Copy the current immutable object with elements that replace the content of vcloudProtectedSources.

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withVcloudProtectedSources

public final ImmutableBackupGroupParams withVcloudProtectedSources(Iterable<? extends VCloudProtectionSourceRef> elements)

Copy the current immutable object with elements that replace the content of vcloudProtectedSources. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

elements - An iterable of vcloudProtectedSources elements to set

Returns:

A modified copy of this object

withStartTime

public final ImmutableBackupGroupParams withStartTime(TimeOfDay value)

Copy the current immutable object by setting a value for the startTime attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for startTime

Returns:

A modified copy of the this object

withTimezone

public final ImmutableBackupGroupParams withTimezone(String value)

Copy the current immutable object by setting a value for the timezone attribute. An equals check used to prevent copying of the same value by returning this.

Parameters:

value - A new value for timezone

Returns:

A modified copy of the this object

withAbortInBlackoutPeriod

public final ImmutableBackupGroupParams withAbortInBlackoutPeriod(boolean value)

Copy the current immutable object by setting a value for the abortInBlackoutPeriod attribute. A value equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for abortInBlackoutPeriod

Returns:

A modified copy of the this object

withContinueOnQuiesceFailure

public final ImmutableBackupGroupParams withContinueOnQuiesceFailure(boolean value)

Copy the current immutable object by setting a value for the continueOnQuiesceFailure attribute. A value equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for continueOnQuiesceFailure

Returns:

A modified copy of the this object

withQuiesce

public final ImmutableBackupGroupParams withQuiesce(boolean value)

Copy the current immutable object by setting a value for the quiesce attribute. A value equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for quiesce

Returns:

A modified copy of the this object

equals

public boolean equals(@Nullable
                      Object another)

This instance is equal to all instances of ImmutableBackupGroupParams 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: name, description, endTime, excludedDisks, fallbackToCrashConsistent, skipPhysicalRdmDisks, fullProtectionSlaTimeMins, incrementalProtectionSlaTimeMins, indexingPolicy, policyId, priority, qosType, vcloudExcludedSources, vcloudProtectedSources, startTime, timezone, abortInBlackoutPeriod, continueOnQuiesceFailure, quiesce.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value BackupGroupParams with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static ImmutableBackupGroupParams copyOf(BackupGroupParams instance)

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

builder

public static ImmutableBackupGroupParams.Builder builder()

Creates a builder for ImmutableBackupGroupParams.

 ImmutableBackupGroupParams.builder()
    .name(String) // required name
    .description(String) // optional description
    .endTime(java.time.Instant) // optional endTime
    .addExcludedDisks|addAllExcludedDisks(com.iland.cohesity.iaas.backups.backupgroups.api.model.BackupGroupDiskUnit) // excludedDisks elements
    .fallbackToCrashConsistent(boolean) // required fallbackToCrashConsistent
    .skipPhysicalRdmDisks(boolean) // required skipPhysicalRdmDisks
    .fullProtectionSlaTimeMins(long) // required fullProtectionSlaTimeMins
    .incrementalProtectionSlaTimeMins(long) // required incrementalProtectionSlaTimeMins
    .indexingPolicy(com.iland.cohesity.iaas.backups.backupgroups.api.model.BackupGroupIndexingPolicy) // optional indexingPolicy
    .policyId(com.iland.cohesity.iaas.backups.common.model.PolicyUid) // required policyId
    .priority(com.iland.cohesity.iaas.backups.backupgroups.enums.BackupGroupPriority) // required priority
    .qosType(com.iland.cohesity.iaas.backups.backupgroups.enums.BackupGroupQosType) // required qosType
    .addVcloudExcludedSources|addAllVcloudExcludedSources(com.iland.cohesity.iaas.backups.common.model.VCloudProtectionSourceRef) // vcloudExcludedSources elements
    .addVcloudProtectedSources|addAllVcloudProtectedSources(com.iland.cohesity.iaas.backups.common.model.VCloudProtectionSourceRef) // vcloudProtectedSources elements
    .startTime(com.iland.cohesity.iaas.backups.common.model.TimeOfDay) // required startTime
    .timezone(String) // required timezone
    .abortInBlackoutPeriod(boolean) // required abortInBlackoutPeriod
    .continueOnQuiesceFailure(boolean) // required continueOnQuiesceFailure
    .quiesce(boolean) // required quiesce
    .build();
 

Returns:

A new ImmutableBackupGroupParams builder