Show / Hide Table of Contents

Class Schedule

A repeating action. Examples:

  • Invoke a ML Pipeline Run once an hour.
  • Call ML Job Run every night at midnight.
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.DatascienceService.Models
Assembly: OCI.DotNetSDK.Datascience.dll
Syntax
public class Schedule

Properties

Action

Declaration
[Required(ErrorMessage = "Action is required.")]
[JsonProperty(PropertyName = "action")]
public ScheduleAction Action { get; set; }
Property Value
Type Description
ScheduleAction
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 where you want to create the schedule.

Remarks

Required

CreatedBy

Declaration
[Required(ErrorMessage = "CreatedBy is required.")]
[JsonProperty(PropertyName = "createdBy")]
public string CreatedBy { get; set; }
Property Value
Type Description
string

The OCID of the user who created the schedule.

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: {"Operations": {"CostCenter": "42"}}

Description

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

A short description of the schedule.

DisplayName

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

A user-friendly display name for the resource. Avoid entering confidential information.

Remarks

Required

FreeformTags

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

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See Resource Tags. Example: {"Department": "Finance"}

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

LastScheduleRunDetails

Declaration
[JsonProperty(PropertyName = "lastScheduleRunDetails")]
public string LastScheduleRunDetails { get; set; }
Property Value
Type Description
string

Details about the action performed by the last schedule execution. Example: Invoked ML Application trigger.

LifecycleDetails

Declaration
[JsonProperty(PropertyName = "lifecycleDetails")]
public string LifecycleDetails { get; set; }
Property Value
Type Description
string

A message describing the current state in more detail.

LifecycleState

Declaration
[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public ScheduleLifecycleState? LifecycleState { get; set; }
Property Value
Type Description
ScheduleLifecycleState?

The current state of the schedule.
Example: ACTIVE

Remarks

Required

LogDetails

Declaration
[JsonProperty(PropertyName = "logDetails")]
public ScheduleLogDetails LogDetails { get; set; }
Property Value
Type Description
ScheduleLogDetails

ProjectId

Declaration
[Required(ErrorMessage = "ProjectId is required.")]
[JsonProperty(PropertyName = "projectId")]
public string ProjectId { get; set; }
Property Value
Type Description
string

The OCID of the project associated with the schedule.

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. 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. Format is defined by RFC3339.
Example: 2022-08-05T01:02:29.600Z

Remarks

Required

TimeLastScheduleRun

Declaration
[JsonProperty(PropertyName = "timeLastScheduleRun")]
public DateTime? TimeLastScheduleRun { get; set; }
Property Value
Type Description
DateTime?

The last schedule execution time. Format is defined by RFC3339. Example: 2022-08-05T01:02:29.600Z

TimeNextScheduledRun

Declaration
[JsonProperty(PropertyName = "timeNextScheduledRun")]
public DateTime? TimeNextScheduledRun { get; set; }
Property Value
Type Description
DateTime?

The next scheduled execution time for the schedule. Format is defined by RFC3339. Example: 2022-08-05T01:02:29.600Z

TimeUpdated

Declaration
[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }
Property Value
Type Description
DateTime?

The date and time the schedule was updated. Format is defined by RFC3339.
Example: 2022-09-05T01:02:29.600Z

Trigger

Declaration
[Required(ErrorMessage = "Trigger is required.")]
[JsonProperty(PropertyName = "trigger")]
public ScheduleTrigger Trigger { get; set; }
Property Value
Type Description
ScheduleTrigger
Remarks

Required

In this article
Back to top