SnapshotSchedule¶

class oci.file_storage.models.SnapshotSchedule(**kwargs)¶

Bases: object

The snapshot schedule is a structure within a parent file system snapshot policy. It contains data about the frequency of snapshot creation and the retention time of the taken snapshots.

Attributes

`DAY_OF_WEEK_FRIDAY`	A constant which can be used with the day_of_week property of a SnapshotSchedule.
`DAY_OF_WEEK_MONDAY`	A constant which can be used with the day_of_week property of a SnapshotSchedule.
`DAY_OF_WEEK_SATURDAY`	A constant which can be used with the day_of_week property of a SnapshotSchedule.
`DAY_OF_WEEK_SUNDAY`	A constant which can be used with the day_of_week property of a SnapshotSchedule.
`DAY_OF_WEEK_THURSDAY`	A constant which can be used with the day_of_week property of a SnapshotSchedule.
`DAY_OF_WEEK_TUESDAY`	A constant which can be used with the day_of_week property of a SnapshotSchedule.
`DAY_OF_WEEK_WEDNESDAY`	A constant which can be used with the day_of_week property of a SnapshotSchedule.
`MONTH_APRIL`	A constant which can be used with the month property of a SnapshotSchedule.
`MONTH_AUGUST`	A constant which can be used with the month property of a SnapshotSchedule.
`MONTH_DECEMBER`	A constant which can be used with the month property of a SnapshotSchedule.
`MONTH_FEBRUARY`	A constant which can be used with the month property of a SnapshotSchedule.
`MONTH_JANUARY`	A constant which can be used with the month property of a SnapshotSchedule.
`MONTH_JULY`	A constant which can be used with the month property of a SnapshotSchedule.
`MONTH_JUNE`	A constant which can be used with the month property of a SnapshotSchedule.
`MONTH_MARCH`	A constant which can be used with the month property of a SnapshotSchedule.
`MONTH_MAY`	A constant which can be used with the month property of a SnapshotSchedule.
`MONTH_NOVEMBER`	A constant which can be used with the month property of a SnapshotSchedule.
`MONTH_OCTOBER`	A constant which can be used with the month property of a SnapshotSchedule.
`MONTH_SEPTEMBER`	A constant which can be used with the month property of a SnapshotSchedule.
`PERIOD_DAILY`	A constant which can be used with the period property of a SnapshotSchedule.
`PERIOD_HOURLY`	A constant which can be used with the period property of a SnapshotSchedule.
`PERIOD_MONTHLY`	A constant which can be used with the period property of a SnapshotSchedule.
`PERIOD_WEEKLY`	A constant which can be used with the period property of a SnapshotSchedule.
`PERIOD_YEARLY`	A constant which can be used with the period property of a SnapshotSchedule.
`TIME_ZONE_REGIONAL_DATA_CENTER_TIME`	A constant which can be used with the time_zone property of a SnapshotSchedule.
`TIME_ZONE_UTC`	A constant which can be used with the time_zone property of a SnapshotSchedule.
`day_of_month`	Gets the day_of_month of this SnapshotSchedule.
`day_of_week`	Gets the day_of_week of this SnapshotSchedule.
`hour_of_day`	Gets the hour_of_day of this SnapshotSchedule.
`month`	Gets the month of this SnapshotSchedule.
`period`	[Required] Gets the period of this SnapshotSchedule.
`retention_duration_in_seconds`	Gets the retention_duration_in_seconds of this SnapshotSchedule.
`schedule_prefix`	Gets the schedule_prefix of this SnapshotSchedule.
`time_schedule_start`	Gets the time_schedule_start of this SnapshotSchedule.
`time_zone`	[Required] Gets the time_zone of this SnapshotSchedule.

Methods

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

DAY_OF_WEEK_FRIDAY = 'FRIDAY'¶: A constant which can be used with the day_of_week property of a SnapshotSchedule. 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 SnapshotSchedule. 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 SnapshotSchedule. 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 SnapshotSchedule. 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 SnapshotSchedule. 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 SnapshotSchedule. 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 SnapshotSchedule. This constant has a value of “WEDNESDAY”

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

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

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

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

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

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

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

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

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

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

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

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

