CreateStandardTaskDetails¶

class oci.log_analytics.models.CreateStandardTaskDetails(**kwargs)¶

Bases: oci.log_analytics.models.create_scheduled_task_details.CreateScheduledTaskDetails

Details for creating a scheduled task. The client must fully specify the details. Not supported for TaskType ACCELERATION.

Attributes

`KIND_ACCELERATION`	str(object=’’) -> str
`KIND_STANDARD`	str(object=’’) -> str
`TASK_TYPE_ACCELERATION`	A constant which can be used with the task_type property of a CreateStandardTaskDetails.
`TASK_TYPE_PURGE`	A constant which can be used with the task_type property of a CreateStandardTaskDetails.
`TASK_TYPE_SAVED_SEARCH`	A constant which can be used with the task_type property of a CreateStandardTaskDetails.
`action`	[Required] Gets the action of this CreateStandardTaskDetails.
`compartment_id`	[Required] Gets the compartment_id of this CreateScheduledTaskDetails.
`defined_tags`	Gets the defined_tags of this CreateScheduledTaskDetails.
`display_name`	Gets the display_name of this CreateScheduledTaskDetails.
`freeform_tags`	Gets the freeform_tags of this CreateScheduledTaskDetails.
`kind`	[Required] Gets the kind of this CreateScheduledTaskDetails.
`schedules`	[Required] Gets the schedules of this CreateStandardTaskDetails.
`task_type`	[Required] Gets the task_type of this CreateStandardTaskDetails.

Methods

`__init__`(**kwargs)	Initializes a new CreateStandardTaskDetails object with values from keyword arguments.
`get_subtype`(object_dictionary)	Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

KIND_ACCELERATION = 'ACCELERATION'¶

KIND_STANDARD = 'STANDARD'¶

TASK_TYPE_ACCELERATION = 'ACCELERATION'¶: A constant which can be used with the task_type property of a CreateStandardTaskDetails. This constant has a value of “ACCELERATION”

TASK_TYPE_PURGE = 'PURGE'¶: A constant which can be used with the task_type property of a CreateStandardTaskDetails. This constant has a value of “PURGE”

TASK_TYPE_SAVED_SEARCH = 'SAVED_SEARCH'¶: A constant which can be used with the task_type property of a CreateStandardTaskDetails. This constant has a value of “SAVED_SEARCH”

__init__(**kwargs)¶

Initializes a new CreateStandardTaskDetails object with values from keyword arguments. The default value of the kind attribute of this class is STANDARD and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

kind (str) – The value to assign to the kind property of this CreateStandardTaskDetails. Allowed values for this property are: “ACCELERATION”, “STANDARD”
compartment_id (str) – The value to assign to the compartment_id property of this CreateStandardTaskDetails.
display_name (str) – The value to assign to the display_name property of this CreateStandardTaskDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateStandardTaskDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateStandardTaskDetails.
task_type (str) – The value to assign to the task_type property of this CreateStandardTaskDetails. Allowed values for this property are: “SAVED_SEARCH”, “ACCELERATION”, “PURGE”
schedules (list[oci.log_analytics.models.Schedule]) – The value to assign to the schedules property of this CreateStandardTaskDetails.
action (oci.log_analytics.models.Action) – The value to assign to the action property of this CreateStandardTaskDetails.

action¶

[Required] Gets the action of this CreateStandardTaskDetails.

Returns:	The action of this CreateStandardTaskDetails.
Return type:	oci.log_analytics.models.Action

compartment_id¶

[Required] Gets the compartment_id of this CreateScheduledTaskDetails. Compartment Identifier OCID].

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

defined_tags¶

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

display_name¶

Gets the display_name of this CreateScheduledTaskDetails. A user-friendly name that is changeable and that does not have to be unique. Format: a leading alphanumeric, followed by zero or more alphanumerics, underscores, spaces, backslashes, or hyphens in any order). No trailing spaces allowed.

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

freeform_tags¶

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

static get_subtype(object_dictionary)¶: Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

kind¶

[Required] Gets the kind of this CreateScheduledTaskDetails. Discriminator.

Allowed values for this property are: “ACCELERATION”, “STANDARD”

Returns:	The kind of this CreateScheduledTaskDetails.
Return type:	str

schedules¶

[Required] Gets the schedules of this CreateStandardTaskDetails. Schedules, typically a single schedule. Note there may only be a single schedule for SAVED_SEARCH and PURGE scheduled tasks.

Returns:	The schedules of this CreateStandardTaskDetails.
Return type:	list[oci.log_analytics.models.Schedule]

task_type¶

[Required] Gets the task_type of this CreateStandardTaskDetails. Task type.

Allowed values for this property are: “SAVED_SEARCH”, “ACCELERATION”, “PURGE”

Returns:	The task_type of this CreateStandardTaskDetails.
Return type:	str