LogAnalyticsTemplate¶
- class oci.log_analytics.models.LogAnalyticsTemplate(**kwargs)¶
Bases:
objectA template object.
Attributes:
A constant which can be used with the lifecycle_state property of a LogAnalyticsTemplate.
A constant which can be used with the lifecycle_state property of a LogAnalyticsTemplate.
[Required] Gets the compartment_id of this LogAnalyticsTemplate.
Gets the content of this LogAnalyticsTemplate.
Gets the content_format of this LogAnalyticsTemplate.
Gets the defined_tags of this LogAnalyticsTemplate.
Gets the description of this LogAnalyticsTemplate.
Gets the facets of this LogAnalyticsTemplate.
Gets the freeform_tags of this LogAnalyticsTemplate.
[Required] Gets the id of this LogAnalyticsTemplate.
Gets the is_system of this LogAnalyticsTemplate.
[Required] Gets the lifecycle_state of this LogAnalyticsTemplate.
[Required] Gets the name of this LogAnalyticsTemplate.
Gets the parameters of this LogAnalyticsTemplate.
Gets the parameters_format of this LogAnalyticsTemplate.
Gets the parameters_metadata of this LogAnalyticsTemplate.
[Required] Gets the time_created of this LogAnalyticsTemplate.
Gets the time_updated of this LogAnalyticsTemplate.
Gets the type of this LogAnalyticsTemplate.
Methods:
__init__(**kwargs)Initializes a new LogAnalyticsTemplate object with values from keyword arguments.
- LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶
A constant which can be used with the lifecycle_state property of a LogAnalyticsTemplate. This constant has a value of “ACTIVE”
- LIFECYCLE_STATE_DELETED = 'DELETED'¶
A constant which can be used with the lifecycle_state property of a LogAnalyticsTemplate. This constant has a value of “DELETED”
- __init__(**kwargs)¶
Initializes a new LogAnalyticsTemplate 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 LogAnalyticsTemplate.
description (str) – The value to assign to the description property of this LogAnalyticsTemplate.
compartment_id (str) – The value to assign to the compartment_id property of this LogAnalyticsTemplate.
time_created (datetime) – The value to assign to the time_created property of this LogAnalyticsTemplate.
time_updated (datetime) – The value to assign to the time_updated property of this LogAnalyticsTemplate.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this LogAnalyticsTemplate.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this LogAnalyticsTemplate.
name (str) – The value to assign to the name property of this LogAnalyticsTemplate.
type (str) – The value to assign to the type property of this LogAnalyticsTemplate.
is_system (bool) – The value to assign to the is_system property of this LogAnalyticsTemplate.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this LogAnalyticsTemplate. Allowed values for this property are: “ACTIVE”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
facets (list[oci.log_analytics.models.TemplateFacet]) – The value to assign to the facets property of this LogAnalyticsTemplate.
content (str) – The value to assign to the content property of this LogAnalyticsTemplate.
content_format (str) – The value to assign to the content_format property of this LogAnalyticsTemplate.
parameters (str) – The value to assign to the parameters property of this LogAnalyticsTemplate.
parameters_format (str) – The value to assign to the parameters_format property of this LogAnalyticsTemplate.
parameters_metadata (str) – The value to assign to the parameters_metadata property of this LogAnalyticsTemplate.
- property compartment_id¶
[Required] Gets the compartment_id of this LogAnalyticsTemplate. Compartment Identifier OCID].
- Returns
The compartment_id of this LogAnalyticsTemplate.
- Return type
str
- property content¶
Gets the content of this LogAnalyticsTemplate. Base64 encoded template content.
- Returns
The content of this LogAnalyticsTemplate.
- Return type
str
- property content_format¶
Gets the content_format of this LogAnalyticsTemplate. Content format. For example - XML.
- Returns
The content_format of this LogAnalyticsTemplate.
- Return type
str
- property defined_tags¶
Gets the defined_tags of this LogAnalyticsTemplate. 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 LogAnalyticsTemplate.
- Return type
dict(str, dict(str, object))
- property description¶
Gets the description of this LogAnalyticsTemplate. Description for this resource.
- Returns
The description of this LogAnalyticsTemplate.
- Return type
str
- property facets¶
Gets the facets of this LogAnalyticsTemplate. Facets of the template
- Returns
The facets of this LogAnalyticsTemplate.
- Return type
- property freeform_tags¶
Gets the freeform_tags of this LogAnalyticsTemplate. 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 LogAnalyticsTemplate.
- Return type
dict(str, str)
- property id¶
[Required] Gets the id of this LogAnalyticsTemplate. The log analytics entity OCID. This ID is a reference used by log analytics features and it represents a resource that is provisioned and managed by the customer on their premises or on the cloud.
- Returns
The id of this LogAnalyticsTemplate.
- Return type
str
- property is_system¶
Gets the is_system of this LogAnalyticsTemplate. The system flag. A value of false denotes a custom, or user defined object. A value of true denotes a built in object.
- Returns
The is_system of this LogAnalyticsTemplate.
- Return type
bool
- property lifecycle_state¶
[Required] Gets the lifecycle_state of this LogAnalyticsTemplate. The current state of the template.
Allowed values for this property are: “ACTIVE”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The lifecycle_state of this LogAnalyticsTemplate.
- Return type
str
- property name¶
[Required] Gets the name of this LogAnalyticsTemplate. The template name.
- Returns
The name of this LogAnalyticsTemplate.
- Return type
str
- property parameters¶
Gets the parameters of this LogAnalyticsTemplate. Base64 encoded template parameters.
- Returns
The parameters of this LogAnalyticsTemplate.
- Return type
str
- property parameters_format¶
Gets the parameters_format of this LogAnalyticsTemplate. Parameters format. For example - NAME_VALUE_PAIR.
- Returns
The parameters_format of this LogAnalyticsTemplate.
- Return type
str
- property parameters_metadata¶
Gets the parameters_metadata of this LogAnalyticsTemplate. Base64 encoded parameters metadata definition.
- Returns
The parameters_metadata of this LogAnalyticsTemplate.
- Return type
str
- property time_created¶
[Required] Gets the time_created of this LogAnalyticsTemplate. The date and time the resource was created, in the format defined by RFC3339.
- Returns
The time_created of this LogAnalyticsTemplate.
- Return type
datetime
- property time_updated¶
Gets the time_updated of this LogAnalyticsTemplate. The date and time the resource was last updated, in the format defined by RFC3339.
- Returns
The time_updated of this LogAnalyticsTemplate.
- Return type
datetime
- property type¶
Gets the type of this LogAnalyticsTemplate. The template type.
- Returns
The type of this LogAnalyticsTemplate.
- Return type
str