ScheduleSummary¶

class oci.resource_scheduler.models.ScheduleSummary(**kwargs)¶

Bases: object

This is the summary information about a schedule.

Attributes

`ACTION_START_RESOURCE`	A constant which can be used with the action property of a ScheduleSummary.
`ACTION_STOP_RESOURCE`	A constant which can be used with the action property of a ScheduleSummary.
`LAST_RUN_STATUS_ACCEPTED`	A constant which can be used with the last_run_status property of a ScheduleSummary.
`LAST_RUN_STATUS_CANCELED`	A constant which can be used with the last_run_status property of a ScheduleSummary.
`LAST_RUN_STATUS_CANCELING`	A constant which can be used with the last_run_status property of a ScheduleSummary.
`LAST_RUN_STATUS_FAILED`	A constant which can be used with the last_run_status property of a ScheduleSummary.
`LAST_RUN_STATUS_IN_PROGRESS`	A constant which can be used with the last_run_status property of a ScheduleSummary.
`LAST_RUN_STATUS_NEEDS_ATTENTION`	A constant which can be used with the last_run_status property of a ScheduleSummary.
`LAST_RUN_STATUS_SUCCEEDED`	A constant which can be used with the last_run_status property of a ScheduleSummary.
`LAST_RUN_STATUS_WAITING`	A constant which can be used with the last_run_status property of a ScheduleSummary.
`RECURRENCE_TYPE_CRON`	A constant which can be used with the recurrence_type property of a ScheduleSummary.
`RECURRENCE_TYPE_ICAL`	A constant which can be used with the recurrence_type property of a ScheduleSummary.
`action`	[Required] Gets the action of this ScheduleSummary.
`compartment_id`	[Required] Gets the compartment_id of this ScheduleSummary.
`defined_tags`	Gets the defined_tags of this ScheduleSummary.
`description`	Gets the description of this ScheduleSummary.
`display_name`	[Required] Gets the display_name of this ScheduleSummary.
`freeform_tags`	Gets the freeform_tags of this ScheduleSummary.
`id`	[Required] Gets the id of this ScheduleSummary.
`last_run_status`	Gets the last_run_status of this ScheduleSummary.
`lifecycle_state`	[Required] Gets the lifecycle_state of this ScheduleSummary.
`recurrence_details`	[Required] Gets the recurrence_details of this ScheduleSummary.
`recurrence_type`	[Required] Gets the recurrence_type of this ScheduleSummary.
`resource_filters`	Gets the resource_filters of this ScheduleSummary.
`resources`	Gets the resources of this ScheduleSummary.
`system_tags`	Gets the system_tags of this ScheduleSummary.
`time_created`	Gets the time_created of this ScheduleSummary.
`time_ends`	Gets the time_ends of this ScheduleSummary.
`time_last_run`	Gets the time_last_run of this ScheduleSummary.
`time_next_run`	Gets the time_next_run of this ScheduleSummary.
`time_starts`	Gets the time_starts of this ScheduleSummary.
`time_updated`	Gets the time_updated of this ScheduleSummary.

Methods

__init__(**kwargs) Initializes a new ScheduleSummary object with values from keyword arguments.

ACTION_START_RESOURCE = 'START_RESOURCE'¶: A constant which can be used with the action property of a ScheduleSummary. This constant has a value of “START_RESOURCE”

ACTION_STOP_RESOURCE = 'STOP_RESOURCE'¶: A constant which can be used with the action property of a ScheduleSummary. This constant has a value of “STOP_RESOURCE”

LAST_RUN_STATUS_ACCEPTED = 'ACCEPTED'¶: A constant which can be used with the last_run_status property of a ScheduleSummary. This constant has a value of “ACCEPTED”

LAST_RUN_STATUS_CANCELED = 'CANCELED'¶: A constant which can be used with the last_run_status property of a ScheduleSummary. This constant has a value of “CANCELED”

LAST_RUN_STATUS_CANCELING = 'CANCELING'¶: A constant which can be used with the last_run_status property of a ScheduleSummary. This constant has a value of “CANCELING”

LAST_RUN_STATUS_FAILED = 'FAILED'¶: A constant which can be used with the last_run_status property of a ScheduleSummary. This constant has a value of “FAILED”

LAST_RUN_STATUS_IN_PROGRESS = 'IN_PROGRESS'¶: A constant which can be used with the last_run_status property of a ScheduleSummary. This constant has a value of “IN_PROGRESS”

LAST_RUN_STATUS_NEEDS_ATTENTION = 'NEEDS_ATTENTION'¶: A constant which can be used with the last_run_status property of a ScheduleSummary. This constant has a value of “NEEDS_ATTENTION”

LAST_RUN_STATUS_SUCCEEDED = 'SUCCEEDED'¶: A constant which can be used with the last_run_status property of a ScheduleSummary. This constant has a value of “SUCCEEDED”

