VolumeBackupSchedule¶

class oci.core.models.VolumeBackupSchedule(**kwargs)¶

Bases: object

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

Attributes

`BACKUP_TYPE_FULL`	A constant which can be used with the backup_type property of a VolumeBackupSchedule.
`BACKUP_TYPE_INCREMENTAL`	A constant which can be used with the backup_type property of a VolumeBackupSchedule.
`DAY_OF_WEEK_FRIDAY`	A constant which can be used with the day_of_week property of a VolumeBackupSchedule.
`DAY_OF_WEEK_MONDAY`	A constant which can be used with the day_of_week property of a VolumeBackupSchedule.
`DAY_OF_WEEK_SATURDAY`	A constant which can be used with the day_of_week property of a VolumeBackupSchedule.
`DAY_OF_WEEK_SUNDAY`	A constant which can be used with the day_of_week property of a VolumeBackupSchedule.
`DAY_OF_WEEK_THURSDAY`	A constant which can be used with the day_of_week property of a VolumeBackupSchedule.
`DAY_OF_WEEK_TUESDAY`	A constant which can be used with the day_of_week property of a VolumeBackupSchedule.
`DAY_OF_WEEK_WEDNESDAY`	A constant which can be used with the day_of_week property of a VolumeBackupSchedule.
`MONTH_APRIL`	A constant which can be used with the month property of a VolumeBackupSchedule.
`MONTH_AUGUST`	A constant which can be used with the month property of a VolumeBackupSchedule.
`MONTH_DECEMBER`	A constant which can be used with the month property of a VolumeBackupSchedule.
`MONTH_FEBRUARY`	A constant which can be used with the month property of a VolumeBackupSchedule.
`MONTH_JANUARY`	A constant which can be used with the month property of a VolumeBackupSchedule.
`MONTH_JULY`	A constant which can be used with the month property of a VolumeBackupSchedule.
`MONTH_JUNE`	A constant which can be used with the month property of a VolumeBackupSchedule.
`MONTH_MARCH`	A constant which can be used with the month property of a VolumeBackupSchedule.
`MONTH_MAY`	A constant which can be used with the month property of a VolumeBackupSchedule.
`MONTH_NOVEMBER`	A constant which can be used with the month property of a VolumeBackupSchedule.
`MONTH_OCTOBER`	A constant which can be used with the month property of a VolumeBackupSchedule.
`MONTH_SEPTEMBER`	A constant which can be used with the month property of a VolumeBackupSchedule.
`OFFSET_TYPE_NUMERIC_SECONDS`	A constant which can be used with the offset_type property of a VolumeBackupSchedule.
`OFFSET_TYPE_STRUCTURED`	A constant which can be used with the offset_type property of a VolumeBackupSchedule.
`PERIOD_ONE_DAY`	A constant which can be used with the period property of a VolumeBackupSchedule.
`PERIOD_ONE_HOUR`	A constant which can be used with the period property of a VolumeBackupSchedule.
`PERIOD_ONE_MONTH`	A constant which can be used with the period property of a VolumeBackupSchedule.
`PERIOD_ONE_WEEK`	A constant which can be used with the period property of a VolumeBackupSchedule.
`PERIOD_ONE_YEAR`	A constant which can be used with the period property of a VolumeBackupSchedule.
`TIME_ZONE_REGIONAL_DATA_CENTER_TIME`	A constant which can be used with the time_zone property of a VolumeBackupSchedule.
`TIME_ZONE_UTC`	A constant which can be used with the time_zone property of a VolumeBackupSchedule.
`backup_type`	[Required] Gets the backup_type of this VolumeBackupSchedule.
`day_of_month`	Gets the day_of_month of this VolumeBackupSchedule.
`day_of_week`	Gets the day_of_week of this VolumeBackupSchedule.
`hour_of_day`	Gets the hour_of_day of this VolumeBackupSchedule.
`month`	Gets the month of this VolumeBackupSchedule.
`offset_seconds`	Gets the offset_seconds of this VolumeBackupSchedule.
`offset_type`	Gets the offset_type of this VolumeBackupSchedule.
`period`	[Required] Gets the period of this VolumeBackupSchedule.
`retention_seconds`	[Required] Gets the retention_seconds of this VolumeBackupSchedule.
`time_zone`	Gets the time_zone of this VolumeBackupSchedule.

Methods

__init__(**kwargs) Initializes a new VolumeBackupSchedule object with values from keyword arguments.

BACKUP_TYPE_FULL = 'FULL'¶: A constant which can be used with the backup_type property of a VolumeBackupSchedule. This constant has a value of “FULL”

BACKUP_TYPE_INCREMENTAL = 'INCREMENTAL'¶: A constant which can be used with the backup_type property of a VolumeBackupSchedule. This constant has a value of “INCREMENTAL”

