CreateScheduledJobDetails¶

class oci.os_management.models.CreateScheduledJobDetails(**kwargs)¶

Bases: object

Information for creating a Scheduled Job

Attributes

`INTERVAL_TYPE_DAY`	A constant which can be used with the interval_type property of a CreateScheduledJobDetails.
`INTERVAL_TYPE_HOUR`	A constant which can be used with the interval_type property of a CreateScheduledJobDetails.
`INTERVAL_TYPE_MONTH`	A constant which can be used with the interval_type property of a CreateScheduledJobDetails.
`INTERVAL_TYPE_WEEK`	A constant which can be used with the interval_type property of a CreateScheduledJobDetails.
`OPERATION_TYPE_COMPOUND`	A constant which can be used with the operation_type property of a CreateScheduledJobDetails.
`OPERATION_TYPE_DISABLEMODULESTREAM`	A constant which can be used with the operation_type property of a CreateScheduledJobDetails.
`OPERATION_TYPE_ENABLEMODULESTREAM`	A constant which can be used with the operation_type property of a CreateScheduledJobDetails.
`OPERATION_TYPE_INSTALL`	A constant which can be used with the operation_type property of a CreateScheduledJobDetails.
`OPERATION_TYPE_INSTALLMODULESTREAMPROFILE`	A constant which can be used with the operation_type property of a CreateScheduledJobDetails.
`OPERATION_TYPE_REMOVE`	A constant which can be used with the operation_type property of a CreateScheduledJobDetails.
`OPERATION_TYPE_REMOVEMODULESTREAMPROFILE`	A constant which can be used with the operation_type property of a CreateScheduledJobDetails.
`OPERATION_TYPE_SWITCHMODULESTREAM`	A constant which can be used with the operation_type property of a CreateScheduledJobDetails.
`OPERATION_TYPE_UPDATE`	A constant which can be used with the operation_type property of a CreateScheduledJobDetails.
`OPERATION_TYPE_UPDATEALL`	A constant which can be used with the operation_type property of a CreateScheduledJobDetails.
`OS_FAMILY_ALL`	A constant which can be used with the os_family property of a CreateScheduledJobDetails.
`OS_FAMILY_LINUX`	A constant which can be used with the os_family property of a CreateScheduledJobDetails.
`OS_FAMILY_WINDOWS`	A constant which can be used with the os_family property of a CreateScheduledJobDetails.
`SCHEDULE_TYPE_ONETIME`	A constant which can be used with the schedule_type property of a CreateScheduledJobDetails.
`SCHEDULE_TYPE_RECURRING`	A constant which can be used with the schedule_type property of a CreateScheduledJobDetails.
`UPDATE_TYPE_ALL`	A constant which can be used with the update_type property of a CreateScheduledJobDetails.
`UPDATE_TYPE_BUGFIX`	A constant which can be used with the update_type property of a CreateScheduledJobDetails.
`UPDATE_TYPE_ENHANCEMENT`	A constant which can be used with the update_type property of a CreateScheduledJobDetails.
`UPDATE_TYPE_KSPLICE`	A constant which can be used with the update_type property of a CreateScheduledJobDetails.
`UPDATE_TYPE_OTHER`	A constant which can be used with the update_type property of a CreateScheduledJobDetails.
`UPDATE_TYPE_SECURITY`	A constant which can be used with the update_type property of a CreateScheduledJobDetails.
`compartment_id`	[Required] Gets the compartment_id of this CreateScheduledJobDetails.
`defined_tags`	Gets the defined_tags of this CreateScheduledJobDetails.
`description`	Gets the description of this CreateScheduledJobDetails.
`display_name`	[Required] Gets the display_name of this CreateScheduledJobDetails.
`freeform_tags`	Gets the freeform_tags of this CreateScheduledJobDetails.
`interval_type`	Gets the interval_type of this CreateScheduledJobDetails.
`interval_value`	Gets the interval_value of this CreateScheduledJobDetails.
`managed_instance_groups`	Gets the managed_instance_groups of this CreateScheduledJobDetails.
`managed_instances`	Gets the managed_instances of this CreateScheduledJobDetails.
`operation_type`	[Required] Gets the operation_type of this CreateScheduledJobDetails.
`os_family`	Gets the os_family of this CreateScheduledJobDetails.
`package_names`	Gets the package_names of this CreateScheduledJobDetails.
`schedule_type`	[Required] Gets the schedule_type of this CreateScheduledJobDetails.
`time_next_execution`	[Required] Gets the time_next_execution of this CreateScheduledJobDetails.
`update_names`	Gets the update_names of this CreateScheduledJobDetails.
`update_type`	Gets the update_type of this CreateScheduledJobDetails.

Methods

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

INTERVAL_TYPE_DAY = 'DAY'¶: A constant which can be used with the interval_type property of a CreateScheduledJobDetails. This constant has a value of “DAY”