LAST_RUN_STATUS_WAITING = 'WAITING'¶: A constant which can be used with the last_run_status property of a ScheduleSummary. This constant has a value of “WAITING”

RECURRENCE_TYPE_CRON = 'CRON'¶: A constant which can be used with the recurrence_type property of a ScheduleSummary. This constant has a value of “CRON”

RECURRENCE_TYPE_ICAL = 'ICAL'¶: A constant which can be used with the recurrence_type property of a ScheduleSummary. This constant has a value of “ICAL”

__init__(**kwargs)¶

Initializes a new ScheduleSummary 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 ScheduleSummary.
compartment_id (str) – The value to assign to the compartment_id property of this ScheduleSummary.
display_name (str) – The value to assign to the display_name property of this ScheduleSummary.
action (str) – The value to assign to the action property of this ScheduleSummary. Allowed values for this property are: “START_RESOURCE”, “STOP_RESOURCE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
description (str) – The value to assign to the description property of this ScheduleSummary.
recurrence_details (str) – The value to assign to the recurrence_details property of this ScheduleSummary.
recurrence_type (str) – The value to assign to the recurrence_type property of this ScheduleSummary. Allowed values for this property are: “CRON”, “ICAL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
resource_filters (list[oci.resource_scheduler.models.ResourceFilter]) – The value to assign to the resource_filters property of this ScheduleSummary.
resources (list[oci.resource_scheduler.models.Resource]) – The value to assign to the resources property of this ScheduleSummary.
time_starts (datetime) – The value to assign to the time_starts property of this ScheduleSummary.
time_ends (datetime) – The value to assign to the time_ends property of this ScheduleSummary.
time_created (datetime) – The value to assign to the time_created property of this ScheduleSummary.
time_updated (datetime) – The value to assign to the time_updated property of this ScheduleSummary.
time_last_run (datetime) – The value to assign to the time_last_run property of this ScheduleSummary.
time_next_run (datetime) – The value to assign to the time_next_run property of this ScheduleSummary.
last_run_status (str) – The value to assign to the last_run_status property of this ScheduleSummary. Allowed values for this property are: “ACCEPTED”, “IN_PROGRESS”, “WAITING”, “NEEDS_ATTENTION”, “FAILED”, “SUCCEEDED”, “CANCELING”, “CANCELED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this ScheduleSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this ScheduleSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this ScheduleSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this ScheduleSummary.

action¶

[Required] Gets the action of this ScheduleSummary. This is the action that will be executed by the schedule.

Allowed values for this property are: “START_RESOURCE”, “STOP_RESOURCE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The action of this ScheduleSummary.
Return type:	str

compartment_id¶

[Required] Gets the compartment_id of this ScheduleSummary. The OCID of the compartment in which the schedule is created

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

defined_tags¶

Gets the defined_tags of this ScheduleSummary. 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”}}

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

description¶

Gets the description of this ScheduleSummary. This is the description of the schedule.

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

display_name¶

[Required] Gets the display_name of this ScheduleSummary. This is a user-friendly name for the schedule. It does not have to be unique, and it’s changeable.

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

freeform_tags¶

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

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

id¶

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

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

last_run_status¶

Gets the last_run_status of this ScheduleSummary. This is the status of the last work request.

Allowed values for this property are: “ACCEPTED”, “IN_PROGRESS”, “WAITING”, “NEEDS_ATTENTION”, “FAILED”, “SUCCEEDED”, “CANCELING”, “CANCELED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The last_run_status of this ScheduleSummary.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this ScheduleSummary. This is the current state of the schedule.

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

recurrence_details¶

[Required] Gets the recurrence_details of this ScheduleSummary. 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.

Returns:	The recurrence_details of this ScheduleSummary.
Return type:	str

recurrence_type¶

[Required] Gets the recurrence_type of this ScheduleSummary. Type of recurrence of a schedule

Allowed values for this property are: “CRON”, “ICAL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The recurrence_type of this ScheduleSummary.
Return type:	str

resource_filters¶

Gets the resource_filters of this ScheduleSummary. This is a list of resources filters. The schedule will be applied to resources matching all of them.

Returns:	The resource_filters of this ScheduleSummary.
Return type:	list[oci.resource_scheduler.models.ResourceFilter]

resources¶

Gets the resources of this ScheduleSummary. This is the list of resources to which the scheduled operation is applied.

Returns:	The resources of this ScheduleSummary.
Return type:	list[oci.resource_scheduler.models.Resource]

system_tags¶

Gets the system_tags of this ScheduleSummary. These are system tags for this resource. Each key is predefined and scoped to a namespace.

Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

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

time_created¶

Gets the time_created of this ScheduleSummary. This is the date and time the schedule was created, in the format defined by RFC 3339.