PERIOD_DAILY = 'DAILY'¶: A constant which can be used with the period property of a SnapshotSchedule. This constant has a value of “DAILY”

PERIOD_HOURLY = 'HOURLY'¶: A constant which can be used with the period property of a SnapshotSchedule. This constant has a value of “HOURLY”

PERIOD_MONTHLY = 'MONTHLY'¶: A constant which can be used with the period property of a SnapshotSchedule. This constant has a value of “MONTHLY”

PERIOD_WEEKLY = 'WEEKLY'¶: A constant which can be used with the period property of a SnapshotSchedule. This constant has a value of “WEEKLY”

PERIOD_YEARLY = 'YEARLY'¶: A constant which can be used with the period property of a SnapshotSchedule. This constant has a value of “YEARLY”

TIME_ZONE_REGIONAL_DATA_CENTER_TIME = 'REGIONAL_DATA_CENTER_TIME'¶: A constant which can be used with the time_zone property of a SnapshotSchedule. 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 SnapshotSchedule. This constant has a value of “UTC”

__init__(**kwargs)¶

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

Parameters:

schedule_prefix (str) – The value to assign to the schedule_prefix property of this SnapshotSchedule.
time_schedule_start (datetime) – The value to assign to the time_schedule_start property of this SnapshotSchedule.
period (str) – The value to assign to the period property of this SnapshotSchedule. Allowed values for this property are: “HOURLY”, “DAILY”, “WEEKLY”, “MONTHLY”, “YEARLY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
retention_duration_in_seconds (int) – The value to assign to the retention_duration_in_seconds property of this SnapshotSchedule.
time_zone (str) – The value to assign to the time_zone property of this SnapshotSchedule. 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’.
hour_of_day (int) – The value to assign to the hour_of_day property of this SnapshotSchedule.
day_of_week (str) – The value to assign to the day_of_week property of this SnapshotSchedule. 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 SnapshotSchedule.
month (str) – The value to assign to the month property of this SnapshotSchedule. 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’.

day_of_month¶

Gets the day_of_month of this SnapshotSchedule. The day of the month to create a scheduled snapshot. If the day does not exist for the month, snapshot creation will be skipped. Used for MONTHLY and YEARLY snapshot schedules.

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

day_of_week¶

Gets the day_of_week of this SnapshotSchedule. The day of the week to create a scheduled snapshot. Used for WEEKLY snapshot schedules.

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 SnapshotSchedule.
Return type:	str

hour_of_day¶

Gets the hour_of_day of this SnapshotSchedule. The hour of the day to create a DAILY, WEEKLY, MONTHLY, or YEARLY snapshot. If not set, a value will be chosen at creation time.

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

month¶

Gets the month of this SnapshotSchedule. The month to create a scheduled snapshot. Used only for YEARLY snapshot schedules.

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 SnapshotSchedule.
Return type:	str

period¶

[Required] Gets the period of this SnapshotSchedule. The frequency of scheduled snapshots.

Allowed values for this property are: “HOURLY”, “DAILY”, “WEEKLY”, “MONTHLY”, “YEARLY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

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

retention_duration_in_seconds¶

Gets the retention_duration_in_seconds of this SnapshotSchedule. The number of seconds to retain snapshots created with this schedule. Snapshot expiration time will not be set if this value is empty.

Returns:	The retention_duration_in_seconds of this SnapshotSchedule.
Return type:	int

schedule_prefix¶

Gets the schedule_prefix of this SnapshotSchedule. A name prefix to be applied to snapshots created by this schedule.

Example: compliance1

Returns:	The schedule_prefix of this SnapshotSchedule.
Return type:	str

time_schedule_start¶

Gets the time_schedule_start of this SnapshotSchedule. The starting point used to begin the scheduling of the snapshots based upon recurrence string in RFC 3339 timestamp format. If no timeScheduleStart is provided, the value will be set to the time when the schedule was created.

Returns:	The time_schedule_start of this SnapshotSchedule.
Return type:	datetime

time_zone¶

[Required] Gets the time_zone of this SnapshotSchedule. Time zone used for scheduling the snapshot.

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 SnapshotSchedule.
Return type:	str