INTERVAL_TYPE_HOUR = 'HOUR'¶: A constant which can be used with the interval_type property of a CreateScheduledJobDetails. This constant has a value of “HOUR”

INTERVAL_TYPE_MONTH = 'MONTH'¶: A constant which can be used with the interval_type property of a CreateScheduledJobDetails. This constant has a value of “MONTH”

INTERVAL_TYPE_WEEK = 'WEEK'¶: A constant which can be used with the interval_type property of a CreateScheduledJobDetails. This constant has a value of “WEEK”

OPERATION_TYPE_COMPOUND = 'COMPOUND'¶: A constant which can be used with the operation_type property of a CreateScheduledJobDetails. This constant has a value of “COMPOUND”

OPERATION_TYPE_DISABLEMODULESTREAM = 'DISABLEMODULESTREAM'¶: A constant which can be used with the operation_type property of a CreateScheduledJobDetails. This constant has a value of “DISABLEMODULESTREAM”

OPERATION_TYPE_ENABLEMODULESTREAM = 'ENABLEMODULESTREAM'¶: A constant which can be used with the operation_type property of a CreateScheduledJobDetails. This constant has a value of “ENABLEMODULESTREAM”

OPERATION_TYPE_INSTALL = 'INSTALL'¶: A constant which can be used with the operation_type property of a CreateScheduledJobDetails. This constant has a value of “INSTALL”

OPERATION_TYPE_INSTALLMODULESTREAMPROFILE = 'INSTALLMODULESTREAMPROFILE'¶: A constant which can be used with the operation_type property of a CreateScheduledJobDetails. This constant has a value of “INSTALLMODULESTREAMPROFILE”

OPERATION_TYPE_REMOVE = 'REMOVE'¶: A constant which can be used with the operation_type property of a CreateScheduledJobDetails. This constant has a value of “REMOVE”

OPERATION_TYPE_REMOVEMODULESTREAMPROFILE = 'REMOVEMODULESTREAMPROFILE'¶: A constant which can be used with the operation_type property of a CreateScheduledJobDetails. This constant has a value of “REMOVEMODULESTREAMPROFILE”

OPERATION_TYPE_SWITCHMODULESTREAM = 'SWITCHMODULESTREAM'¶: A constant which can be used with the operation_type property of a CreateScheduledJobDetails. This constant has a value of “SWITCHMODULESTREAM”

OPERATION_TYPE_UPDATE = 'UPDATE'¶: A constant which can be used with the operation_type property of a CreateScheduledJobDetails. This constant has a value of “UPDATE”

OPERATION_TYPE_UPDATEALL = 'UPDATEALL'¶: A constant which can be used with the operation_type property of a CreateScheduledJobDetails. This constant has a value of “UPDATEALL”

OS_FAMILY_ALL = 'ALL'¶: A constant which can be used with the os_family property of a CreateScheduledJobDetails. This constant has a value of “ALL”

OS_FAMILY_LINUX = 'LINUX'¶: A constant which can be used with the os_family property of a CreateScheduledJobDetails. This constant has a value of “LINUX”

OS_FAMILY_WINDOWS = 'WINDOWS'¶: A constant which can be used with the os_family property of a CreateScheduledJobDetails. This constant has a value of “WINDOWS”

SCHEDULE_TYPE_ONETIME = 'ONETIME'¶: A constant which can be used with the schedule_type property of a CreateScheduledJobDetails. This constant has a value of “ONETIME”

SCHEDULE_TYPE_RECURRING = 'RECURRING'¶: A constant which can be used with the schedule_type property of a CreateScheduledJobDetails. This constant has a value of “RECURRING”

UPDATE_TYPE_ALL = 'ALL'¶: A constant which can be used with the update_type property of a CreateScheduledJobDetails. This constant has a value of “ALL”

UPDATE_TYPE_BUGFIX = 'BUGFIX'¶: A constant which can be used with the update_type property of a CreateScheduledJobDetails. This constant has a value of “BUGFIX”

UPDATE_TYPE_ENHANCEMENT = 'ENHANCEMENT'¶: A constant which can be used with the update_type property of a CreateScheduledJobDetails. This constant has a value of “ENHANCEMENT”

UPDATE_TYPE_KSPLICE = 'KSPLICE'¶: A constant which can be used with the update_type property of a CreateScheduledJobDetails. This constant has a value of “KSPLICE”

UPDATE_TYPE_OTHER = 'OTHER'¶: A constant which can be used with the update_type property of a CreateScheduledJobDetails. This constant has a value of “OTHER”

UPDATE_TYPE_SECURITY = 'SECURITY'¶: A constant which can be used with the update_type property of a CreateScheduledJobDetails. This constant has a value of “SECURITY”

__init__(**kwargs)¶

