SchedulerDefinition

class oci.fleet_apps_management.models.SchedulerDefinition(**kwargs)

Bases: object

Definition of a Schedule.

Attributes:

LIFECYCLE_STATE_ACTIVE

A constant which can be used with the lifecycle_state property of a SchedulerDefinition.

LIFECYCLE_STATE_CREATING

A constant which can be used with the lifecycle_state property of a SchedulerDefinition.

LIFECYCLE_STATE_DELETED

A constant which can be used with the lifecycle_state property of a SchedulerDefinition.

LIFECYCLE_STATE_DELETING

A constant which can be used with the lifecycle_state property of a SchedulerDefinition.

LIFECYCLE_STATE_FAILED

A constant which can be used with the lifecycle_state property of a SchedulerDefinition.

LIFECYCLE_STATE_INACTIVE

A constant which can be used with the lifecycle_state property of a SchedulerDefinition.

LIFECYCLE_STATE_UPDATING

A constant which can be used with the lifecycle_state property of a SchedulerDefinition.

action_groups

Gets the action_groups of this SchedulerDefinition.

compartment_id

[Required] Gets the compartment_id of this SchedulerDefinition.

count_of_affected_action_groups

Gets the count_of_affected_action_groups of this SchedulerDefinition.

count_of_affected_resources

Gets the count_of_affected_resources of this SchedulerDefinition.

count_of_affected_targets

Gets the count_of_affected_targets of this SchedulerDefinition.

defined_tags

Gets the defined_tags of this SchedulerDefinition.

description

Gets the description of this SchedulerDefinition.

display_name

[Required] Gets the display_name of this SchedulerDefinition.

freeform_tags

Gets the freeform_tags of this SchedulerDefinition.

id

[Required] Gets the id of this SchedulerDefinition.

lifecycle_details

Gets the lifecycle_details of this SchedulerDefinition.

lifecycle_operations

Gets the lifecycle_operations of this SchedulerDefinition.

lifecycle_state

[Required] Gets the lifecycle_state of this SchedulerDefinition.

products

Gets the products of this SchedulerDefinition.

resource_region

Gets the resource_region of this SchedulerDefinition.

run_books

Gets the run_books of this SchedulerDefinition.

schedule

Gets the schedule of this SchedulerDefinition.

system_tags

Gets the system_tags of this SchedulerDefinition.

time_created

[Required] Gets the time_created of this SchedulerDefinition.

time_of_next_run

Gets the time_of_next_run of this SchedulerDefinition.

time_updated

Gets the time_updated of this SchedulerDefinition.

Methods:

__init__(**kwargs)

Initializes a new SchedulerDefinition object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a SchedulerDefinition. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'

A constant which can be used with the lifecycle_state property of a SchedulerDefinition. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'

A constant which can be used with the lifecycle_state property of a SchedulerDefinition. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'

A constant which can be used with the lifecycle_state property of a SchedulerDefinition. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'

A constant which can be used with the lifecycle_state property of a SchedulerDefinition. This constant has a value of “FAILED”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'

A constant which can be used with the lifecycle_state property of a SchedulerDefinition. This constant has a value of “INACTIVE”

LIFECYCLE_STATE_UPDATING = 'UPDATING'

A constant which can be used with the lifecycle_state property of a SchedulerDefinition. This constant has a value of “UPDATING”

__init__(**kwargs)

Initializes a new SchedulerDefinition 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 SchedulerDefinition.

  • display_name (str) – The value to assign to the display_name property of this SchedulerDefinition.

  • description (str) – The value to assign to the description property of this SchedulerDefinition.

  • compartment_id (str) – The value to assign to the compartment_id property of this SchedulerDefinition.

  • resource_region (str) – The value to assign to the resource_region property of this SchedulerDefinition.

  • time_created (datetime) – The value to assign to the time_created property of this SchedulerDefinition.

  • time_updated (datetime) – The value to assign to the time_updated property of this SchedulerDefinition.

  • time_of_next_run (datetime) – The value to assign to the time_of_next_run property of this SchedulerDefinition.

  • schedule (oci.fleet_apps_management.models.Schedule) – The value to assign to the schedule property of this SchedulerDefinition.

  • count_of_affected_action_groups (int) – The value to assign to the count_of_affected_action_groups property of this SchedulerDefinition.

  • count_of_affected_resources (int) – The value to assign to the count_of_affected_resources property of this SchedulerDefinition.

  • count_of_affected_targets (int) – The value to assign to the count_of_affected_targets property of this SchedulerDefinition.

  • products (list[str]) – The value to assign to the products property of this SchedulerDefinition.

  • lifecycle_operations (list[str]) – The value to assign to the lifecycle_operations property of this SchedulerDefinition.

  • action_groups (list[oci.fleet_apps_management.models.ActionGroup]) – The value to assign to the action_groups property of this SchedulerDefinition.

  • run_books (list[oci.fleet_apps_management.models.OperationRunbook]) – The value to assign to the run_books property of this SchedulerDefinition.

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this SchedulerDefinition. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, “INACTIVE”, ‘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 SchedulerDefinition.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this SchedulerDefinition.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this SchedulerDefinition.

  • system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this SchedulerDefinition.

