LogAnalyticsTemplateSummary

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

Bases: object

Summary of a template object.

Attributes:

LIFECYCLE_STATE_ACTIVE

A constant which can be used with the lifecycle_state property of a LogAnalyticsTemplateSummary.

LIFECYCLE_STATE_DELETED

A constant which can be used with the lifecycle_state property of a LogAnalyticsTemplateSummary.

compartment_id

[Required] Gets the compartment_id of this LogAnalyticsTemplateSummary.

defined_tags

Gets the defined_tags of this LogAnalyticsTemplateSummary.

description

Gets the description of this LogAnalyticsTemplateSummary.

facets

Gets the facets of this LogAnalyticsTemplateSummary.

freeform_tags

Gets the freeform_tags of this LogAnalyticsTemplateSummary.

id

[Required] Gets the id of this LogAnalyticsTemplateSummary.

is_system

Gets the is_system of this LogAnalyticsTemplateSummary.

lifecycle_state

[Required] Gets the lifecycle_state of this LogAnalyticsTemplateSummary.

name

[Required] Gets the name of this LogAnalyticsTemplateSummary.

time_created

[Required] Gets the time_created of this LogAnalyticsTemplateSummary.

time_updated

Gets the time_updated of this LogAnalyticsTemplateSummary.

type

Gets the type of this LogAnalyticsTemplateSummary.

Methods:

__init__(**kwargs)

Initializes a new LogAnalyticsTemplateSummary object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

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

LIFECYCLE_STATE_DELETED = 'DELETED'

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

__init__(**kwargs)

Initializes a new LogAnalyticsTemplateSummary 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 LogAnalyticsTemplateSummary.

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

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

  • time_created (datetime) – The value to assign to the time_created property of this LogAnalyticsTemplateSummary.

  • time_updated (datetime) – The value to assign to the time_updated property of this LogAnalyticsTemplateSummary.

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

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

  • name (str) – The value to assign to the name property of this LogAnalyticsTemplateSummary.

  • type (str) – The value to assign to the type property of this LogAnalyticsTemplateSummary.

  • is_system (bool) – The value to assign to the is_system property of this LogAnalyticsTemplateSummary.

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this LogAnalyticsTemplateSummary. 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 LogAnalyticsTemplateSummary.

property compartment_id

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

Returns

The compartment_id of this LogAnalyticsTemplateSummary.

Return type

str

property defined_tags

Gets the defined_tags of this LogAnalyticsTemplateSummary. 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 LogAnalyticsTemplateSummary.

Return type

dict(str, dict(str, object))

property description

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

Returns

The description of this LogAnalyticsTemplateSummary.

Return type

str

property facets

Gets the facets of this LogAnalyticsTemplateSummary. Facets of the template

Returns

The facets of this LogAnalyticsTemplateSummary.

Return type

list[oci.log_analytics.models.TemplateFacet]

property freeform_tags

Gets the freeform_tags of this LogAnalyticsTemplateSummary. 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 LogAnalyticsTemplateSummary.

Return type

dict(str, str)

property id

[Required] Gets the id of this LogAnalyticsTemplateSummary. 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 LogAnalyticsTemplateSummary.

Return type

str

property is_system

Gets the is_system of this LogAnalyticsTemplateSummary. 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 LogAnalyticsTemplateSummary.

Return type

bool

property lifecycle_state

[Required] Gets the lifecycle_state of this LogAnalyticsTemplateSummary. 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 LogAnalyticsTemplateSummary.

Return type

str

property name

[Required] Gets the name of this LogAnalyticsTemplateSummary. The template name.

Returns

The name of this LogAnalyticsTemplateSummary.

Return type

str

property time_created

[Required] Gets the time_created of this LogAnalyticsTemplateSummary. The date and time the resource was created, in the format defined by RFC3339.

Returns

The time_created of this LogAnalyticsTemplateSummary.

Return type

datetime

property time_updated

Gets the time_updated of this LogAnalyticsTemplateSummary. The date and time the resource was last updated, in the format defined by RFC3339.

Returns

The time_updated of this LogAnalyticsTemplateSummary.

Return type

datetime

property type

Gets the type of this LogAnalyticsTemplateSummary. The template type.

Returns

The type of this LogAnalyticsTemplateSummary.

Return type

str