Class VolumeBackupSchedule

[Required(ErrorMessage = "BackupType is required.")]
[JsonProperty(PropertyName = "backupType")]
[JsonConverter(typeof(ResponseEnumConverter))]
public VolumeBackupSchedule.BackupTypeEnum? BackupType { get; set; }

Property Value

Type	Description
VolumeBackupSchedule.BackupTypeEnum?	The type of volume backup to create.

Remarks

Required

DayOfMonth

Declaration

[JsonProperty(PropertyName = "dayOfMonth")]
public int? DayOfMonth { get; set; }

Property Value

Type	Description
int?	The day of the month to schedule the volume backup.

DayOfWeek

Declaration

[JsonProperty(PropertyName = "dayOfWeek")]
[JsonConverter(typeof(ResponseEnumConverter))]
public VolumeBackupSchedule.DayOfWeekEnum? DayOfWeek { get; set; }

Property Value

Type	Description
VolumeBackupSchedule.DayOfWeekEnum?	The day of the week to schedule the volume backup.

HourOfDay

Declaration

[JsonProperty(PropertyName = "hourOfDay")]
public int? HourOfDay { get; set; }

Property Value

Type	Description
int?	The hour of the day to schedule the volume backup.

IsPreventDeletionEnabled

Declaration

[JsonProperty(PropertyName = "isPreventDeletionEnabled")]
public bool? IsPreventDeletionEnabled { get; set; }

Property Value

Type	Description
bool?	Prevent backups from being deleted during the configured retention period. This is an optional field. If it is not specified, it is set to null, prevent deletion will not be applied to the backups.

IsRetentionLockEnabled

Declaration

[JsonProperty(PropertyName = "isRetentionLockEnabled")]
public bool? IsRetentionLockEnabled { get; set; }

Property Value

Type	Description
bool?	feature that prevents deletion or alteration of backup data for a specified period to ensure data protection and regulatory compliance. This is an optional field. If it is not specified, it is set to null, no retention lock will be applied to the backups. This feature should be used in conjunction with the retention-period field.

Month

Declaration

[JsonProperty(PropertyName = "month")]
[JsonConverter(typeof(ResponseEnumConverter))]
public VolumeBackupSchedule.MonthEnum? Month { get; set; }

Property Value

Type	Description
VolumeBackupSchedule.MonthEnum?	The month of the year to schedule the volume backup.

OffsetSeconds

Declaration

[JsonProperty(PropertyName = "offsetSeconds")]
public int? OffsetSeconds { get; set; }

Property Value

Type	Description
int?	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.

OffsetType

Declaration

[JsonProperty(PropertyName = "offsetType")]
[JsonConverter(typeof(ResponseEnumConverter))]
public VolumeBackupSchedule.OffsetTypeEnum? OffsetType { get; set; }

Property Value

Type Description

Type	Description
VolumeBackupSchedule.OffsetTypeEnum?	Indicates how the offset is defined. If value is `STRUCTURED`, then `hourOfDay`, `dayOfWeek`, `dayOfMonth`, and `month` fields are used and `offsetSeconds` will be ignored in requests and users should ignore its value from the responses. `hourOfDay` is applicable for periods `ONE_DAY`, `ONE_WEEK`, `ONE_MONTH` and `ONE_YEAR`. `dayOfWeek` is applicable for period `ONE_WEEK`. `dayOfMonth` is applicable for periods `ONE_MONTH` and `ONE_YEAR`. 'month' is applicable for period 'ONE_YEAR'. They will be ignored in the requests for inapplicable periods. If value is `NUMERIC_SECONDS`, then `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 `offsetType` in their requests, the behaviour is just like `NUMERIC_SECONDS`.

VolumeBackupSchedule.OffsetTypeEnum?

Indicates how the offset is defined. If value is STRUCTURED, then hourOfDay, dayOfWeek, dayOfMonth, and month fields are used and offsetSeconds will be ignored in requests and users should ignore its value from the responses.
hourOfDay is applicable for periods ONE_DAY, ONE_WEEK, ONE_MONTH and ONE_YEAR.
dayOfWeek is applicable for period ONE_WEEK.
dayOfMonth is applicable for periods ONE_MONTH and ONE_YEAR.
'month' is applicable for period 'ONE_YEAR'.
They will be ignored in the requests for inapplicable periods.
If value is NUMERIC_SECONDS, then 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 offsetType in their requests, the behaviour is just like NUMERIC_SECONDS.

Period

Declaration

[Required(ErrorMessage = "Period is required.")]
[JsonProperty(PropertyName = "period")]
[JsonConverter(typeof(ResponseEnumConverter))]
public VolumeBackupSchedule.PeriodEnum? Period { get; set; }

Property Value

Type	Description
VolumeBackupSchedule.PeriodEnum?	The volume backup frequency.

Remarks

Required

RetentionPeriod

Declaration

[JsonProperty(PropertyName = "retentionPeriod")]
public RetentionDuration RetentionPeriod { get; set; }

Property Value

Type	Description
RetentionDuration

RetentionSeconds

Declaration

[Required(ErrorMessage = "RetentionSeconds is required.")]
[JsonProperty(PropertyName = "retentionSeconds")]
public int? RetentionSeconds { get; set; }

Property Value

Type	Description
int?	How long, in seconds, to keep the volume backups created by this schedule.

Remarks

Required

TimeZone

Declaration

[JsonProperty(PropertyName = "timeZone")]
[JsonConverter(typeof(ResponseEnumConverter))]
public VolumeBackupSchedule.TimeZoneEnum? TimeZone { get; set; }

Property Value

Type	Description
VolumeBackupSchedule.TimeZoneEnum?	Specifies what time zone is the schedule in