LogAnalyticsEntity¶

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

Bases: object

Description of a log analytics entity.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a LogAnalyticsEntity.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a LogAnalyticsEntity.
`are_logs_collected`	Gets the are_logs_collected of this LogAnalyticsEntity.
`cloud_resource_id`	Gets the cloud_resource_id of this LogAnalyticsEntity.
`compartment_id`	[Required] Gets the compartment_id of this LogAnalyticsEntity.
`creation_source`	Gets the creation_source of this LogAnalyticsEntity.
`defined_tags`	Gets the defined_tags of this LogAnalyticsEntity.
`entity_type_internal_name`	[Required] Gets the entity_type_internal_name of this LogAnalyticsEntity.
`entity_type_name`	[Required] Gets the entity_type_name of this LogAnalyticsEntity.
`freeform_tags`	Gets the freeform_tags of this LogAnalyticsEntity.
`hostname`	Gets the hostname of this LogAnalyticsEntity.
`id`	[Required] Gets the id of this LogAnalyticsEntity.
`lifecycle_details`	[Required] Gets the lifecycle_details of this LogAnalyticsEntity.
`lifecycle_state`	[Required] Gets the lifecycle_state of this LogAnalyticsEntity.
`management_agent_compartment_id`	Gets the management_agent_compartment_id of this LogAnalyticsEntity.
`management_agent_display_name`	Gets the management_agent_display_name of this LogAnalyticsEntity.
`management_agent_id`	Gets the management_agent_id of this LogAnalyticsEntity.
`metadata`	Gets the metadata of this LogAnalyticsEntity.
`name`	[Required] Gets the name of this LogAnalyticsEntity.
`properties`	Gets the properties of this LogAnalyticsEntity.
`source_id`	Gets the source_id of this LogAnalyticsEntity.
`time_created`	[Required] Gets the time_created of this LogAnalyticsEntity.
`time_last_discovered`	Gets the time_last_discovered of this LogAnalyticsEntity.
`time_updated`	[Required] Gets the time_updated of this LogAnalyticsEntity.
`timezone_region`	Gets the timezone_region of this LogAnalyticsEntity.

Methods

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

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a LogAnalyticsEntity. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a LogAnalyticsEntity. This constant has a value of “DELETED”

__init__(**kwargs)¶

Initializes a new LogAnalyticsEntity 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 LogAnalyticsEntity.
name (str) – The value to assign to the name property of this LogAnalyticsEntity.
compartment_id (str) – The value to assign to the compartment_id property of this LogAnalyticsEntity.
entity_type_name (str) – The value to assign to the entity_type_name property of this LogAnalyticsEntity.
entity_type_internal_name (str) – The value to assign to the entity_type_internal_name property of this LogAnalyticsEntity.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this LogAnalyticsEntity. 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’.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this LogAnalyticsEntity.
management_agent_id (str) – The value to assign to the management_agent_id property of this LogAnalyticsEntity.
management_agent_display_name (str) – The value to assign to the management_agent_display_name property of this LogAnalyticsEntity.
management_agent_compartment_id (str) – The value to assign to the management_agent_compartment_id property of this LogAnalyticsEntity.
timezone_region (str) – The value to assign to the timezone_region property of this LogAnalyticsEntity.
properties (dict(str, str)) – The value to assign to the properties property of this LogAnalyticsEntity.
creation_source (oci.log_analytics.models.CreationSource) – The value to assign to the creation_source property of this LogAnalyticsEntity.
time_created (datetime) – The value to assign to the time_created property of this LogAnalyticsEntity.
time_updated (datetime) – The value to assign to the time_updated property of this LogAnalyticsEntity.
time_last_discovered (datetime) – The value to assign to the time_last_discovered property of this LogAnalyticsEntity.
metadata (oci.log_analytics.models.LogAnalyticsMetadataSummary) – The value to assign to the metadata property of this LogAnalyticsEntity.
are_logs_collected (bool) – The value to assign to the are_logs_collected property of this LogAnalyticsEntity.
cloud_resource_id (str) – The value to assign to the cloud_resource_id property of this LogAnalyticsEntity.
hostname (str) – The value to assign to the hostname property of this LogAnalyticsEntity.
source_id (str) – The value to assign to the source_id property of this LogAnalyticsEntity.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this LogAnalyticsEntity.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this LogAnalyticsEntity.

