ScheduledJob

class oci.os_management.models.ScheduledJob(**kwargs)

Bases: object

Detailed information about a Scheduled Job

Attributes

INTERVAL_TYPE_DAY A constant which can be used with the interval_type property of a ScheduledJob.
INTERVAL_TYPE_HOUR A constant which can be used with the interval_type property of a ScheduledJob.
INTERVAL_TYPE_MONTH A constant which can be used with the interval_type property of a ScheduledJob.
INTERVAL_TYPE_WEEK A constant which can be used with the interval_type property of a ScheduledJob.
LIFECYCLE_STATE_ACTIVE A constant which can be used with the lifecycle_state property of a ScheduledJob.
LIFECYCLE_STATE_CREATING A constant which can be used with the lifecycle_state property of a ScheduledJob.
LIFECYCLE_STATE_DELETED A constant which can be used with the lifecycle_state property of a ScheduledJob.
LIFECYCLE_STATE_DELETING A constant which can be used with the lifecycle_state property of a ScheduledJob.
LIFECYCLE_STATE_FAILED A constant which can be used with the lifecycle_state property of a ScheduledJob.
LIFECYCLE_STATE_UPDATING A constant which can be used with the lifecycle_state property of a ScheduledJob.
OPERATION_TYPE_INSTALL A constant which can be used with the operation_type property of a ScheduledJob.
OPERATION_TYPE_REMOVE A constant which can be used with the operation_type property of a ScheduledJob.
OPERATION_TYPE_UPDATE A constant which can be used with the operation_type property of a ScheduledJob.
OPERATION_TYPE_UPDATEALL A constant which can be used with the operation_type property of a ScheduledJob.
OS_FAMILY_ALL A constant which can be used with the os_family property of a ScheduledJob.
OS_FAMILY_LINUX A constant which can be used with the os_family property of a ScheduledJob.
OS_FAMILY_WINDOWS A constant which can be used with the os_family property of a ScheduledJob.
SCHEDULE_TYPE_ONETIME A constant which can be used with the schedule_type property of a ScheduledJob.
SCHEDULE_TYPE_RECURRING A constant which can be used with the schedule_type property of a ScheduledJob.
UPDATE_TYPE_ALL A constant which can be used with the update_type property of a ScheduledJob.
UPDATE_TYPE_BUGFIX A constant which can be used with the update_type property of a ScheduledJob.
UPDATE_TYPE_ENHANCEMENT A constant which can be used with the update_type property of a ScheduledJob.
UPDATE_TYPE_KSPLICE A constant which can be used with the update_type property of a ScheduledJob.
UPDATE_TYPE_OTHER A constant which can be used with the update_type property of a ScheduledJob.
UPDATE_TYPE_SECURITY A constant which can be used with the update_type property of a ScheduledJob.
compartment_id Gets the compartment_id of this ScheduledJob.
defined_tags Gets the defined_tags of this ScheduledJob.
description Gets the description of this ScheduledJob.
display_name [Required] Gets the display_name of this ScheduledJob.
freeform_tags Gets the freeform_tags of this ScheduledJob.
id [Required] Gets the id of this ScheduledJob.
interval_type Gets the interval_type of this ScheduledJob.
interval_value Gets the interval_value of this ScheduledJob.
is_restricted Gets the is_restricted of this ScheduledJob.
lifecycle_state Gets the lifecycle_state of this ScheduledJob.
managed_instance_groups Gets the managed_instance_groups of this ScheduledJob.
managed_instances Gets the managed_instances of this ScheduledJob.
operation_type Gets the operation_type of this ScheduledJob.
os_family Gets the os_family of this ScheduledJob.
package_names Gets the package_names of this ScheduledJob.
schedule_type Gets the schedule_type of this ScheduledJob.
time_last_execution Gets the time_last_execution of this ScheduledJob.
time_next_execution Gets the time_next_execution of this ScheduledJob.
update_names Gets the update_names of this ScheduledJob.
update_type Gets the update_type of this ScheduledJob.
work_requests Gets the work_requests of this ScheduledJob.

Methods

__init__(**kwargs) Initializes a new ScheduledJob object with values from keyword arguments.
INTERVAL_TYPE_DAY = 'DAY'

A constant which can be used with the interval_type property of a ScheduledJob. This constant has a value of “DAY”

INTERVAL_TYPE_HOUR = 'HOUR'

A constant which can be used with the interval_type property of a ScheduledJob. This constant has a value of “HOUR”

