Class Schedule

The schedule.

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.UsageapiService.Models

Assembly: OCI.DotNetSDK.Usageapi.dll

Syntax

public class Schedule

Properties

CompartmentId

Declaration

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

Property Value

Type	Description
string	The customer tenancy.

Remarks

Required

DefinedTags

Declaration

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

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"foo-namespace": {"bar-key": "value"}}

Description

Declaration

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

Property Value

Type	Description
string	The description of the schedule.

FreeformTags

Declaration

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

Property Value

Type	Description
Dictionary<string, string>	Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See Resource Tags. Example: {"bar-key": "value"}

Id

Declaration

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

Property Value

Type	Description
string	The OCID representing a unique shedule.

Remarks

Required

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?	The schedule lifecycle state.

Remarks

Required

Name

Declaration

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

Property Value

Type	Description
string	The unique name of the schedule created by the user.

Remarks

Required

OutputFileFormat

Declaration

[JsonProperty(PropertyName = "outputFileFormat")]
[JsonConverter(typeof(ResponseEnumConverter))]
public Schedule.OutputFileFormatEnum? OutputFileFormat { get; set; }

Property Value

Type	Description
Schedule.OutputFileFormatEnum?	Specifies the supported output file format.

QueryProperties

Declaration

[JsonProperty(PropertyName = "queryProperties")]
public QueryProperties QueryProperties { get; set; }

Property Value

Type	Description
QueryProperties

ResultLocation

Declaration

[Required(ErrorMessage = "ResultLocation is required.")]
[JsonProperty(PropertyName = "resultLocation")]
public ResultLocation ResultLocation { get; set; }

Property Value

Type	Description
ResultLocation

Remarks

Required

SavedReportId

Declaration

[JsonProperty(PropertyName = "savedReportId")]
public string SavedReportId { get; set; }

Property Value

Type	Description
string	The saved report ID which can also be used to generate a query.

ScheduleRecurrences

Declaration

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

Property Value

Type	Description
string	Specifies the frequency according to when the schedule will be run, in the x-obmcs-recurring-time format described in RFC 5545 section 3.3.10. Supported values are : ONE_TIME, DAILY, WEEKLY and MONTHLY.

Remarks

Required

SystemTags

Declaration

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

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags. 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?	The date and time the schedule was created.

Remarks

Required

TimeNextRun

Declaration

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

Property Value

Type	Description
DateTime?	The date and time of the next job execution.

TimeScheduled

Declaration

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

Property Value

Type	Description
DateTime?	The date and time of the first time job execution.

Remarks

Required