property action_groups

Gets the action_groups of this SchedulerDefinition. Action Groups associated with the Schedule.

Returns

The action_groups of this SchedulerDefinition.

Return type

list[oci.fleet_apps_management.models.ActionGroup]

property compartment_id

[Required] Gets the compartment_id of this SchedulerDefinition. Compartment OCID

Returns

The compartment_id of this SchedulerDefinition.

Return type

str

property count_of_affected_action_groups

Gets the count_of_affected_action_groups of this SchedulerDefinition. Count of Action Groups affected by the Schedule.

Returns

The count_of_affected_action_groups of this SchedulerDefinition.

Return type

int

property count_of_affected_resources

Gets the count_of_affected_resources of this SchedulerDefinition. Count of Resources affected by the Schedule.

Returns

The count_of_affected_resources of this SchedulerDefinition.

Return type

int

property count_of_affected_targets

Gets the count_of_affected_targets of this SchedulerDefinition. Count of Targets affected by the Schedule.

Returns

The count_of_affected_targets of this SchedulerDefinition.

Return type

int

property defined_tags

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

Returns

The defined_tags of this SchedulerDefinition.

Return type

dict(str, dict(str, object))

property description

Gets the description of this SchedulerDefinition. A user-friendly description. To provide some insight about the resource. Avoid entering confidential information.

Returns

The description of this SchedulerDefinition.

Return type

str

property display_name

[Required] Gets the display_name of this SchedulerDefinition. A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.

Example: My new resource

Returns

The display_name of this SchedulerDefinition.

Return type

str

property freeform_tags

Gets the freeform_tags of this SchedulerDefinition. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}

Returns

The freeform_tags of this SchedulerDefinition.

Return type

dict(str, str)

property id

[Required] Gets the id of this SchedulerDefinition. The OCID of the resource.

Returns

The id of this SchedulerDefinition.

Return type

str

property lifecycle_details

Gets the lifecycle_details of this SchedulerDefinition. A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

Returns

The lifecycle_details of this SchedulerDefinition.

Return type

str

property lifecycle_operations

Gets the lifecycle_operations of this SchedulerDefinition. All LifeCycle Operations that are part of the schedule.

Returns

The lifecycle_operations of this SchedulerDefinition.

Return type

list[str]

property lifecycle_state

[Required] Gets the lifecycle_state of this SchedulerDefinition. The current state of the SchedulerDefinition.

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

Returns

The lifecycle_state of this SchedulerDefinition.

Return type

str

property products

Gets the products of this SchedulerDefinition. All products that are part of the schedule for PRODUCT ActionGroup Type.

Returns

The products of this SchedulerDefinition.

Return type

list[str]

property resource_region

Gets the resource_region of this SchedulerDefinition. Associated region

Returns

The resource_region of this SchedulerDefinition.

Return type

str

property run_books

Gets the run_books of this SchedulerDefinition. Runbooks.

Returns

The run_books of this SchedulerDefinition.

Return type

list[oci.fleet_apps_management.models.OperationRunbook]

property schedule

Gets the schedule of this SchedulerDefinition.

Returns

The schedule of this SchedulerDefinition.

Return type

oci.fleet_apps_management.models.Schedule

property system_tags

Gets the system_tags of this SchedulerDefinition. 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 SchedulerDefinition.

Return type

dict(str, dict(str, object))

property time_created

[Required] Gets the time_created of this SchedulerDefinition. The time this resource was created. An RFC3339 formatted datetime string.

Returns

The time_created of this SchedulerDefinition.

Return type

datetime

property time_of_next_run

Gets the time_of_next_run of this SchedulerDefinition. The scheduled date for the next run of the Job.

Returns

The time_of_next_run of this SchedulerDefinition.

Return type

datetime

property time_updated

Gets the time_updated of this SchedulerDefinition. The time this resource was last updated. An RFC3339 formatted datetime string.

Returns

The time_updated of this SchedulerDefinition.

Return type

datetime