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

Interface BackupGroupParams

All Known Implementing Classes:

ImmutableBackupGroupParams

public interface BackupGroupParams

Backup group parameter model.

Author:

Cory Snyder

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.
boolean	continueOnQuiesceFailure() Whether to continue backing up on quiesce failure.
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.
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	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.
Set<VCloudProtectionSourceRef>	vcloudExcludedSources() Array of Excluded vCloud Source Objects.
Set<VCloudProtectionSourceRef>	vcloudProtectedSources() Array of Protected vCloud Source Objects.

Method Detail

name

String name()

Specifies the name of the backup group.

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.

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 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

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.

policyId

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.

priority

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.

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 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.

vcloudExcludedSources

Set<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 vcloudProtectedSources() list.

vcloudProtectedSources

Set<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.

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.

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".

abortInBlackoutPeriod

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.

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.