INTERVAL_TYPE_MONTH = 'MONTH'

A constant which can be used with the interval_type property of a ScheduledJob. This constant has a value of “MONTH”

INTERVAL_TYPE_WEEK = 'WEEK'

A constant which can be used with the interval_type property of a ScheduledJob. This constant has a value of “WEEK”

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

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

LIFECYCLE_STATE_CREATING = 'CREATING'

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

LIFECYCLE_STATE_DELETED = 'DELETED'

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

LIFECYCLE_STATE_DELETING = 'DELETING'

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

LIFECYCLE_STATE_FAILED = 'FAILED'

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

LIFECYCLE_STATE_UPDATING = 'UPDATING'

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

OPERATION_TYPE_INSTALL = 'INSTALL'

A constant which can be used with the operation_type property of a ScheduledJob. This constant has a value of “INSTALL”

OPERATION_TYPE_REMOVE = 'REMOVE'

A constant which can be used with the operation_type property of a ScheduledJob. This constant has a value of “REMOVE”

OPERATION_TYPE_UPDATE = 'UPDATE'

A constant which can be used with the operation_type property of a ScheduledJob. This constant has a value of “UPDATE”

OPERATION_TYPE_UPDATEALL = 'UPDATEALL'

A constant which can be used with the operation_type property of a ScheduledJob. This constant has a value of “UPDATEALL”

OS_FAMILY_ALL = 'ALL'

A constant which can be used with the os_family property of a ScheduledJob. This constant has a value of “ALL”

OS_FAMILY_LINUX = 'LINUX'

A constant which can be used with the os_family property of a ScheduledJob. This constant has a value of “LINUX”

OS_FAMILY_WINDOWS = 'WINDOWS'

A constant which can be used with the os_family property of a ScheduledJob. This constant has a value of “WINDOWS”

SCHEDULE_TYPE_ONETIME = 'ONETIME'

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

SCHEDULE_TYPE_RECURRING = 'RECURRING'

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

UPDATE_TYPE_ALL = 'ALL'

A constant which can be used with the update_type property of a ScheduledJob. This constant has a value of “ALL”

UPDATE_TYPE_BUGFIX = 'BUGFIX'

A constant which can be used with the update_type property of a ScheduledJob. This constant has a value of “BUGFIX”

UPDATE_TYPE_ENHANCEMENT = 'ENHANCEMENT'

A constant which can be used with the update_type property of a ScheduledJob. This constant has a value of “ENHANCEMENT”

UPDATE_TYPE_KSPLICE = 'KSPLICE'

A constant which can be used with the update_type property of a ScheduledJob. This constant has a value of “KSPLICE”

UPDATE_TYPE_OTHER = 'OTHER'

A constant which can be used with the update_type property of a ScheduledJob. This constant has a value of “OTHER”

UPDATE_TYPE_SECURITY = 'SECURITY'

A constant which can be used with the update_type property of a ScheduledJob. This constant has a value of “SECURITY”

__init__(**kwargs)

Initializes a new ScheduledJob 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 ScheduledJob.
  • compartment_id (str) – The value to assign to the compartment_id property of this ScheduledJob.
  • display_name (str) – The value to assign to the display_name property of this ScheduledJob.
  • description (str) – The value to assign to the description property of this ScheduledJob.
  • schedule_type (str) – The value to assign to the schedule_type property of this ScheduledJob. 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’.
  • time_next_execution (datetime) – The value to assign to the time_next_execution property of this ScheduledJob.
  • time_last_execution (datetime) – The value to assign to the time_last_execution property of this ScheduledJob.
  • interval_type (str) – The value to assign to the interval_type property of this ScheduledJob. Allowed values for this property are: “HOUR”, “DAY”, “WEEK”, “MONTH”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
  • interval_value (str) – The value to assign to the interval_value property of this ScheduledJob.
  • managed_instances (list[oci.os_management.models.Id]) – The value to assign to the managed_instances property of this ScheduledJob.
  • managed_instance_groups (list[oci.os_management.models.Id]) – The value to assign to the managed_instance_groups property of this ScheduledJob.
  • operation_type (str) – The value to assign to the operation_type property of this ScheduledJob. Allowed values for this property are: “INSTALL”, “UPDATE”, “REMOVE”, “UPDATEALL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
  • update_type (str) – The value to assign to the update_type property of this ScheduledJob. Allowed values for this property are: “SECURITY”, “BUGFIX”, “ENHANCEMENT”, “OTHER”, “KSPLICE”, “ALL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
  • package_names (list[oci.os_management.models.PackageName]) – The value to assign to the package_names property of this ScheduledJob.
  • work_requests (list[oci.os_management.models.Id]) – The value to assign to the work_requests property of this ScheduledJob.
  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this ScheduledJob. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this ScheduledJob.
  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this ScheduledJob.
  • update_names (list[str]) – The value to assign to the update_names property of this ScheduledJob.
  • os_family (str) – The value to assign to the os_family property of this ScheduledJob. Allowed values for this property are: “LINUX”, “WINDOWS”, “ALL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
  • is_restricted (bool) – The value to assign to the is_restricted property of this ScheduledJob.
