ImmutableBackupGroup (iland cloud Java SDK 1.0.45 API)

java.lang.Object
- com.iland.cohesity.iaas.backups.backupgroups.api.model.ImmutableBackupGroup

All Implemented Interfaces:: BackupGroup

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

Immutable implementation of BackupGroup.

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ImmutableBackupGroup.Builder
Builds instances of type ImmutableBackupGroup.

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`abortInBlackoutPeriod()` If true, aborts any currently executing backup group Runs of this backup group when a blackout period specified for this backup group starts, even if the backup group Run started before the blackout period began.
`boolean`	`active()` Indicates if the current state of the backup group is Active or Inactive.
`static ImmutableBackupGroup.Builder`	`builder()` Creates a builder for `ImmutableBackupGroup`.
`TenantUid`	`cohesityTenantUid()` Specifies the UID of the parent Cohesity tenant/org.
`CompanyId`	`companyId()` The ID of the iland company that is associated with the protection backup group.
`boolean`	`continueOnQuiesceFailure()` Whether to continue backing up on quiesce failure.
`static ImmutableBackupGroup`	`copyOf(BackupGroup instance)` Creates an immutable copy of a `BackupGroup` value.
`Instant`	`creationTime()` Specifies the time when the backup group was created.
`boolean`	`deleted()` Equals 'true' if the backup group was deleted but some Snapshots are still associated with this backup group.
`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 `ImmutableBackupGroup` that have equal attribute values.
`com.google.common.collect.ImmutableList<BackupGroupDiskUnit>`	`excludedDisks()` Specifies the list of Disks to be excluded from backing up.
`com.google.common.collect.ImmutableSet<VCloudProtectionSource>`	`excludedSources()` Array of globally identifiable Excluded Source Objects, including references to associated vCloud entities.
`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: `id`, `uid`, `name`, `creationTime`, `modifiedTime`, `description`, `endTime`, `active`, `deleted`, `paused`, `excludedDisks`, `fallbackToCrashConsistent`, `skipPhysicalRdmDisks`, `fullProtectionSlaTimeMins`, `incrementalProtectionSlaTimeMins`, `indexingPolicy`, `policyUid`, `policyAppliedTime`, `priority`, `qosType`, `startTime`, `timezone`, `cohesityTenantUid`, `companyId`, `locationId`, `vdcUuid`, `orgUuid`, `excludedSources`, `protectedSources`, `abortInBlackoutPeriod`, `continueOnQuiesceFailure`, `quiesce`.
`long`	`id()` The ID of the backup group.
`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).
`BackupGroupIndexingPolicy`	`indexingPolicy()` Specifies settings for indexing files found in an Object (such as a VM) so these files can be searched and recovered.
`LocationId`	`locationId()` The vCloud location ID (the hostname of the associated vCloud instance).
`Instant`	`modifiedTime()` Specifies the last time this backup group was updated.
`String`	`name()` Specifies the name of the backup group.
`OrgUuid`	`orgUuid()` The UUID of the associated vCloud org.
`boolean`	`paused()` Indicates if the backup group is paused, which means that no new backup group Runs are started but any existing backup group Runs continue to execute.
`Optional<Instant>`	`policyAppliedTime()` Specifies the time when the associated Policy was last applied to this backup group.
`PolicyUid`	`policyUid()` Specifies the universally unique id of the Protection Policy associated with the backup group.
`BackupGroupPriority`	`priority()` Specifies the priority of execution for a backup group.
`com.google.common.collect.ImmutableSet<VCloudProtectionSource>`	`protectedSources()` Array of globally identifiable Protected Source Objects, including references to associated vCloud entities.
`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 `BackupGroup` with attribute values.
`BackupGroupUid`	`uid()` Specifies a UID for the backup group.
`VdcUuid`	`vdcUuid()` The UUID of the associated vCloud virtual datacenter.
`ImmutableBackupGroup`	`withAbortInBlackoutPeriod(boolean value)` Copy the current immutable object by setting a value for the `abortInBlackoutPeriod` attribute.
`ImmutableBackupGroup`	`withActive(boolean value)` Copy the current immutable object by setting a value for the `active` attribute.
`ImmutableBackupGroup`	`withCohesityTenantUid(TenantUid value)` Copy the current immutable object by setting a value for the `cohesityTenantUid` attribute.
`ImmutableBackupGroup`	`withCompanyId(CompanyId value)` Copy the current immutable object by setting a value for the `companyId` attribute.
`ImmutableBackupGroup`	`withContinueOnQuiesceFailure(boolean value)` Copy the current immutable object by setting a value for the `continueOnQuiesceFailure` attribute.
`ImmutableBackupGroup`	`withCreationTime(Instant value)` Copy the current immutable object by setting a value for the `creationTime` attribute.
`ImmutableBackupGroup`	`withDeleted(boolean value)` Copy the current immutable object by setting a value for the `deleted` attribute.
`ImmutableBackupGroup`	`withDescription(Optional<String> optional)` Copy the current immutable object by setting an optional value for the `description` attribute.
`ImmutableBackupGroup`	`withDescription(String value)` Copy the current immutable object by setting a present value for the optional `description` attribute.
`ImmutableBackupGroup`	`withEndTime(Instant value)` Copy the current immutable object by setting a present value for the optional `endTime` attribute.
`ImmutableBackupGroup`	`withEndTime(Optional<? extends Instant> optional)` Copy the current immutable object by setting an optional value for the `endTime` attribute.
`ImmutableBackupGroup`	`withExcludedDisks(BackupGroupDiskUnit... elements)` Copy the current immutable object with elements that replace the content of `excludedDisks`.
`ImmutableBackupGroup`	`withExcludedDisks(Iterable<? extends BackupGroupDiskUnit> elements)` Copy the current immutable object with elements that replace the content of `excludedDisks`.
`ImmutableBackupGroup`	`withExcludedSources(Iterable<? extends VCloudProtectionSource> elements)` Copy the current immutable object with elements that replace the content of `excludedSources`.
`ImmutableBackupGroup`	`withExcludedSources(VCloudProtectionSource... elements)` Copy the current immutable object with elements that replace the content of `excludedSources`.
`ImmutableBackupGroup`	`withFallbackToCrashConsistent(boolean value)` Copy the current immutable object by setting a value for the `fallbackToCrashConsistent` attribute.
`ImmutableBackupGroup`	`withFullProtectionSlaTimeMins(long value)` Copy the current immutable object by setting a value for the `fullProtectionSlaTimeMins` attribute.
`ImmutableBackupGroup`	`withId(long value)` Copy the current immutable object by setting a value for the `id` attribute.
`ImmutableBackupGroup`	`withIncrementalProtectionSlaTimeMins(long value)` Copy the current immutable object by setting a value for the `incrementalProtectionSlaTimeMins` attribute.
`ImmutableBackupGroup`	`withIndexingPolicy(BackupGroupIndexingPolicy value)` Copy the current immutable object by setting a value for the `indexingPolicy` attribute.
`ImmutableBackupGroup`	`withLocationId(LocationId value)` Copy the current immutable object by setting a value for the `locationId` attribute.
`ImmutableBackupGroup`	`withModifiedTime(Instant value)` Copy the current immutable object by setting a value for the `modifiedTime` attribute.
`ImmutableBackupGroup`	`withName(String value)` Copy the current immutable object by setting a value for the `name` attribute.
`ImmutableBackupGroup`	`withOrgUuid(OrgUuid value)` Copy the current immutable object by setting a value for the `orgUuid` attribute.
`ImmutableBackupGroup`	`withPaused(boolean value)` Copy the current immutable object by setting a value for the `paused` attribute.
`ImmutableBackupGroup`	`withPolicyAppliedTime(Instant value)` Copy the current immutable object by setting a present value for the optional `policyAppliedTime` attribute.
`ImmutableBackupGroup`	`withPolicyAppliedTime(Optional<? extends Instant> optional)` Copy the current immutable object by setting an optional value for the `policyAppliedTime` attribute.
`ImmutableBackupGroup`	`withPolicyUid(PolicyUid value)` Copy the current immutable object by setting a value for the `policyUid` attribute.
`ImmutableBackupGroup`	`withPriority(BackupGroupPriority value)` Copy the current immutable object by setting a value for the `priority` attribute.
`ImmutableBackupGroup`	`withProtectedSources(Iterable<? extends VCloudProtectionSource> elements)` Copy the current immutable object with elements that replace the content of `protectedSources`.
`ImmutableBackupGroup`	`withProtectedSources(VCloudProtectionSource... elements)` Copy the current immutable object with elements that replace the content of `protectedSources`.
`ImmutableBackupGroup`	`withQosType(BackupGroupQosType value)` Copy the current immutable object by setting a value for the `qosType` attribute.
`ImmutableBackupGroup`	`withQuiesce(boolean value)` Copy the current immutable object by setting a value for the `quiesce` attribute.
`ImmutableBackupGroup`	`withSkipPhysicalRdmDisks(boolean value)` Copy the current immutable object by setting a value for the `skipPhysicalRdmDisks` attribute.
`ImmutableBackupGroup`	`withStartTime(TimeOfDay value)` Copy the current immutable object by setting a value for the `startTime` attribute.
`ImmutableBackupGroup`	`withTimezone(String value)` Copy the current immutable object by setting a value for the `timezone` attribute.
`ImmutableBackupGroup`	`withUid(BackupGroupUid value)` Copy the current immutable object by setting a value for the `uid` attribute.
`ImmutableBackupGroup`	`withVdcUuid(VdcUuid value)` Copy the current immutable object by setting a value for the `vdcUuid` attribute.

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

