Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace VolumeBackupSchedule

Defines the backup frequency and retention period for a volume backup policy. For more information, see Policy-Based Backups.

Properties

backupType

backupType: BackupType

The type of volume backup to create.

Optional dayOfMonth

dayOfMonth: undefined | number

The day of the month to schedule the volume backup. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional dayOfWeek

dayOfWeek: DayOfWeek

The day of the week to schedule the volume backup.

Optional hourOfDay

hourOfDay: undefined | number

The hour of the day to schedule the volume backup. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional month

month: Month

The month of the year to schedule the volume backup.

Optional offsetSeconds

offsetSeconds: undefined | number

The number of seconds that the volume backup start time should be shifted from the default interval boundaries specified by the period. The volume backup start time is the frequency start time plus the offset. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional offsetType

offsetType: OffsetType

Indicates how the offset is defined. If value is {@code STRUCTURED}, then {@code hourOfDay}, {@code dayOfWeek}, {@code dayOfMonth}, and {@code month} fields are used and {@code offsetSeconds} will be ignored in requests and users should ignore its value from the responses.

{@code hourOfDay} is applicable for periods {@code ONE_DAY}, {@code ONE_WEEK}, {@code ONE_MONTH} and {@code ONE_YEAR}.

{@code dayOfWeek} is applicable for period {@code ONE_WEEK}.

{@code dayOfMonth} is applicable for periods {@code ONE_MONTH} and {@code ONE_YEAR}.

'month' is applicable for period 'ONE_YEAR'.

They will be ignored in the requests for inapplicable periods.

If value is {@code NUMERIC_SECONDS}, then {@code offsetSeconds} will be used for both requests and responses and the structured fields will be ignored in the requests and users should ignore their values from the responses.

For clients using older versions of Apis and not sending {@code offsetType} in their requests, the behaviour is just like {@code NUMERIC_SECONDS}.

period

period: Period

The volume backup frequency.

retentionSeconds

retentionSeconds: number

How long, in seconds, to keep the volume backups created by this schedule. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional timeZone

timeZone: TimeZone

Specifies what time zone is the schedule in

Functions

getDeserializedJsonObj

getJsonObj