Initializes a new CreateScheduledJobDetails 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 CreateScheduledJobDetails.
display_name (str) – The value to assign to the display_name property of this CreateScheduledJobDetails.
description (str) – The value to assign to the description property of this CreateScheduledJobDetails.
schedule_type (str) – The value to assign to the schedule_type property of this CreateScheduledJobDetails. Allowed values for this property are: “ONETIME”, “RECURRING”
time_next_execution (datetime) – The value to assign to the time_next_execution property of this CreateScheduledJobDetails.
interval_type (str) – The value to assign to the interval_type property of this CreateScheduledJobDetails. Allowed values for this property are: “HOUR”, “DAY”, “WEEK”, “MONTH”
interval_value (str) – The value to assign to the interval_value property of this CreateScheduledJobDetails.
managed_instances (list[oci.os_management.models.Id]) – The value to assign to the managed_instances property of this CreateScheduledJobDetails.
managed_instance_groups (list[oci.os_management.models.Id]) – The value to assign to the managed_instance_groups property of this CreateScheduledJobDetails.
operation_type (str) – The value to assign to the operation_type property of this CreateScheduledJobDetails. Allowed values for this property are: “INSTALL”, “UPDATE”, “REMOVE”, “UPDATEALL”, “ENABLEMODULESTREAM”, “DISABLEMODULESTREAM”, “SWITCHMODULESTREAM”, “INSTALLMODULESTREAMPROFILE”, “REMOVEMODULESTREAMPROFILE”, “COMPOUND”
update_type (str) – The value to assign to the update_type property of this CreateScheduledJobDetails. Allowed values for this property are: “SECURITY”, “BUGFIX”, “ENHANCEMENT”, “OTHER”, “KSPLICE”, “ALL”
package_names (list[oci.os_management.models.PackageName]) – The value to assign to the package_names property of this CreateScheduledJobDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateScheduledJobDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateScheduledJobDetails.
update_names (list[str]) – The value to assign to the update_names property of this CreateScheduledJobDetails.
os_family (str) – The value to assign to the os_family property of this CreateScheduledJobDetails. Allowed values for this property are: “LINUX”, “WINDOWS”, “ALL”

compartment_id¶

[Required] Gets the compartment_id of this CreateScheduledJobDetails. OCID for the Compartment

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

defined_tags¶

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

description¶

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

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

display_name¶

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

Returns:	The display_name of this CreateScheduledJobDetails.
Return type:	str

freeform_tags¶

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

interval_type¶

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

Allowed values for this property are: “HOUR”, “DAY”, “WEEK”, “MONTH”

Returns:	The interval_type of this CreateScheduledJobDetails.
Return type:	str

interval_value¶

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

Returns:	The interval_value of this CreateScheduledJobDetails.
Return type:	str

managed_instance_groups¶

Gets the managed_instance_groups of this CreateScheduledJobDetails. The list of managed instance groups this scheduled job operates on (mutually exclusive with managedInstances). Either this or managedInstances must be supplied.

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

managed_instances¶

Gets the managed_instances of this CreateScheduledJobDetails. The list of managed instances this scheduled job operates on (mutually exclusive with managedInstanceGroups). Either this or the managedInstanceGroups must be supplied.

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

operation_type¶

[Required] Gets the operation_type of this CreateScheduledJobDetails. the type of operation this Scheduled Job performs

Allowed values for this property are: “INSTALL”, “UPDATE”, “REMOVE”, “UPDATEALL”, “ENABLEMODULESTREAM”, “DISABLEMODULESTREAM”, “SWITCHMODULESTREAM”, “INSTALLMODULESTREAMPROFILE”, “REMOVEMODULESTREAMPROFILE”, “COMPOUND”

Returns:	The operation_type of this CreateScheduledJobDetails.
Return type:	str

os_family¶

Gets the os_family of this CreateScheduledJobDetails. The Operating System type of the managed instance(s) on which this scheduled job will operate. If not specified, this defaults to Linux.

Allowed values for this property are: “LINUX”, “WINDOWS”, “ALL”

Returns:	The os_family of this CreateScheduledJobDetails.
Return type:	str

package_names¶

Gets the package_names of this CreateScheduledJobDetails. the id of the package (only if operation type is INSTALL/UPDATE/REMOVE)

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

schedule_type¶

[Required] Gets the schedule_type of this CreateScheduledJobDetails. the type of scheduling this Scheduled Job follows

Allowed values for this property are: “ONETIME”, “RECURRING”

Returns:	The schedule_type of this CreateScheduledJobDetails.
Return type:	str

time_next_execution¶

[Required] Gets the time_next_execution of this CreateScheduledJobDetails. the desired time for the next execution of this Scheduled Job

Returns:	The time_next_execution of this CreateScheduledJobDetails.
Return type:	datetime

update_names¶

Gets the update_names of this CreateScheduledJobDetails. 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 CreateScheduledJobDetails.
Return type:	list[str]

update_type¶

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

Allowed values for this property are: “SECURITY”, “BUGFIX”, “ENHANCEMENT”, “OTHER”, “KSPLICE”, “ALL”

Returns:	The update_type of this CreateScheduledJobDetails.
Return type:	str