ScheduledJobSummary

class oci.os_management_hub.models.ScheduledJobSummary(**kwargs)

Bases: object

Provides summary information for a scheduled job.

Attributes:

SCHEDULE_TYPE_ONETIME

A constant which can be used with the schedule_type property of a ScheduledJobSummary.

SCHEDULE_TYPE_RECURRING

A constant which can be used with the schedule_type property of a ScheduledJobSummary.

compartment_id

[Required] Gets the compartment_id of this ScheduledJobSummary.

defined_tags

[Required] Gets the defined_tags of this ScheduledJobSummary.

display_name

[Required] Gets the display_name of this ScheduledJobSummary.

dynamic_set_ids

Gets the dynamic_set_ids of this ScheduledJobSummary.

freeform_tags

[Required] Gets the freeform_tags of this ScheduledJobSummary.

id

[Required] Gets the id of this ScheduledJobSummary.

is_managed_by_autonomous_linux

Gets the is_managed_by_autonomous_linux of this ScheduledJobSummary.

is_restricted

Gets the is_restricted of this ScheduledJobSummary.

lifecycle_stage_ids

Gets the lifecycle_stage_ids of this ScheduledJobSummary.

lifecycle_state

[Required] Gets the lifecycle_state of this ScheduledJobSummary.

locations

Gets the locations of this ScheduledJobSummary.

managed_compartment_ids

Gets the managed_compartment_ids of this ScheduledJobSummary.

managed_instance_group_ids

Gets the managed_instance_group_ids of this ScheduledJobSummary.

managed_instance_ids

Gets the managed_instance_ids of this ScheduledJobSummary.

operations

[Required] Gets the operations of this ScheduledJobSummary.

retry_intervals

Gets the retry_intervals of this ScheduledJobSummary.

schedule_type

[Required] Gets the schedule_type of this ScheduledJobSummary.

system_tags

Gets the system_tags of this ScheduledJobSummary.

time_created

[Required] Gets the time_created of this ScheduledJobSummary.

time_last_execution

Gets the time_last_execution of this ScheduledJobSummary.

time_next_execution

[Required] Gets the time_next_execution of this ScheduledJobSummary.

time_updated

[Required] Gets the time_updated of this ScheduledJobSummary.

work_request_id

Gets the work_request_id of this ScheduledJobSummary.

Methods:

__init__(**kwargs)

Initializes a new ScheduledJobSummary object with values from keyword arguments.

SCHEDULE_TYPE_ONETIME = 'ONETIME'

A constant which can be used with the schedule_type property of a ScheduledJobSummary. This constant has a value of “ONETIME”

SCHEDULE_TYPE_RECURRING = 'RECURRING'

A constant which can be used with the schedule_type property of a ScheduledJobSummary. This constant has a value of “RECURRING”

__init__(**kwargs)

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

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

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

  • schedule_type (str) – The value to assign to the schedule_type property of this ScheduledJobSummary. Allowed values for this property are: “ONETIME”, “RECURRING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • locations (list[oci.os_management_hub.models.ManagedInstanceLocation]) – The value to assign to the locations property of this ScheduledJobSummary.

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

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

  • time_next_execution (datetime) – The value to assign to the time_next_execution property of this ScheduledJobSummary.

  • time_last_execution (datetime) – The value to assign to the time_last_execution property of this ScheduledJobSummary.

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

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

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

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

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

  • operations (list[oci.os_management_hub.models.ScheduledJobOperation]) – The value to assign to the operations property of this ScheduledJobSummary.

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this ScheduledJobSummary.

  • is_managed_by_autonomous_linux (bool) – The value to assign to the is_managed_by_autonomous_linux property of this ScheduledJobSummary.

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

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

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

  • is_restricted (bool) – The value to assign to the is_restricted property of this ScheduledJobSummary.

  • retry_intervals (list[int]) – The value to assign to the retry_intervals property of this ScheduledJobSummary.

  • work_request_id (str) – The value to assign to the work_request_id property of this ScheduledJobSummary.

property compartment_id

[Required] Gets the compartment_id of this ScheduledJobSummary. The OCID of the compartment that contains the scheduled job.

Returns

The compartment_id of this ScheduledJobSummary.

Return type

str

property defined_tags

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

Return type

dict(str, dict(str, object))

property display_name

[Required] Gets the display_name of this ScheduledJobSummary. User-friendly name for the scheduled job.

Returns

The display_name of this ScheduledJobSummary.

Return type

str

property dynamic_set_ids

Gets the dynamic_set_ids of this ScheduledJobSummary. The dynamic set OCIDs that this scheduled job operates on. A scheduled job can only operate on one type of target. therefore this parameter is mutually exclusive with managedInstanceIds, managedInstanceGroupIds, managedCompartmentIds.

Returns

The dynamic_set_ids of this ScheduledJobSummary.

Return type

list[str]

property freeform_tags

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

Return type

dict(str, str)

property id

[Required] Gets the id of this ScheduledJobSummary. The OCID of the scheduled job.

Returns

The id of this ScheduledJobSummary.

Return type

str

property is_managed_by_autonomous_linux

