CreateAccelerationTaskDetails

class oci.log_analytics.models.CreateAccelerationTaskDetails(**kwargs)

Bases: CreateScheduledTaskDetails

Details for creating a scheduled task to accelerate a saved search. The client must specify the savedSearchId, and the service will supply other details. The resulting scheduled task will have TaskType ACCELERATION.

Attributes:

KIND_ACCELERATION

A constant which can be used with the kind property of a CreateScheduledTaskDetails.

KIND_STANDARD

A constant which can be used with the kind property of a CreateScheduledTaskDetails.

compartment_id

[Required] Gets the compartment_id of this CreateScheduledTaskDetails.

defined_tags

Gets the defined_tags of this CreateScheduledTaskDetails.

description

Gets the description 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.

saved_search_id

[Required] Gets the saved_search_id of this CreateAccelerationTaskDetails.

Methods:

__init__(**kwargs)

Initializes a new CreateAccelerationTaskDetails 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'

A constant which can be used with the kind property of a CreateScheduledTaskDetails. This constant has a value of “ACCELERATION”

KIND_STANDARD = 'STANDARD'

A constant which can be used with the kind property of a CreateScheduledTaskDetails. This constant has a value of “STANDARD”

__init__(**kwargs)

Initializes a new CreateAccelerationTaskDetails object with values from keyword arguments. The default value of the kind attribute of this class is ACCELERATION 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 CreateAccelerationTaskDetails. Allowed values for this property are: “ACCELERATION”, “STANDARD”

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

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

  • description (str) – The value to assign to the description property of this CreateAccelerationTaskDetails.

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

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

  • saved_search_id (str) – The value to assign to the saved_search_id property of this CreateAccelerationTaskDetails.

property compartment_id

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

Returns

The compartment_id of this CreateScheduledTaskDetails.

Return type

str

property 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))

property description

Gets the description of this CreateScheduledTaskDetails. Description for this resource.

Returns

The description of this CreateScheduledTaskDetails.

Return type

str

property 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

property 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.

property 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

property saved_search_id

[Required] Gets the saved_search_id of this CreateAccelerationTaskDetails. The ManagementSavedSearch id [OCID] to be accelerated.

Returns

The saved_search_id of this CreateAccelerationTaskDetails.

Return type

str