Class SnapshotSchedule

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.

Inheritance

object

SnapshotSchedule

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.FilestorageService.Models

Assembly: OCI.DotNetSDK.Filestorage.dll

Syntax

public class SnapshotSchedule

Properties

DayOfMonth

Declaration

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

Property Value

Type	Description
int?	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. If not set, the system chooses a value at creation time.

DayOfWeek

Declaration

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

Property Value

Type	Description
SnapshotSchedule.DayOfWeekEnum?	The day of the week to create a scheduled snapshot. Used for WEEKLY snapshot schedules. If not set, the system chooses a value at creation time.

HourOfDay

Declaration

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

Property Value

Type	Description
int?	The hour of the day to create a DAILY, WEEKLY, MONTHLY, or YEARLY snapshot. If not set, the system chooses a value at creation time.

Month

Declaration

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

Property Value

Type	Description
SnapshotSchedule.MonthEnum?	The month to create a scheduled snapshot. Used only for YEARLY snapshot schedules. If not set, the system chooses a value at creation time.

Period

Declaration

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

Property Value

Type	Description
SnapshotSchedule.PeriodEnum?	The frequency of scheduled snapshots.

Remarks

Required

RetentionDurationInSeconds

Declaration

[JsonProperty(PropertyName = "retentionDurationInSeconds")]
public long? RetentionDurationInSeconds { get; set; }

Property Value

Type	Description
long?	The number of seconds to retain snapshots created with this schedule. Snapshot expiration time will not be set if this value is empty.

SchedulePrefix

Declaration

[JsonProperty(PropertyName = "schedulePrefix")]
public string SchedulePrefix { get; set; }

Property Value

Type	Description
string	A name prefix to be applied to snapshots created by this schedule. Example: compliance1

TimeScheduleStart

Declaration

[JsonProperty(PropertyName = "timeScheduleStart")]
public DateTime? TimeScheduleStart { get; set; }

Property Value

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

TimeZone

Declaration

[Required(ErrorMessage = "TimeZone is required.")]
[JsonProperty(PropertyName = "timeZone")]
[JsonConverter(typeof(ResponseEnumConverter))]
public SnapshotSchedule.TimeZoneEnum? TimeZone { get; set; }

Property Value

Type	Description
SnapshotSchedule.TimeZoneEnum?	Time zone used for scheduling the snapshot.

Remarks

Required