Gets the is_managed_by_autonomous_linux of this ScheduledJobSummary. Indicates whether this scheduled job is managed by the Autonomous Linux service.

Returns

The is_managed_by_autonomous_linux of this ScheduledJobSummary.

Return type

bool

property is_restricted

Gets the is_restricted of this ScheduledJobSummary. Indicates if the schedule job has restricted update and deletion capabilities. For restricted scheduled jobs, you can update only the timeNextExecution, recurringRule, and tags.

Returns

The is_restricted of this ScheduledJobSummary.

Return type

bool

property lifecycle_stage_ids

Gets the lifecycle_stage_ids of this ScheduledJobSummary. The lifecycle stage OCIDs that this scheduled job operates on. A scheduled job can only operate on one type of target, therefore this parameter is mutually exclusive with managedInstanceIds, managedInstanceGroupIds, managedCompartmentIds, and dynamicSetIds.

Returns

The lifecycle_stage_ids of this ScheduledJobSummary.

Return type

list[str]

property lifecycle_state

[Required] Gets the lifecycle_state of this ScheduledJobSummary. The current state of the scheduled job.

Returns

The lifecycle_state of this ScheduledJobSummary.

Return type

str

property locations

Gets the locations of this ScheduledJobSummary. The list of locations this scheduled job should operate on for a job targeting on compartments. (Empty list means apply to all locations). This can only be set when managedCompartmentIds is not empty.

Returns

The locations of this ScheduledJobSummary.

Return type

list[oci.os_management_hub.models.ManagedInstanceLocation]

property managed_compartment_ids

Gets the managed_compartment_ids of this ScheduledJobSummary. The compartment OCIDs that this scheduled job operates on. A scheduled job can only operate on one type of target, therefore this parameter is mutually exclusive with managedInstanceIds, managedInstanceGroupIds, lifecycleStageIds, and dynamicSetIds.

Returns

The managed_compartment_ids of this ScheduledJobSummary.

Return type

list[str]

property managed_instance_group_ids

Gets the managed_instance_group_ids of this ScheduledJobSummary. The managed instance group OCIDs that this scheduled job operates on. A scheduled job can only operate on one type of target, therefore this parameter is mutually exclusive with managedInstanceIds, managedCompartmentIds, lifecycleStageIds, and dynamicSetIds.

Returns

The managed_instance_group_ids of this ScheduledJobSummary.

Return type

list[str]

property managed_instance_ids

Gets the managed_instance_ids of this ScheduledJobSummary. The managed instance OCIDs that this scheduled job operates on. A scheduled job can only operate on one type of target, therefore this parameter is mutually exclusive with managedInstanceGroupIds, managedCompartmentIds, lifecycleStageIds, and dynamicSetIds.

Returns

The managed_instance_ids of this ScheduledJobSummary.

Return type

list[str]

property operations

[Required] Gets the operations of this ScheduledJobSummary. The list of operations this scheduled job needs to perform. A scheduled job supports only one operation type, unless it is one of the following: * UPDATE_PACKAGES * UPDATE_ALL * UPDATE_SECURITY * UPDATE_BUGFIX * UPDATE_ENHANCEMENT * UPDATE_OTHER * UPDATE_KSPLICE_USERSPACE * UPDATE_KSPLICE_KERNEL

Returns

The operations of this ScheduledJobSummary.

Return type

list[oci.os_management_hub.models.ScheduledJobOperation]

property retry_intervals

Gets the retry_intervals of this ScheduledJobSummary. The amount of time in minutes to wait until retrying the scheduled job. If set, the service will automatically retry a failed scheduled job after the interval. For example, you could set the interval to [2,5,10]. If the initial execution of the job fails, the service waits 2 minutes and then retries. If that fails, the service waits 5 minutes and then retries. If that fails, the service waits 10 minutes and then retries.

Returns

The retry_intervals of this ScheduledJobSummary.

Return type

list[int]

property schedule_type

[Required] Gets the schedule_type of this ScheduledJobSummary. The type of scheduling this scheduled job follows.

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

Returns

The schedule_type of this ScheduledJobSummary.

Return type

str

property system_tags

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

Return type

dict(str, dict(str, object))

property time_created

[Required] Gets the time_created of this ScheduledJobSummary. The time this scheduled job was created (in RFC 3339 format).

Returns

The time_created of this ScheduledJobSummary.

Return type

datetime

property time_last_execution

Gets the time_last_execution of this ScheduledJobSummary. The time of the last execution of this scheduled job (in RFC 3339 format).b.

Returns

The time_last_execution of this ScheduledJobSummary.

Return type

datetime

property time_next_execution

[Required] Gets the time_next_execution of this ScheduledJobSummary. The time of the next execution of this scheduled job (in RFC 3339 format).

Returns

The time_next_execution of this ScheduledJobSummary.

Return type

datetime

property time_updated

[Required] Gets the time_updated of this ScheduledJobSummary. The time this scheduled job was updated (in RFC 3339 format).

Returns

The time_updated of this ScheduledJobSummary.

Return type

datetime

property work_request_id

Gets the work_request_id of this ScheduledJobSummary. The OCID for the work request that will be rerun.

Returns

The work_request_id of this ScheduledJobSummary.

Return type

str