- Method Detail
  - id
```
public long id()
```
    The ID of the backup group.
    
    Specified by:
    
    id in interface BackupGroup
  - uid
```
public BackupGroupUid uid()
```
    Specifies a UID for the backup group.
    
    Specified by:
    
    uid in interface BackupGroup
  - name
```
public String name()
```
    Specifies the name of the backup group.
    
    Specified by:
    
    name in interface BackupGroup
  - creationTime
```
public Instant creationTime()
```
    Specifies the time when the backup group was created.
    
    Specified by:
    
    creationTime in interface BackupGroup
  - modifiedTime
```
public Instant modifiedTime()
```
    Specifies the last time this backup group was updated.
    
    Specified by:
    
    modifiedTime in interface BackupGroup
  - description
```
public Optional<String> description()
```
    Specifies a text description about the backup group.
    
    Specified by:
    
    description in interface BackupGroup
  - endTime
```
public Optional<Instant> endTime()
```
    Specifies the time after which the backup group becomes dormant.
    
    Specified by:
    
    endTime in interface BackupGroup
  - active
```
public boolean active()
```
    Indicates if the current state of the backup group is Active or Inactive. When you create a backup group on a Primary Cluster with a replication schedule, the Cluster creates an Inactive copy of the backup group on the Remote Cluster. In addition, when an Active and running backup group is deactivated, the backup group becomes Inactive.
    
    Specified by:
    
    active in interface BackupGroup
  - deleted
