ScheduleSummary¶

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

Bases: object

Schedule summary for the list schedule.

Methods:

__init__(**kwargs)

Initializes a new ScheduleSummary object with values from keyword arguments.

Attributes:

`defined_tags`	Gets the defined_tags of this ScheduleSummary.
`description`	Gets the description of this ScheduleSummary.
`freeform_tags`	Gets the freeform_tags of this ScheduleSummary.
`id`	[Required] Gets the id of this ScheduleSummary.
`lifecycle_state`	[Required] Gets the lifecycle_state of this ScheduleSummary.
`name`	[Required] Gets the name of this ScheduleSummary.
`schedule_recurrences`	[Required] Gets the schedule_recurrences of this ScheduleSummary.
`system_tags`	Gets the system_tags of this ScheduleSummary.
`time_next_run`	Gets the time_next_run of this ScheduleSummary.
`time_scheduled`	[Required] Gets the time_scheduled of this ScheduleSummary.

__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.
name (str) – The value to assign to the name property of this ScheduleSummary.
description (str) – The value to assign to the description property of this ScheduleSummary.
time_next_run (datetime) – The value to assign to the time_next_run property of this ScheduleSummary.
schedule_recurrences (str) – The value to assign to the schedule_recurrences property of this ScheduleSummary.
time_scheduled (datetime) – The value to assign to the time_scheduled 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.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this ScheduleSummary.

property defined_tags¶

Gets the defined_tags of this ScheduleSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {“foo-namespace”: {“bar-key”: “value”}}

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

property description¶

Gets the description of this ScheduleSummary. The description of the schedule.

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

property freeform_tags¶

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

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

property id¶

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

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

property lifecycle_state¶

[Required] Gets the lifecycle_state of this ScheduleSummary. The schedule summary lifecycle state.

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

property name¶

[Required] Gets the name of this ScheduleSummary. The unique name of the user-created schedule.

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

property schedule_recurrences¶

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

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

property system_tags¶

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

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

property time_next_run¶

Gets the time_next_run of this ScheduleSummary. The date and time of the next job execution.

Returns: The time_next_run of this ScheduleSummary.
Return type: datetime

property time_scheduled¶

[Required] Gets the time_scheduled of this ScheduleSummary. The date and time of the first time job execution.

Returns: The time_scheduled of this ScheduleSummary.
Return type: datetime