Schedule¶

class oci.data_science.models.Schedule(**kwargs)¶

Bases: object

A repeating action. Examples: * Invoke a ML Pipeline Run once an hour. * Call ML Job Run every night at midnight.

Attributes:

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a Schedule.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a Schedule.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a Schedule.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a Schedule.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a Schedule.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a Schedule.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a Schedule.
`action`	[Required] Gets the action of this Schedule.
`compartment_id`	[Required] Gets the compartment_id of this Schedule.
`created_by`	[Required] Gets the created_by of this Schedule.
`defined_tags`	Gets the defined_tags of this Schedule.
`description`	Gets the description of this Schedule.
`display_name`	[Required] Gets the display_name of this Schedule.
`freeform_tags`	Gets the freeform_tags of this Schedule.
`id`	[Required] Gets the id of this Schedule.
`last_schedule_run_details`	Gets the last_schedule_run_details of this Schedule.
`lifecycle_details`	Gets the lifecycle_details of this Schedule.
`lifecycle_state`	[Required] Gets the lifecycle_state of this Schedule.
`log_details`	Gets the log_details of this Schedule.
`project_id`	[Required] Gets the project_id of this Schedule.
`system_tags`	Gets the system_tags of this Schedule.
`time_created`	[Required] Gets the time_created of this Schedule.
`time_last_schedule_run`	Gets the time_last_schedule_run of this Schedule.
`time_next_scheduled_run`	Gets the time_next_scheduled_run of this Schedule.
`time_updated`	Gets the time_updated of this Schedule.
`trigger`	[Required] Gets the trigger of this Schedule.

Methods:

__init__(**kwargs)

Initializes a new Schedule object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a Schedule. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a Schedule. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a Schedule. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a Schedule. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a Schedule. This constant has a value of “FAILED”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶: A constant which can be used with the lifecycle_state property of a Schedule. This constant has a value of “INACTIVE”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a Schedule. This constant has a value of “UPDATING”

__init__(**kwargs)¶

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

Parameters

id (str) – The value to assign to the id property of this Schedule.
compartment_id (str) – The value to assign to the compartment_id property of this Schedule.
project_id (str) – The value to assign to the project_id property of this Schedule.
display_name (str) – The value to assign to the display_name property of this Schedule.
description (str) – The value to assign to the description property of this Schedule.
time_last_schedule_run (datetime) – The value to assign to the time_last_schedule_run property of this Schedule.
time_next_scheduled_run (datetime) – The value to assign to the time_next_scheduled_run property of this Schedule.
time_created (datetime) – The value to assign to the time_created property of this Schedule.
time_updated (datetime) – The value to assign to the time_updated property of this Schedule.
created_by (str) – The value to assign to the created_by property of this Schedule.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this Schedule. Allowed values for this property are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this Schedule.
last_schedule_run_details (str) – The value to assign to the last_schedule_run_details property of this Schedule.
trigger (oci.data_science.models.ScheduleTrigger) – The value to assign to the trigger property of this Schedule.
action (oci.data_science.models.ScheduleAction) – The value to assign to the action property of this Schedule.
log_details (oci.data_science.models.ScheduleLogDetails) – The value to assign to the log_details property of this Schedule.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this Schedule.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this Schedule.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this Schedule.

property action¶

[Required] Gets the action of this Schedule.

Returns: The action of this Schedule.
Return type: oci.data_science.models.ScheduleAction

property compartment_id¶

[Required] Gets the compartment_id of this Schedule. The OCID of the compartment where you want to create the schedule.

Returns: The compartment_id of this Schedule.
Return type: str

property created_by¶

[Required] Gets the created_by of this Schedule. The OCID of the user who created the schedule.

Returns: The created_by of this Schedule.
Return type: str

property defined_tags¶

Gets the defined_tags of this Schedule. Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {“Operations”: {“CostCenter”: “42”}}

Returns: The defined_tags of this Schedule.
Return type: dict(str, dict(str, object))

property description¶

Gets the description of this Schedule. A short description of the schedule.

Returns: The description of this Schedule.
Return type: str

property display_name¶

[Required] Gets the display_name of this Schedule. A user-friendly display name for the resource. Avoid entering confidential information.

Returns: The display_name of this Schedule.
Return type: str

property freeform_tags¶

Gets the freeform_tags of this Schedule. 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”}

Returns: The freeform_tags of this Schedule.
Return type: dict(str, str)

property id¶

[Required] Gets the id of this Schedule. The OCID of the schedule.

Returns: The id of this Schedule.
Return type: str

property last_schedule_run_details¶

Gets the last_schedule_run_details of this Schedule. Details about the action performed by the last schedule execution. Example: Invoked ML Application trigger.

Returns: The last_schedule_run_details of this Schedule.
Return type: str

property lifecycle_details¶

Gets the lifecycle_details of this Schedule. A message describing the current state in more detail.

Returns: The lifecycle_details of this Schedule.
Return type: str

property lifecycle_state¶

[Required] Gets the lifecycle_state of this Schedule. The current state of the schedule. Example: ACTIVE

Allowed values for this property are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns: The lifecycle_state of this Schedule.
Return type: str

property log_details¶

Gets the log_details of this Schedule.

Returns: The log_details of this Schedule.
Return type: oci.data_science.models.ScheduleLogDetails

property project_id¶

[Required] Gets the project_id of this Schedule. The OCID of the project associated with the schedule.

Returns: The project_id of this Schedule.
Return type: str

property system_tags¶

Gets the system_tags of this Schedule. Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns: The system_tags of this Schedule.
Return type: dict(str, dict(str, object))

property time_created¶

[Required] Gets the time_created of this Schedule. The date and time the schedule was created. Format is defined by RFC3339. Example: 2022-08-05T01:02:29.600Z

Returns: The time_created of this Schedule.
Return type: datetime

property time_last_schedule_run¶

Gets the time_last_schedule_run of this Schedule. The last schedule execution time. Format is defined by RFC3339. Example: 2022-08-05T01:02:29.600Z

Returns: The time_last_schedule_run of this Schedule.
Return type: datetime

property time_next_scheduled_run¶

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

Returns: The time_next_scheduled_run of this Schedule.
Return type: datetime

property time_updated¶

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

Returns: The time_updated of this Schedule.
Return type: datetime

property trigger¶

[Required] Gets the trigger of this Schedule.

Returns: The trigger of this Schedule.
Return type: oci.data_science.models.ScheduleTrigger