```
public boolean deleted()
```
    Equals 'true' if the backup group was deleted but some Snapshots are still associated with this backup group. If 'true', no new backup group Runs are started by this Protection backup group.
    
    Specified by:
    
    deleted in interface BackupGroup
  - paused
```
public boolean paused()
```
    Indicates if the backup group is paused, which means that no new backup group Runs are started but any existing backup group Runs continue to execute.
    
    Specified by:
    
    paused in interface BackupGroup
  - 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 Protection backup group.
    
    Specified by:
    
    excludedDisks in interface BackupGroup
  - 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 BackupGroup
  - 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 BackupGroup
  - 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 BackupGroup
  - 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 BackupGroup
  - indexingPolicy
```
public 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 BackupGroup
  - policyUid
```
public PolicyUid policyUid()
```
    Specifies the universally 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:
    
    policyUid in interface BackupGroup
  - policyAppliedTime
```
public Optional<Instant> policyAppliedTime()
```
    Specifies the time when the associated Policy was last applied to this backup group. This is used to determine if the Policy has changed since it was last applied to this backup group.
    
    Specified by:
    
    policyAppliedTime in interface BackupGroup
  - priority
```
public BackupGroupPriority priority()
```
    Specifies the priority of execution for a backup group. iland Supports concurrent backups but if the number of backup groups exceeds the ability to process backup groups, the specified priority determines the execution backup group priority. This field also specifies the replication priority. 'LOW' indicates lowest execution priority for a Protection backup group. 'MEDIUM' indicates medium execution priority for a Protection backup group. 'HIGH' indicates highest execution priority for a Protection backup group.
    
    Specified by:
    
    priority in interface BackupGroup
  - 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 backup group. This is the recommended setting. 'SSD' indicates that data is written directly to the SSD tier for this backup group. Only specify this policy if you need fast ingest speed for a small number of Protection backup groups.
    
    Specified by:
    
    qosType in interface BackupGroup
  - 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. Default value is 02:00 AM.
    
    Specified by:
    
    startTime in interface BackupGroup
  - 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 BackupGroup
  - cohesityTenantUid
```
public TenantUid cohesityTenantUid()
```
    Specifies the UID of the parent Cohesity tenant/org.
    
    Specified by:
    
    cohesityTenantUid in interface BackupGroup
  - companyId
```
public CompanyId companyId()
```
    The ID of the iland company that is associated with the protection backup group.
    
    Specified by:
    
    companyId in interface BackupGroup
  - locationId
```
public LocationId locationId()
```
    The vCloud location ID (the hostname of the associated vCloud instance).
    
    Specified by:
    
    locationId in interface BackupGroup
  - vdcUuid
```
public VdcUuid vdcUuid()
```
    The UUID of the associated vCloud virtual datacenter.
    
    Specified by:
    
    vdcUuid in interface BackupGroup
  - orgUuid
```
public OrgUuid orgUuid()
```
    The UUID of the associated vCloud org.
    
    Specified by:
    
    orgUuid in interface BackupGroup
  - excludedSources
```
public com.google.common.collect.ImmutableSet<VCloudProtectionSource> excludedSources()
```
    Array of globally identifiable Excluded Source Objects, including references to associated vCloud entities.
    List of sources from a Protection Source that should not be protected and are excluded from being backed up by the backup group. Leaf and non-leaf Objects may be in this list and an Object in this list must have an ancestor in the BackupGroup.protectedSources() list.
    
    Specified by:
    
    excludedSources in interface BackupGroup
  - protectedSources
```
public com.google.common.collect.ImmutableSet<VCloudProtectionSource> protectedSources()
```
    Array of globally identifiable Protected Source Objects, including references to associated vCloud entities.
    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:
    
    protectedSources in interface BackupGroup
  - abortInBlackoutPeriod
```
public boolean abortInBlackoutPeriod()
```
    If true, aborts any currently executing backup group Runs of this backup group when a blackout period specified for this backup group starts, even if the backup group Run started before the blackout period began. If false, a backup group Run continues to execute, if the backup group Run started before the blackout period starts.
    
    Specified by:
    
    abortInBlackoutPeriod in interface BackupGroup
  - continueOnQuiesceFailure
```
public boolean continueOnQuiesceFailure()
```
    Whether to continue backing up on quiesce failure.
    
    Specified by:
    
    continueOnQuiesceFailure in interface BackupGroup
  - 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 BackupGroup
  - withId
```
public final ImmutableBackupGroup withId(long value)
```
    Copy the current immutable object by setting a value for the id attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for id
    
    Returns:
    
    A modified copy of the this object
  - withUid
```
public final ImmutableBackupGroup withUid(BackupGroupUid value)
```
    Copy the current immutable object by setting a value for the uid attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for uid
    
    Returns:
    
    A modified copy of the this object
  - withName
```
public final ImmutableBackupGroup 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
  - withCreationTime
