SchedulerJob

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

Bases: object

A SchedulerJob resource.

Attributes:

LIFECYCLE_STATE_ACCEPTED

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

LIFECYCLE_STATE_CANCELED

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

LIFECYCLE_STATE_FAILED

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

LIFECYCLE_STATE_IN_PROGRESS

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

LIFECYCLE_STATE_NEEDS_ATTENTION

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

LIFECYCLE_STATE_SUCCEEDED

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

LIFECYCLE_STATE_WAITING

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

action_groups

Gets the action_groups of this SchedulerJob.

compartment_id

[Required] Gets the compartment_id of this SchedulerJob.

count_of_affected_action_groups

Gets the count_of_affected_action_groups of this SchedulerJob.

count_of_affected_resources

Gets the count_of_affected_resources of this SchedulerJob.

count_of_affected_targets

Gets the count_of_affected_targets of this SchedulerJob.

defined_tags

[Required] Gets the defined_tags of this SchedulerJob.

display_name

[Required] Gets the display_name of this SchedulerJob.

freeform_tags

[Required] Gets the freeform_tags of this SchedulerJob.

id

[Required] Gets the id of this SchedulerJob.

lifecycle_details

Gets the lifecycle_details of this SchedulerJob.

lifecycle_operations

Gets the lifecycle_operations of this SchedulerJob.

lifecycle_state

[Required] Gets the lifecycle_state of this SchedulerJob.

products

Gets the products of this SchedulerJob.

scheduler_definition

Gets the scheduler_definition of this SchedulerJob.

system_tags

Gets the system_tags of this SchedulerJob.

time_created

[Required] Gets the time_created of this SchedulerJob.

time_ended

Gets the time_ended of this SchedulerJob.

time_scheduled

Gets the time_scheduled of this SchedulerJob.

time_started

Gets the time_started of this SchedulerJob.

time_updated

Gets the time_updated of this SchedulerJob.

Methods:

__init__(**kwargs)

Initializes a new SchedulerJob object with values from keyword arguments.

LIFECYCLE_STATE_ACCEPTED = 'ACCEPTED'

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

LIFECYCLE_STATE_CANCELED = 'CANCELED'

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

LIFECYCLE_STATE_FAILED = 'FAILED'

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

LIFECYCLE_STATE_IN_PROGRESS = 'IN_PROGRESS'

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

LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'

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

LIFECYCLE_STATE_SUCCEEDED = 'SUCCEEDED'

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

LIFECYCLE_STATE_WAITING = 'WAITING'

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

__init__(**kwargs)

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

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

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

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

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

  • time_scheduled (datetime) – The value to assign to the time_scheduled property of this SchedulerJob.

  • time_started (datetime) – The value to assign to the time_started property of this SchedulerJob.

  • time_ended (datetime) – The value to assign to the time_ended property of this SchedulerJob.

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

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

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

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

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

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

  • scheduler_definition (oci.fleet_apps_management.models.AssociatedSchedulerDefinition) – The value to assign to the scheduler_definition property of this SchedulerJob.

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this SchedulerJob. Allowed values for this property are: “ACCEPTED”, “IN_PROGRESS”, “WAITING”, “FAILED”, “SUCCEEDED”, “CANCELED”, “NEEDS_ATTENTION”, ‘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 SchedulerJob.

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

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

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

property action_groups

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

Returns

The action_groups of this SchedulerJob.

Return type

list[oci.fleet_apps_management.models.ActionGroupDetails]

property compartment_id

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

Returns

The compartment_id of this SchedulerJob.

Return type

str

property count_of_affected_action_groups

Gets the count_of_affected_action_groups of this SchedulerJob. Count of Action Groups affected by the Schedule. An action group is a group of entities grouped for a lifecycle activity. Example - A Fleet will be considered an Action Group for any lifecycle activity.

Returns

The count_of_affected_action_groups of this SchedulerJob.

Return type

int

property count_of_affected_resources

Gets the count_of_affected_resources of this SchedulerJob. Count of resources affected by the schedule.

Returns

The count_of_affected_resources of this SchedulerJob.

Return type

int

property count_of_affected_targets

Gets the count_of_affected_targets of this SchedulerJob. Count of targets affected by the schedule.

Returns

The count_of_affected_targets of this SchedulerJob.

Return type

int

property defined_tags

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

Return type

dict(str, dict(str, object))

property display_name

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

Return type

str

property freeform_tags

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

Return type

dict(str, str)

property id

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

Returns

The id of this SchedulerJob.

Return type

str

property lifecycle_details

Gets the lifecycle_details of this SchedulerJob. 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 SchedulerJob.

Return type

str

property lifecycle_operations

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

Returns

The lifecycle_operations of this SchedulerJob.

Return type

list[str]

property lifecycle_state

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

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

Returns

The lifecycle_state of this SchedulerJob.

Return type

str

property products

Gets the products of this SchedulerJob. All products that are part of the schedule for a PRODUCT action group type.

Returns

The products of this SchedulerJob.

Return type

list[str]

property scheduler_definition

Gets the scheduler_definition of this SchedulerJob.

Returns

The scheduler_definition of this SchedulerJob.

Return type

oci.fleet_apps_management.models.AssociatedSchedulerDefinition

property system_tags

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

Return type

dict(str, dict(str, object))

property time_created

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

Returns

The time_created of this SchedulerJob.

Return type

datetime

property time_ended

Gets the time_ended of this SchedulerJob. Actual end date and time for the Job.

Returns

The time_ended of this SchedulerJob.

Return type

datetime

property time_scheduled

Gets the time_scheduled of this SchedulerJob. The scheduled date and time for the Job.

Returns

The time_scheduled of this SchedulerJob.

Return type

datetime

property time_started

Gets the time_started of this SchedulerJob. Actual start date and time for the Job.

Returns

The time_started of this SchedulerJob.

Return type

datetime

property time_updated

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

Returns

The time_updated of this SchedulerJob.

Return type

datetime