DAY_OF_WEEK_FRIDAY = 'FRIDAY'¶: A constant which can be used with the day_of_week property of a VolumeBackupSchedule. This constant has a value of “FRIDAY”

DAY_OF_WEEK_MONDAY = 'MONDAY'¶: A constant which can be used with the day_of_week property of a VolumeBackupSchedule. This constant has a value of “MONDAY”

DAY_OF_WEEK_SATURDAY = 'SATURDAY'¶: A constant which can be used with the day_of_week property of a VolumeBackupSchedule. This constant has a value of “SATURDAY”

DAY_OF_WEEK_SUNDAY = 'SUNDAY'¶: A constant which can be used with the day_of_week property of a VolumeBackupSchedule. This constant has a value of “SUNDAY”

DAY_OF_WEEK_THURSDAY = 'THURSDAY'¶: A constant which can be used with the day_of_week property of a VolumeBackupSchedule. This constant has a value of “THURSDAY”

DAY_OF_WEEK_TUESDAY = 'TUESDAY'¶: A constant which can be used with the day_of_week property of a VolumeBackupSchedule. This constant has a value of “TUESDAY”

DAY_OF_WEEK_WEDNESDAY = 'WEDNESDAY'¶: A constant which can be used with the day_of_week property of a VolumeBackupSchedule. This constant has a value of “WEDNESDAY”

MONTH_APRIL = 'APRIL'¶: A constant which can be used with the month property of a VolumeBackupSchedule. This constant has a value of “APRIL”

MONTH_AUGUST = 'AUGUST'¶: A constant which can be used with the month property of a VolumeBackupSchedule. This constant has a value of “AUGUST”

MONTH_DECEMBER = 'DECEMBER'¶: A constant which can be used with the month property of a VolumeBackupSchedule. This constant has a value of “DECEMBER”

MONTH_FEBRUARY = 'FEBRUARY'¶: A constant which can be used with the month property of a VolumeBackupSchedule. This constant has a value of “FEBRUARY”

MONTH_JANUARY = 'JANUARY'¶: A constant which can be used with the month property of a VolumeBackupSchedule. This constant has a value of “JANUARY”

MONTH_JULY = 'JULY'¶: A constant which can be used with the month property of a VolumeBackupSchedule. This constant has a value of “JULY”

MONTH_JUNE = 'JUNE'¶: A constant which can be used with the month property of a VolumeBackupSchedule. This constant has a value of “JUNE”

MONTH_MARCH = 'MARCH'¶: A constant which can be used with the month property of a VolumeBackupSchedule. This constant has a value of “MARCH”

MONTH_MAY = 'MAY'¶: A constant which can be used with the month property of a VolumeBackupSchedule. This constant has a value of “MAY”

MONTH_NOVEMBER = 'NOVEMBER'¶: A constant which can be used with the month property of a VolumeBackupSchedule. This constant has a value of “NOVEMBER”

MONTH_OCTOBER = 'OCTOBER'¶: A constant which can be used with the month property of a VolumeBackupSchedule. This constant has a value of “OCTOBER”

MONTH_SEPTEMBER = 'SEPTEMBER'¶: A constant which can be used with the month property of a VolumeBackupSchedule. This constant has a value of “SEPTEMBER”

OFFSET_TYPE_NUMERIC_SECONDS = 'NUMERIC_SECONDS'¶: A constant which can be used with the offset_type property of a VolumeBackupSchedule. This constant has a value of “NUMERIC_SECONDS”

OFFSET_TYPE_STRUCTURED = 'STRUCTURED'¶: A constant which can be used with the offset_type property of a VolumeBackupSchedule. This constant has a value of “STRUCTURED”

PERIOD_ONE_DAY = 'ONE_DAY'¶: A constant which can be used with the period property of a VolumeBackupSchedule. This constant has a value of “ONE_DAY”

PERIOD_ONE_HOUR = 'ONE_HOUR'¶: A constant which can be used with the period property of a VolumeBackupSchedule. This constant has a value of “ONE_HOUR”

PERIOD_ONE_MONTH = 'ONE_MONTH'¶: A constant which can be used with the period property of a VolumeBackupSchedule. This constant has a value of “ONE_MONTH”

PERIOD_ONE_WEEK = 'ONE_WEEK'¶: A constant which can be used with the period property of a VolumeBackupSchedule. This constant has a value of “ONE_WEEK”

PERIOD_ONE_YEAR = 'ONE_YEAR'¶: A constant which can be used with the period property of a VolumeBackupSchedule. This constant has a value of “ONE_YEAR”

TIME_ZONE_REGIONAL_DATA_CENTER_TIME = 'REGIONAL_DATA_CENTER_TIME'¶: A constant which can be used with the time_zone property of a VolumeBackupSchedule. This constant has a value of “REGIONAL_DATA_CENTER_TIME”