are_logs_collected¶

Gets the are_logs_collected of this LogAnalyticsEntity. The Boolean flag to indicate if logs are collected for an entity for log analytics usage.

Returns:	The are_logs_collected of this LogAnalyticsEntity.
Return type:	bool

cloud_resource_id¶

Gets the cloud_resource_id of this LogAnalyticsEntity. The OCID of the Cloud resource which this entity is a representation of. This may be blank when the entity represents a non-cloud resource that the customer may have on their premises.

Returns:	The cloud_resource_id of this LogAnalyticsEntity.
Return type:	str

compartment_id¶

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

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

creation_source¶

Gets the creation_source of this LogAnalyticsEntity.

Returns:	The creation_source of this LogAnalyticsEntity.
Return type:	oci.log_analytics.models.CreationSource

defined_tags¶

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

entity_type_internal_name¶

[Required] Gets the entity_type_internal_name of this LogAnalyticsEntity. Internal name for the log analytics entity type.

Returns:	The entity_type_internal_name of this LogAnalyticsEntity.
Return type:	str

entity_type_name¶

[Required] Gets the entity_type_name of this LogAnalyticsEntity. Log analytics entity type name.

Returns:	The entity_type_name of this LogAnalyticsEntity.
Return type:	str

freeform_tags¶

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

hostname¶

Gets the hostname of this LogAnalyticsEntity. The hostname where the entity represented here is actually present. This would be the output one would get if they run echo $HOSTNAME on Linux or an equivalent OS command. This may be different from management agents host since logs may be collected remotely.

Returns:	The hostname of this LogAnalyticsEntity.
Return type:	str

id¶

[Required] Gets the id of this LogAnalyticsEntity. 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 LogAnalyticsEntity.
Return type:	str

lifecycle_details¶

[Required] Gets the lifecycle_details of this LogAnalyticsEntity. lifecycleDetails has additional information regarding substeps such as management agent plugin deployment.

Returns:	The lifecycle_details of this LogAnalyticsEntity.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this LogAnalyticsEntity. The current state of the log analytics entity.

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 LogAnalyticsEntity.
Return type:	str

management_agent_compartment_id¶

Gets the management_agent_compartment_id of this LogAnalyticsEntity. Management agent (management-agents resource kind) compartment OCID

Returns:	The management_agent_compartment_id of this LogAnalyticsEntity.
Return type:	str

management_agent_display_name¶

Gets the management_agent_display_name of this LogAnalyticsEntity. Management agent (management-agents resource kind) display name

Returns:	The management_agent_display_name of this LogAnalyticsEntity.
Return type:	str

management_agent_id¶

Gets the management_agent_id of this LogAnalyticsEntity. The OCID of the Management Agent.

Returns:	The management_agent_id of this LogAnalyticsEntity.
Return type:	str

metadata¶

Gets the metadata of this LogAnalyticsEntity.

Returns:	The metadata of this LogAnalyticsEntity.
Return type:	oci.log_analytics.models.LogAnalyticsMetadataSummary

name¶

[Required] Gets the name of this LogAnalyticsEntity. Log analytics entity name.

Returns:	The name of this LogAnalyticsEntity.
Return type:	str

properties¶

Gets the properties of this LogAnalyticsEntity. The name/value pairs for parameter values to be used in file patterns specified in log sources.

Returns:	The properties of this LogAnalyticsEntity.
Return type:	dict(str, str)

source_id¶

Gets the source_id of this LogAnalyticsEntity. This indicates the type of source. It is primarily for Enterprise Manager Repository ID.

Returns:	The source_id of this LogAnalyticsEntity.
Return type:	str

time_created¶

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

Returns:	The time_created of this LogAnalyticsEntity.
Return type:	datetime

time_last_discovered¶

Gets the time_last_discovered of this LogAnalyticsEntity. The date and time the resource was last discovered, in the format defined by RFC3339.

Returns:	The time_last_discovered of this LogAnalyticsEntity.
Return type:	datetime

time_updated¶

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

Returns:	The time_updated of this LogAnalyticsEntity.
Return type:	datetime

timezone_region¶

Gets the timezone_region of this LogAnalyticsEntity. The timezone region of the log analytics entity.

Returns:	The timezone_region of this LogAnalyticsEntity.
Return type:	str