```
public final ImmutableBackupGroup withCreationTime(Instant value)
```
    Copy the current immutable object by setting a value for the creationTime attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for creationTime
    
    Returns:
    
    A modified copy of the this object
  - withModifiedTime
```
public final ImmutableBackupGroup withModifiedTime(Instant value)
```
    Copy the current immutable object by setting a value for the modifiedTime attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for modifiedTime
    
    Returns:
    
    A modified copy of the this object
  - withDescription
```
public final ImmutableBackupGroup 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 ImmutableBackupGroup 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 ImmutableBackupGroup 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 ImmutableBackupGroup 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
  - withActive
```
public final ImmutableBackupGroup withActive(boolean value)
```
    Copy the current immutable object by setting a value for the active attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for active
    
    Returns:
    
    A modified copy of the this object
  - withDeleted
```
public final ImmutableBackupGroup withDeleted(boolean value)
```
    Copy the current immutable object by setting a value for the deleted attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for deleted
    
    Returns:
    
    A modified copy of the this object
  - withPaused
```
public final ImmutableBackupGroup withPaused(boolean value)
```
    Copy the current immutable object by setting a value for the paused attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for paused
    
    Returns:
    
    A modified copy of the this object
  - withExcludedDisks
```
public final ImmutableBackupGroup 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 ImmutableBackupGroup 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 ImmutableBackupGroup 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 ImmutableBackupGroup 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 ImmutableBackupGroup 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 ImmutableBackupGroup 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 ImmutableBackupGroup withIndexingPolicy(BackupGroupIndexingPolicy value)
```
    Copy the current immutable object by setting a value for the indexingPolicy attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for indexingPolicy
    
    Returns:
    
    A modified copy of the this object
  - withPolicyUid
```
public final ImmutableBackupGroup withPolicyUid(PolicyUid value)
```
    Copy the current immutable object by setting a value for the policyUid attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for policyUid
    
    Returns:
    
    A modified copy of the this object
  - withPolicyAppliedTime
```
public final ImmutableBackupGroup withPolicyAppliedTime(Instant value)
```
    Copy the current immutable object by setting a present value for the optional policyAppliedTime attribute.
    
    Parameters:
    
    value - The value for policyAppliedTime
    
    Returns:
    
    A modified copy of this object
  - withPolicyAppliedTime
```
public final ImmutableBackupGroup withPolicyAppliedTime(Optional<? extends Instant> optional)
```
    Copy the current immutable object by setting an optional value for the policyAppliedTime 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 policyAppliedTime
    
    Returns:
    
    A modified copy of this object
  - withPriority
```
public final ImmutableBackupGroup 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 ImmutableBackupGroup 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
  - withStartTime
