Class Schedule

A Schedule describes the date and time when an operation will be or has been applied to a set of resources. You must specify either the resources directly or provide a set of resource filters to select the resources.
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, contact your administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

Inheritance

object

Schedule

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.ResourceschedulerService.Models

Assembly: OCI.DotNetSDK.Resourcescheduler.dll

Syntax

public class Schedule

Properties

Action

Declaration

[Required(ErrorMessage = "Action is required.")]
[JsonProperty(PropertyName = "action")]
[JsonConverter(typeof(ResponseEnumConverter))]
public Schedule.ActionEnum? Action { get; set; }

Property Value

Type	Description
Schedule.ActionEnum?	This is the action that will be executed by the schedule.

Remarks

Required

CompartmentId

Declaration

[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }

Property Value

Type	Description
string	The OCID of the compartment in which the schedule is created

Remarks

Required

DefinedTags

Declaration

[Required(ErrorMessage = "DefinedTags is required.")]
[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	These are defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations": {"CostCenter": "42"}}

Remarks

Required

Description

Declaration

[JsonProperty(PropertyName = "description")]
public string Description { get; set; }

Property Value

Type	Description
string	This is the description of the schedule.

DisplayName

Declaration

[Required(ErrorMessage = "DisplayName is required.")]
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }

Property Value

Type	Description
string	This is a user-friendly name for the schedule. It does not have to be unique, and it's changeable.

Remarks

Required

FreeformTags

Declaration

[Required(ErrorMessage = "FreeformTags is required.")]
[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }

Property Value

Type	Description
Dictionary<string, string>	These are free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

Remarks

Required

Id

Declaration

[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }

Property Value

Type	Description
string	The OCID of the schedule

Remarks

Required

LastRunStatus

Declaration

[JsonProperty(PropertyName = "lastRunStatus")]
[JsonConverter(typeof(ResponseEnumConverter))]
public OperationStatus? LastRunStatus { get; set; }

Property Value

Type	Description
OperationStatus?	This is the status of the last work request.

LifecycleState

Declaration

[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public Schedule.LifecycleStateEnum? LifecycleState { get; set; }

Property Value

Type	Description
Schedule.LifecycleStateEnum?	This is the current state of a schedule.

Remarks

Required

RecurrenceDetails

Declaration

[Required(ErrorMessage = "RecurrenceDetails is required.")]
[JsonProperty(PropertyName = "recurrenceDetails")]
public string RecurrenceDetails { get; set; }

Property Value

Type	Description
string	This is the frequency of recurrence of a schedule. The frequency field can either conform to RFC-5545 formatting or UNIX cron formatting for recurrences, based on the value specified by the recurrenceType field.

Remarks

Required

RecurrenceType

Declaration

[Required(ErrorMessage = "RecurrenceType is required.")]
[JsonProperty(PropertyName = "recurrenceType")]
[JsonConverter(typeof(ResponseEnumConverter))]
public Schedule.RecurrenceTypeEnum? RecurrenceType { get; set; }

Property Value

Type	Description
Schedule.RecurrenceTypeEnum?	Type of recurrence of a schedule

Remarks

Required

ResourceFilters

Declaration

[JsonProperty(PropertyName = "resourceFilters")]
public List<ResourceFilter> ResourceFilters { get; set; }

Property Value

Type	Description
List<ResourceFilter>	This is a list of resources filters. The schedule will be applied to resources matching all of them.

Resources

Declaration

[JsonProperty(PropertyName = "resources")]
public List<Resource> Resources { get; set; }

Property Value

Type	Description
List<Resource>	This is the list of resources to which the scheduled operation is applied.

SystemTags

Declaration

[JsonProperty(PropertyName = "systemTags")]
public Dictionary<string, Dictionary<string, object>> SystemTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	These are system tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud": {"free-tier-retained": "true"}}

TimeCreated

Declaration

[Required(ErrorMessage = "TimeCreated is required.")]
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }

Property Value

Type	Description
DateTime?	This is the date and time the schedule was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z

Remarks

Required

TimeEnds

Declaration

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

Property Value

Type	Description
DateTime?	This is the date and time the schedule ends, in the format defined by RFC 3339 Example: 2016-08-25T21:10:29.600Z

TimeLastRun

Declaration

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

Property Value

Type	Description
DateTime?	This is the date and time the schedule runs last time, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z

TimeNextRun

Declaration

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

Property Value

Type	Description
DateTime?	This is the date and time the schedule run the next time, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z

TimeStarts

Declaration

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

Property Value

Type	Description
DateTime?	This is the date and time the schedule starts, in the format defined by RFC 3339 Example: 2016-08-25T21:10:29.600Z

TimeUpdated

Declaration

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

Property Value

Type	Description
DateTime?	This is the date and time the schedule was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z