BackupGroup (iland cloud Java SDK 1.0.45 API)

All Known Implementing Classes:

ImmutableBackupGroup
```
public interface BackupGroup
```
Backup Group.

Author:

Cory Snyder

Method Summary

All Methods Instance Methods Abstract 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.
`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.
`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.
`List<BackupGroupDiskUnit>`	`excludedDisks()` Specifies the list of Disks to be excluded from backing up.
`Set<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).
`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.
`Set<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.
`BackupGroupUid`	`uid()` Specifies a UID for the backup group.
`VdcUuid`	`vdcUuid()` The UUID of the associated vCloud virtual datacenter.

- Method Detail
  - id
```
long id()
```
    The ID of the backup group.
  - uid
```
BackupGroupUid uid()
```
    Specifies a UID for the backup group.
  - name
```
String name()
```
    Specifies the name of the backup group.
  - creationTime
```
Instant creationTime()
```
    Specifies the time when the backup group was created.
  - modifiedTime
```
Instant modifiedTime()
```
    Specifies the last time this backup group was updated.
  - description
```
Optional<String> description()
```
    Specifies a text description about the backup group.
  - endTime
```
Optional<Instant> endTime()
```
    Specifies the time after which the backup group becomes dormant.
  - active
```
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.
  - deleted
```
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.
  - paused
```
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.
  - excludedDisks
```
List<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.
  - fallbackToCrashConsistent
```
boolean fallbackToCrashConsistent()
```
    If true, takes a crash-consistent snapshot when app-consistent snapshot fails. Otherwise, the snapshot attempt is marked failed.
  - skipPhysicalRdmDisks
```
boolean skipPhysicalRdmDisks()
```
    If true, skip physical RDM disks when backing up VMs. Otherwise, backup of VMs having physical RDM will fail.
  - fullProtectionSlaTimeMins
```
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.
  - incrementalProtectionSlaTimeMins
```
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.
  - indexingPolicy
```
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.
  - policyUid
```
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.
  - policyAppliedTime
```
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.
  - priority
```
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.
  - qosType
```
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.
  - startTime
```
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.
  - timezone
```
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".
  - cohesityTenantUid
```
TenantUid cohesityTenantUid()
```
    Specifies the UID of the parent Cohesity tenant/org.
  - companyId
```
CompanyId companyId()
```
    The ID of the iland company that is associated with the protection backup group.
  - locationId
```
LocationId locationId()
```
    The vCloud location ID (the hostname of the associated vCloud instance).
  - vdcUuid
```
VdcUuid vdcUuid()
```
    The UUID of the associated vCloud virtual datacenter.
  - orgUuid
```
OrgUuid orgUuid()
```
    The UUID of the associated vCloud org.
  - excludedSources
```
Set<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 protectedSources() list.
  - protectedSources
```
Set<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.
  - abortInBlackoutPeriod
```
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.
  - continueOnQuiesceFailure
```
boolean continueOnQuiesceFailure()
```
    Whether to continue backing up on quiesce failure.
  - quiesce
```
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.

Interface BackupGroup

Method Summary

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