compartment_id

Gets the compartment_id of this ScheduledJob. OCID for the Compartment

Returns:The compartment_id of this ScheduledJob.
Return type:str
defined_tags

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

Gets the description of this ScheduledJob. Details describing the Scheduled Job.

Returns:The description of this ScheduledJob.
Return type:str
display_name

[Required] Gets the display_name of this ScheduledJob. Scheduled Job name

Returns:The display_name of this ScheduledJob.
Return type:str
freeform_tags

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

[Required] Gets the id of this ScheduledJob. OCID for the Scheduled Job

Returns:The id of this ScheduledJob.
Return type:str
interval_type

Gets the interval_type of this ScheduledJob. the interval period for a recurring Scheduled Job (only if schedule type is RECURRING)

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

Returns:The interval_type of this ScheduledJob.
Return type:str
interval_value

Gets the interval_value of this ScheduledJob. the value for the interval period for a recurring Scheduled Job (only if schedule type is RECURRING)

Returns:The interval_value of this ScheduledJob.
Return type:str
is_restricted

Gets the is_restricted of this ScheduledJob. true, if the schedule job has its update capabilities restricted. (Used to track Autonomous Scheduled Job)

Returns:The is_restricted of this ScheduledJob.
Return type:bool
lifecycle_state

Gets the lifecycle_state of this ScheduledJob. The current state of the Scheduled Job.

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

Returns:The lifecycle_state of this ScheduledJob.
Return type:str
managed_instance_groups

Gets the managed_instance_groups of this ScheduledJob. the list of managed instance groups this scheduled job operates on (mutually exclusive with managedInstances)

Returns:The managed_instance_groups of this ScheduledJob.
Return type:list[oci.os_management.models.Id]
managed_instances

Gets the managed_instances of this ScheduledJob. the list of managed instances this scheduled job operates on (mutually exclusive with managedInstanceGroups)

Returns:The managed_instances of this ScheduledJob.
Return type:list[oci.os_management.models.Id]
operation_type

Gets the operation_type of this ScheduledJob. the type of operation this Scheduled Job performs

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

Returns:The operation_type of this ScheduledJob.
Return type:str
os_family

Gets the os_family of this ScheduledJob. The Operating System type of the managed instance.

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

Returns:The os_family of this ScheduledJob.
Return type:str
package_names

Gets the package_names of this ScheduledJob. the names of the updates (only if operation type is INSTALL/UPDATE/REMOVE)

Returns:The package_names of this ScheduledJob.
Return type:list[oci.os_management.models.PackageName]
schedule_type

Gets the schedule_type of this ScheduledJob. 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 ScheduledJob.
Return type:str
time_last_execution

Gets the time_last_execution of this ScheduledJob. the time of the last execution of this Scheduled Job

Returns:The time_last_execution of this ScheduledJob.
Return type:datetime
time_next_execution

Gets the time_next_execution of this ScheduledJob. the time of the next execution of this Scheduled Job

Returns:The time_next_execution of this ScheduledJob.
Return type:datetime
update_names

Gets the update_names of this ScheduledJob. The unique names of the Windows Updates (only if operation type is INSTALL). This is only applicable when the osFamily is for Windows managed instances.

Returns:The update_names of this ScheduledJob.
Return type:list[str]
update_type

Gets the update_type of this ScheduledJob. Type of the update (only if operation type is UPDATEALL)

Allowed values for this property are: “SECURITY”, “BUGFIX”, “ENHANCEMENT”, “OTHER”, “KSPLICE”, “ALL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:The update_type of this ScheduledJob.
Return type:str
work_requests

Gets the work_requests of this ScheduledJob. list of Work Requests associated with this Scheduled Job

Returns:The work_requests of this ScheduledJob.
Return type:list[oci.os_management.models.Id]