TaskSchedule¶

class oci.jms.models.TaskSchedule(**kwargs)¶

Bases: object

The properties of a task schedule.

Attributes:

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a TaskSchedule.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a TaskSchedule.
`created_by`	[Required] Gets the created_by of this TaskSchedule.
`execution_recurrences`	[Required] Gets the execution_recurrences of this TaskSchedule.
`fleet_id`	[Required] Gets the fleet_id of this TaskSchedule.
`id`	[Required] Gets the id of this TaskSchedule.
`lifecycle_state`	[Required] Gets the lifecycle_state of this TaskSchedule.
`name`	[Required] Gets the name of this TaskSchedule.
`task_details`	[Required] Gets the task_details of this TaskSchedule.
`time_created`	[Required] Gets the time_created of this TaskSchedule.
`time_last_run`	Gets the time_last_run of this TaskSchedule.
`time_last_updated`	[Required] Gets the time_last_updated of this TaskSchedule.
`time_next_run`	Gets the time_next_run of this TaskSchedule.

Methods:

__init__(**kwargs)

Initializes a new TaskSchedule object with values from keyword arguments.

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

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

__init__(**kwargs)¶

Initializes a new TaskSchedule 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 TaskSchedule.
fleet_id (str) – The value to assign to the fleet_id property of this TaskSchedule.
name (str) – The value to assign to the name property of this TaskSchedule.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this TaskSchedule. Allowed values for this property are: “ACTIVE”, “INACTIVE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
created_by (str) – The value to assign to the created_by property of this TaskSchedule.
execution_recurrences (str) – The value to assign to the execution_recurrences property of this TaskSchedule.
task_details (oci.jms.models.TaskDetails) – The value to assign to the task_details property of this TaskSchedule.
time_created (datetime) – The value to assign to the time_created property of this TaskSchedule.
time_last_run (datetime) – The value to assign to the time_last_run property of this TaskSchedule.
time_next_run (datetime) – The value to assign to the time_next_run property of this TaskSchedule.
time_last_updated (datetime) – The value to assign to the time_last_updated property of this TaskSchedule.

property created_by¶

[Required] Gets the created_by of this TaskSchedule. Name of the task creator.

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

property execution_recurrences¶

[Required] Gets the execution_recurrences of this TaskSchedule. Recurrence specification for the task schedule execution (formatted according to RFC-5545). To run daily for 10 occurrences starts on September 2, 2024 09:00 UTC, it should be ‘DTSTART=20240902T090000Z; RRULE:FREQ=DAILY;COUNT=10’. To run every 3 hours from 9:00 AM to 5:00 PM on August 5, 2024 UTC, it should be ‘DTSTART=20240805T090000Z;RRULE:FREQ=HOURLY;INTERVAL=3;UNTIL=20240805T170000Z’.

Returns: The execution_recurrences of this TaskSchedule.
Return type: str

property fleet_id¶

[Required] Gets the fleet_id of this TaskSchedule. The OCID of the Fleet.

Returns: The fleet_id of this TaskSchedule.
Return type: str

property id¶

[Required] Gets the id of this TaskSchedule. The OCID to identify this task schedule.

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

property lifecycle_state¶

[Required] Gets the lifecycle_state of this TaskSchedule. All possible status of task schedule.

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

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

property name¶

[Required] Gets the name of this TaskSchedule. The name of the task schedule.

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

property task_details¶

[Required] Gets the task_details of this TaskSchedule.

Returns: The task_details of this TaskSchedule.
Return type: oci.jms.models.TaskDetails

property time_created¶

[Required] Gets the time_created of this TaskSchedule. The date and time the task schedule was created (formatted according to RFC3339).

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

property time_last_run¶

Gets the time_last_run of this TaskSchedule. The date and time the task schedule ran last (formatted according to RFC3339).

Returns: The time_last_run of this TaskSchedule.
Return type: datetime

property time_last_updated¶

[Required] Gets the time_last_updated of this TaskSchedule. The date and time the task schedule was last updated (formatted according to RFC3339).

Returns: The time_last_updated of this TaskSchedule.
Return type: datetime

property time_next_run¶

Gets the time_next_run of this TaskSchedule. The date and time the task schedule will run next (formatted according to RFC3339).

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