TIME_ZONE_UTC = 'UTC'¶: A constant which can be used with the time_zone property of a VolumeBackupSchedule. This constant has a value of “UTC”

__init__(**kwargs)¶

Initializes a new VolumeBackupSchedule object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

backup_type (str) – The value to assign to the backup_type property of this VolumeBackupSchedule. Allowed values for this property are: “FULL”, “INCREMENTAL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
offset_seconds (int) – The value to assign to the offset_seconds property of this VolumeBackupSchedule.
period (str) – The value to assign to the period property of this VolumeBackupSchedule. Allowed values for this property are: “ONE_HOUR”, “ONE_DAY”, “ONE_WEEK”, “ONE_MONTH”, “ONE_YEAR”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
offset_type (str) – The value to assign to the offset_type property of this VolumeBackupSchedule. Allowed values for this property are: “STRUCTURED”, “NUMERIC_SECONDS”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
hour_of_day (int) – The value to assign to the hour_of_day property of this VolumeBackupSchedule.
day_of_week (str) – The value to assign to the day_of_week property of this VolumeBackupSchedule. Allowed values for this property are: “MONDAY”, “TUESDAY”, “WEDNESDAY”, “THURSDAY”, “FRIDAY”, “SATURDAY”, “SUNDAY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
day_of_month (int) – The value to assign to the day_of_month property of this VolumeBackupSchedule.
month (str) – The value to assign to the month property of this VolumeBackupSchedule. Allowed values for this property are: “JANUARY”, “FEBRUARY”, “MARCH”, “APRIL”, “MAY”, “JUNE”, “JULY”, “AUGUST”, “SEPTEMBER”, “OCTOBER”, “NOVEMBER”, “DECEMBER”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
retention_seconds (int) – The value to assign to the retention_seconds property of this VolumeBackupSchedule.
time_zone (str) – The value to assign to the time_zone property of this VolumeBackupSchedule. Allowed values for this property are: “UTC”, “REGIONAL_DATA_CENTER_TIME”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

backup_type¶

[Required] Gets the backup_type of this VolumeBackupSchedule. The type of volume backup to create.

Allowed values for this property are: “FULL”, “INCREMENTAL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The backup_type of this VolumeBackupSchedule.
Return type:	str

day_of_month¶

Gets the day_of_month of this VolumeBackupSchedule. The day of the month to schedule the volume backup.

Returns:	The day_of_month of this VolumeBackupSchedule.
Return type:	int

day_of_week¶

Gets the day_of_week of this VolumeBackupSchedule. The day of the week to schedule the volume backup.

Allowed values for this property are: “MONDAY”, “TUESDAY”, “WEDNESDAY”, “THURSDAY”, “FRIDAY”, “SATURDAY”, “SUNDAY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The day_of_week of this VolumeBackupSchedule.
Return type:	str

hour_of_day¶

Gets the hour_of_day of this VolumeBackupSchedule. The hour of the day to schedule the volume backup.

Returns:	The hour_of_day of this VolumeBackupSchedule.
Return type:	int

month¶

Gets the month of this VolumeBackupSchedule. The month of the year to schedule the volume backup.

Allowed values for this property are: “JANUARY”, “FEBRUARY”, “MARCH”, “APRIL”, “MAY”, “JUNE”, “JULY”, “AUGUST”, “SEPTEMBER”, “OCTOBER”, “NOVEMBER”, “DECEMBER”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The month of this VolumeBackupSchedule.
Return type:	str

offset_seconds¶

Gets the offset_seconds of this VolumeBackupSchedule. 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.

Returns:	The offset_seconds of this VolumeBackupSchedule.
Return type:	int

offset_type¶

Gets the offset_type of this VolumeBackupSchedule. 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.

Allowed values for this property are: “STRUCTURED”, “NUMERIC_SECONDS”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The offset_type of this VolumeBackupSchedule.
Return type:	str

period¶

[Required] Gets the period of this VolumeBackupSchedule. The volume backup frequency.

Allowed values for this property are: “ONE_HOUR”, “ONE_DAY”, “ONE_WEEK”, “ONE_MONTH”, “ONE_YEAR”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The period of this VolumeBackupSchedule.
Return type:	str

retention_seconds¶

[Required] Gets the retention_seconds of this VolumeBackupSchedule. How long, in seconds, to keep the volume backups created by this schedule.

Returns:	The retention_seconds of this VolumeBackupSchedule.
Return type:	int

time_zone¶

Gets the time_zone of this VolumeBackupSchedule. Specifies what time zone is the schedule in

Allowed values for this property are: “UTC”, “REGIONAL_DATA_CENTER_TIME”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The time_zone of this VolumeBackupSchedule.
Return type:	str