LogAnalyticsEntitySummary

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

Bases: object

Summary of a log analytics entity.

Attributes:

LIFECYCLE_STATE_ACTIVE

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

LIFECYCLE_STATE_DELETED

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

are_logs_collected

Gets the are_logs_collected of this LogAnalyticsEntitySummary.

associated_sources_count

Gets the associated_sources_count of this LogAnalyticsEntitySummary.

cloud_resource_id

Gets the cloud_resource_id of this LogAnalyticsEntitySummary.

compartment_id

[Required] Gets the compartment_id of this LogAnalyticsEntitySummary.

creation_source

Gets the creation_source of this LogAnalyticsEntitySummary.

defined_tags

Gets the defined_tags of this LogAnalyticsEntitySummary.

entity_type_internal_name

[Required] Gets the entity_type_internal_name of this LogAnalyticsEntitySummary.

entity_type_name

[Required] Gets the entity_type_name of this LogAnalyticsEntitySummary.

freeform_tags

Gets the freeform_tags of this LogAnalyticsEntitySummary.

id

[Required] Gets the id of this LogAnalyticsEntitySummary.

lifecycle_details

[Required] Gets the lifecycle_details of this LogAnalyticsEntitySummary.

lifecycle_state

[Required] Gets the lifecycle_state of this LogAnalyticsEntitySummary.

management_agent_id

Gets the management_agent_id of this LogAnalyticsEntitySummary.

metadata

Gets the metadata of this LogAnalyticsEntitySummary.

name

[Required] Gets the name of this LogAnalyticsEntitySummary.

source_id

Gets the source_id of this LogAnalyticsEntitySummary.

time_created

[Required] Gets the time_created of this LogAnalyticsEntitySummary.

time_last_discovered

Gets the time_last_discovered of this LogAnalyticsEntitySummary.

time_updated

[Required] Gets the time_updated of this LogAnalyticsEntitySummary.

timezone_region

Gets the timezone_region of this LogAnalyticsEntitySummary.

Methods:

__init__(**kwargs)

Initializes a new LogAnalyticsEntitySummary object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

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

LIFECYCLE_STATE_DELETED = 'DELETED'

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

__init__(**kwargs)

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

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

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

  • entity_type_name (str) – The value to assign to the entity_type_name property of this LogAnalyticsEntitySummary.

  • entity_type_internal_name (str) – The value to assign to the entity_type_internal_name property of this LogAnalyticsEntitySummary.

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

  • management_agent_id (str) – The value to assign to the management_agent_id property of this LogAnalyticsEntitySummary.

  • cloud_resource_id (str) – The value to assign to the cloud_resource_id property of this LogAnalyticsEntitySummary.

  • timezone_region (str) – The value to assign to the timezone_region property of this LogAnalyticsEntitySummary.

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

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

  • time_last_discovered (datetime) – The value to assign to the time_last_discovered property of this LogAnalyticsEntitySummary.

  • metadata (oci.log_analytics.models.LogAnalyticsMetadataCollection) – The value to assign to the metadata property of this LogAnalyticsEntitySummary.

  • are_logs_collected (bool) – The value to assign to the are_logs_collected property of this LogAnalyticsEntitySummary.

  • source_id (str) – The value to assign to the source_id property of this LogAnalyticsEntitySummary.

  • creation_source (oci.log_analytics.models.CreationSource) – The value to assign to the creation_source property of this LogAnalyticsEntitySummary.

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

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

  • associated_sources_count (int) – The value to assign to the associated_sources_count property of this LogAnalyticsEntitySummary.

property are_logs_collected

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

Returns

The are_logs_collected of this LogAnalyticsEntitySummary.

Return type

bool

property associated_sources_count

Gets the associated_sources_count of this LogAnalyticsEntitySummary. The count of associated log sources for a given log analytics entity.

Returns

The associated_sources_count of this LogAnalyticsEntitySummary.

Return type

int

property cloud_resource_id

Gets the cloud_resource_id of this LogAnalyticsEntitySummary. 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 LogAnalyticsEntitySummary.

Return type

str

property compartment_id

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

Returns

The compartment_id of this LogAnalyticsEntitySummary.

Return type

str

property creation_source

Gets the creation_source of this LogAnalyticsEntitySummary.

Returns

The creation_source of this LogAnalyticsEntitySummary.

Return type

oci.log_analytics.models.CreationSource

property defined_tags

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

Return type

dict(str, dict(str, object))

property entity_type_internal_name

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

Returns

The entity_type_internal_name of this LogAnalyticsEntitySummary.

Return type

str

property entity_type_name

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

Returns

The entity_type_name of this LogAnalyticsEntitySummary.

Return type

str

property freeform_tags

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

Return type

dict(str, str)

property id

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

Return type

str

property lifecycle_details

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

Returns

The lifecycle_details of this LogAnalyticsEntitySummary.

Return type

str

property lifecycle_state

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

Return type

str

property management_agent_id

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

Returns

The management_agent_id of this LogAnalyticsEntitySummary.

Return type

str

property metadata

Gets the metadata of this LogAnalyticsEntitySummary.

Returns

The metadata of this LogAnalyticsEntitySummary.

Return type

oci.log_analytics.models.LogAnalyticsMetadataCollection

property name

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

Returns

The name of this LogAnalyticsEntitySummary.

Return type

str

property source_id

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

Returns

The source_id of this LogAnalyticsEntitySummary.

Return type

str

property time_created

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

Returns

The time_created of this LogAnalyticsEntitySummary.

Return type

datetime

property time_last_discovered

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

Returns

The time_last_discovered of this LogAnalyticsEntitySummary.

Return type

datetime

property time_updated

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

Returns

The time_updated of this LogAnalyticsEntitySummary.

Return type

datetime

property timezone_region

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

Returns

The timezone_region of this LogAnalyticsEntitySummary.

Return type

str