CreateScheduleDetails¶

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

Bases: object

This is the data to create a schedule.

Attributes

`ACTION_START_RESOURCE`	A constant which can be used with the action property of a CreateScheduleDetails.
`ACTION_STOP_RESOURCE`	A constant which can be used with the action property of a CreateScheduleDetails.
`RECURRENCE_TYPE_CRON`	A constant which can be used with the recurrence_type property of a CreateScheduleDetails.
`RECURRENCE_TYPE_ICAL`	A constant which can be used with the recurrence_type property of a CreateScheduleDetails.
`action`	[Required] Gets the action of this CreateScheduleDetails.
`compartment_id`	[Required] Gets the compartment_id of this CreateScheduleDetails.
`defined_tags`	Gets the defined_tags of this CreateScheduleDetails.
`description`	Gets the description of this CreateScheduleDetails.
`display_name`	Gets the display_name of this CreateScheduleDetails.
`freeform_tags`	Gets the freeform_tags of this CreateScheduleDetails.
`recurrence_details`	[Required] Gets the recurrence_details of this CreateScheduleDetails.
`recurrence_type`	[Required] Gets the recurrence_type of this CreateScheduleDetails.
`resource_filters`	Gets the resource_filters of this CreateScheduleDetails.
`resources`	Gets the resources of this CreateScheduleDetails.
`time_ends`	Gets the time_ends of this CreateScheduleDetails.
`time_starts`	Gets the time_starts of this CreateScheduleDetails.

Methods

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

ACTION_START_RESOURCE = 'START_RESOURCE'¶: A constant which can be used with the action property of a CreateScheduleDetails. 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 CreateScheduleDetails. This constant has a value of “STOP_RESOURCE”

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

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

__init__(**kwargs)¶

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

Parameters:

compartment_id (str) – The value to assign to the compartment_id property of this CreateScheduleDetails.
display_name (str) – The value to assign to the display_name property of this CreateScheduleDetails.
description (str) – The value to assign to the description property of this CreateScheduleDetails.
action (str) – The value to assign to the action property of this CreateScheduleDetails. Allowed values for this property are: “START_RESOURCE”, “STOP_RESOURCE”
recurrence_details (str) – The value to assign to the recurrence_details property of this CreateScheduleDetails.
recurrence_type (str) – The value to assign to the recurrence_type property of this CreateScheduleDetails. Allowed values for this property are: “CRON”, “ICAL”
resource_filters (list[oci.resource_scheduler.models.ResourceFilter]) – The value to assign to the resource_filters property of this CreateScheduleDetails.
resources (list[oci.resource_scheduler.models.Resource]) – The value to assign to the resources property of this CreateScheduleDetails.
time_starts (datetime) – The value to assign to the time_starts property of this CreateScheduleDetails.
time_ends (datetime) – The value to assign to the time_ends property of this CreateScheduleDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateScheduleDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateScheduleDetails.

action¶

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

Allowed values for this property are: “START_RESOURCE”, “STOP_RESOURCE”

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

compartment_id¶

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

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

defined_tags¶

Gets the defined_tags of this CreateScheduleDetails. 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 CreateScheduleDetails.
Return type:	dict(str, dict(str, object))

description¶

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

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

display_name¶

Gets the display_name of this CreateScheduleDetails. 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 CreateScheduleDetails.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this CreateScheduleDetails. 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 CreateScheduleDetails.
Return type:	dict(str, str)

recurrence_details¶

[Required] Gets the recurrence_details of this CreateScheduleDetails. 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 CreateScheduleDetails.
Return type:	str

recurrence_type¶

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

Allowed values for this property are: “CRON”, “ICAL”

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

resource_filters¶

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

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

resources¶

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

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

time_ends¶

Gets the time_ends of this CreateScheduleDetails. This is the date and time the schedule ends, in the format defined by RFC 3339

Example: 2016-08-25T21:10:29.600Z

Returns:	The time_ends of this CreateScheduleDetails.
Return type:	datetime

time_starts¶

Gets the time_starts of this CreateScheduleDetails. This is the date and time the schedule starts, in the format defined by RFC 3339

Example: 2016-08-25T21:10:29.600Z

Returns:	The time_starts of this CreateScheduleDetails.
Return type:	datetime