```
public final ImmutableBackupGroup 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 ImmutableBackupGroup 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
  - withCohesityTenantUid
```
public final ImmutableBackupGroup withCohesityTenantUid(TenantUid value)
```
    Copy the current immutable object by setting a value for the cohesityTenantUid attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for cohesityTenantUid
    
    Returns:
    
    A modified copy of the this object
  - withCompanyId
```
public final ImmutableBackupGroup withCompanyId(CompanyId value)
```
    Copy the current immutable object by setting a value for the companyId attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for companyId
    
    Returns:
    
    A modified copy of the this object
  - withLocationId
```
public final ImmutableBackupGroup withLocationId(LocationId value)
```
    Copy the current immutable object by setting a value for the locationId attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for locationId
    
    Returns:
    
    A modified copy of the this object
  - withVdcUuid
```
public final ImmutableBackupGroup withVdcUuid(VdcUuid value)
```
    Copy the current immutable object by setting a value for the vdcUuid attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for vdcUuid
    
    Returns:
    
    A modified copy of the this object
  - withOrgUuid
```
public final ImmutableBackupGroup withOrgUuid(OrgUuid value)
```
    Copy the current immutable object by setting a value for the orgUuid attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for orgUuid
    
    Returns:
    
    A modified copy of the this object
  - withExcludedSources
```
public final ImmutableBackupGroup withExcludedSources(VCloudProtectionSource... elements)
```
    Copy the current immutable object with elements that replace the content of excludedSources.
    
    Parameters:
    
    elements - The elements to set
    
    Returns:
    
    A modified copy of this object
  - withExcludedSources
```
public final ImmutableBackupGroup withExcludedSources(Iterable<? extends VCloudProtectionSource> elements)
```
    Copy the current immutable object with elements that replace the content of excludedSources. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    elements - An iterable of excludedSources elements to set
    
    Returns:
    
    A modified copy of this object
  - withProtectedSources
```
public final ImmutableBackupGroup withProtectedSources(VCloudProtectionSource... elements)
```
    Copy the current immutable object with elements that replace the content of protectedSources.
    
    Parameters:
    
    elements - The elements to set
    
    Returns:
    
    A modified copy of this object
  - withProtectedSources
```
public final ImmutableBackupGroup withProtectedSources(Iterable<? extends VCloudProtectionSource> elements)
```
    Copy the current immutable object with elements that replace the content of protectedSources. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    elements - An iterable of protectedSources elements to set
    
    Returns:
    
    A modified copy of this object
  - withAbortInBlackoutPeriod
```
public final ImmutableBackupGroup 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 ImmutableBackupGroup 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 ImmutableBackupGroup 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 ImmutableBackupGroup 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: id, uid, name, creationTime, modifiedTime, description, endTime, active, deleted, paused, excludedDisks, fallbackToCrashConsistent, skipPhysicalRdmDisks, fullProtectionSlaTimeMins, incrementalProtectionSlaTimeMins, indexingPolicy, policyUid, policyAppliedTime, priority, qosType, startTime, timezone, cohesityTenantUid, companyId, locationId, vdcUuid, orgUuid, excludedSources, protectedSources, abortInBlackoutPeriod, continueOnQuiesceFailure, quiesce.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    hashCode value
  - toString
```
public String toString()
```
    Prints the immutable value BackupGroup with attribute values.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of the value
  - copyOf
```
public static ImmutableBackupGroup copyOf(BackupGroup instance)
```
    Creates an immutable copy of a BackupGroup 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 BackupGroup instance
  - builder
```
public static ImmutableBackupGroup.Builder builder()
```
    Creates a builder for ImmutableBackupGroup.
```
 ImmutableBackupGroup.builder()
    .id(long) // required id
    .uid(com.iland.cohesity.iaas.backups.common.model.BackupGroupUid) // required uid
    .name(String) // required name
    .creationTime(java.time.Instant) // required creationTime
    .modifiedTime(java.time.Instant) // required modifiedTime
    .description(String) // optional description
    .endTime(java.time.Instant) // optional endTime
    .active(boolean) // required active
    .deleted(boolean) // required deleted
    .paused(boolean) // required paused
    .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) // required indexingPolicy
    .policyUid(com.iland.cohesity.iaas.backups.common.model.PolicyUid) // required policyUid
    .policyAppliedTime(java.time.Instant) // optional policyAppliedTime
    .priority(com.iland.cohesity.iaas.backups.backupgroups.enums.BackupGroupPriority) // required priority
    .qosType(com.iland.cohesity.iaas.backups.backupgroups.enums.BackupGroupQosType) // required qosType
    .startTime(com.iland.cohesity.iaas.backups.common.model.TimeOfDay) // required startTime
    .timezone(String) // required timezone
    .cohesityTenantUid(com.iland.cohesity.iaas.backups.common.model.TenantUid) // required cohesityTenantUid
    .companyId(com.iland.cohesity.iaas.backups.common.model.CompanyId) // required companyId
    .locationId(com.iland.cohesity.iaas.backups.common.model.LocationId) // required locationId
    .vdcUuid(com.iland.cohesity.iaas.backups.common.model.VdcUuid) // required vdcUuid
    .orgUuid(com.iland.cohesity.iaas.backups.common.model.OrgUuid) // required orgUuid
    .addExcludedSources|addAllExcludedSources(com.iland.cohesity.iaas.backups.common.model.VCloudProtectionSource) // excludedSources elements
    .addProtectedSources|addAllProtectedSources(com.iland.cohesity.iaas.backups.common.model.VCloudProtectionSource) // protectedSources elements
    .abortInBlackoutPeriod(boolean) // required abortInBlackoutPeriod
    .continueOnQuiesceFailure(boolean) // required continueOnQuiesceFailure
    .quiesce(boolean) // required quiesce
    .build();
 
```
    Returns:
    
    A new ImmutableBackupGroup builder

Class ImmutableBackupGroup

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

id

uid

name

creationTime

modifiedTime

description

endTime

active

deleted

paused

excludedDisks

fallbackToCrashConsistent

skipPhysicalRdmDisks

fullProtectionSlaTimeMins

incrementalProtectionSlaTimeMins

indexingPolicy

policyUid

policyAppliedTime

priority

qosType

startTime

timezone

cohesityTenantUid

companyId

locationId

vdcUuid

orgUuid

excludedSources

protectedSources

abortInBlackoutPeriod

continueOnQuiesceFailure

quiesce

withId

withUid

withName

withCreationTime

withModifiedTime

withDescription

withDescription

withEndTime

withEndTime

withActive

withDeleted

withPaused

withExcludedDisks

withExcludedDisks

withFallbackToCrashConsistent

withSkipPhysicalRdmDisks

withFullProtectionSlaTimeMins

withIncrementalProtectionSlaTimeMins

withIndexingPolicy

withPolicyUid

withPolicyAppliedTime

withPolicyAppliedTime

withPriority

withQosType

withStartTime

withTimezone

withCohesityTenantUid

withCompanyId

withLocationId

withVdcUuid

withOrgUuid

withExcludedSources

withExcludedSources

withProtectedSources

withProtectedSources

withAbortInBlackoutPeriod

withContinueOnQuiesceFailure

withQuiesce

equals

hashCode

toString

copyOf

builder