LogAnalyticsObjectCollectionRuleSummary¶
- class oci.log_analytics.models.LogAnalyticsObjectCollectionRuleSummary(**kwargs)¶
Bases:
objectThe summary of an Object Storage based collection rule.
Attributes:
A constant which can be used with the collection_type property of a LogAnalyticsObjectCollectionRuleSummary.
A constant which can be used with the collection_type property of a LogAnalyticsObjectCollectionRuleSummary.
A constant which can be used with the collection_type property of a LogAnalyticsObjectCollectionRuleSummary.
A constant which can be used with the lifecycle_state property of a LogAnalyticsObjectCollectionRuleSummary.
A constant which can be used with the lifecycle_state property of a LogAnalyticsObjectCollectionRuleSummary.
A constant which can be used with the lifecycle_state property of a LogAnalyticsObjectCollectionRuleSummary.
A constant which can be used with the log_type property of a LogAnalyticsObjectCollectionRuleSummary.
A constant which can be used with the log_type property of a LogAnalyticsObjectCollectionRuleSummary.
[Required] Gets the collection_type of this LogAnalyticsObjectCollectionRuleSummary.
[Required] Gets the compartment_id of this LogAnalyticsObjectCollectionRuleSummary.
Gets the defined_tags of this LogAnalyticsObjectCollectionRuleSummary.
Gets the description of this LogAnalyticsObjectCollectionRuleSummary.
Gets the freeform_tags of this LogAnalyticsObjectCollectionRuleSummary.
[Required] Gets the id of this LogAnalyticsObjectCollectionRuleSummary.
[Required] Gets the is_enabled of this LogAnalyticsObjectCollectionRuleSummary.
Gets the lifecycle_details of this LogAnalyticsObjectCollectionRuleSummary.
[Required] Gets the lifecycle_state of this LogAnalyticsObjectCollectionRuleSummary.
Gets the log_type of this LogAnalyticsObjectCollectionRuleSummary.
[Required] Gets the name of this LogAnalyticsObjectCollectionRuleSummary.
Gets the object_name_filters of this LogAnalyticsObjectCollectionRuleSummary.
[Required] Gets the os_bucket_name of this LogAnalyticsObjectCollectionRuleSummary.
[Required] Gets the os_namespace of this LogAnalyticsObjectCollectionRuleSummary.
Gets the stream_id of this LogAnalyticsObjectCollectionRuleSummary.
[Required] Gets the time_created of this LogAnalyticsObjectCollectionRuleSummary.
[Required] Gets the time_updated of this LogAnalyticsObjectCollectionRuleSummary.
Methods:
__init__(**kwargs)Initializes a new LogAnalyticsObjectCollectionRuleSummary object with values from keyword arguments.
- COLLECTION_TYPE_HISTORIC = 'HISTORIC'¶
A constant which can be used with the collection_type property of a LogAnalyticsObjectCollectionRuleSummary. This constant has a value of “HISTORIC”
- COLLECTION_TYPE_HISTORIC_LIVE = 'HISTORIC_LIVE'¶
A constant which can be used with the collection_type property of a LogAnalyticsObjectCollectionRuleSummary. This constant has a value of “HISTORIC_LIVE”
- COLLECTION_TYPE_LIVE = 'LIVE'¶
A constant which can be used with the collection_type property of a LogAnalyticsObjectCollectionRuleSummary. This constant has a value of “LIVE”
- LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶
A constant which can be used with the lifecycle_state property of a LogAnalyticsObjectCollectionRuleSummary. This constant has a value of “ACTIVE”
- LIFECYCLE_STATE_DELETED = 'DELETED'¶
A constant which can be used with the lifecycle_state property of a LogAnalyticsObjectCollectionRuleSummary. This constant has a value of “DELETED”
- LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶
A constant which can be used with the lifecycle_state property of a LogAnalyticsObjectCollectionRuleSummary. This constant has a value of “INACTIVE”
- LOG_TYPE_LOG = 'LOG'¶
A constant which can be used with the log_type property of a LogAnalyticsObjectCollectionRuleSummary. This constant has a value of “LOG”
- LOG_TYPE_LOG_EVENTS = 'LOG_EVENTS'¶
A constant which can be used with the log_type property of a LogAnalyticsObjectCollectionRuleSummary. This constant has a value of “LOG_EVENTS”
- __init__(**kwargs)¶
Initializes a new LogAnalyticsObjectCollectionRuleSummary 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 LogAnalyticsObjectCollectionRuleSummary.
name (str) – The value to assign to the name property of this LogAnalyticsObjectCollectionRuleSummary.
description (str) – The value to assign to the description property of this LogAnalyticsObjectCollectionRuleSummary.
compartment_id (str) – The value to assign to the compartment_id property of this LogAnalyticsObjectCollectionRuleSummary.
os_namespace (str) – The value to assign to the os_namespace property of this LogAnalyticsObjectCollectionRuleSummary.
os_bucket_name (str) – The value to assign to the os_bucket_name property of this LogAnalyticsObjectCollectionRuleSummary.
collection_type (str) – The value to assign to the collection_type property of this LogAnalyticsObjectCollectionRuleSummary. Allowed values for this property are: “LIVE”, “HISTORIC”, “HISTORIC_LIVE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this LogAnalyticsObjectCollectionRuleSummary. Allowed values for this property are: “ACTIVE”, “DELETED”, “INACTIVE”, ‘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 LogAnalyticsObjectCollectionRuleSummary.
time_created (datetime) – The value to assign to the time_created property of this LogAnalyticsObjectCollectionRuleSummary.
time_updated (datetime) – The value to assign to the time_updated property of this LogAnalyticsObjectCollectionRuleSummary.
is_enabled (bool) – The value to assign to the is_enabled property of this LogAnalyticsObjectCollectionRuleSummary.
object_name_filters (list[str]) – The value to assign to the object_name_filters property of this LogAnalyticsObjectCollectionRuleSummary.
log_type (str) – The value to assign to the log_type property of this LogAnalyticsObjectCollectionRuleSummary. Allowed values for this property are: “LOG”, “LOG_EVENTS”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
stream_id (str) – The value to assign to the stream_id property of this LogAnalyticsObjectCollectionRuleSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this LogAnalyticsObjectCollectionRuleSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this LogAnalyticsObjectCollectionRuleSummary.
- property collection_type¶
[Required] Gets the collection_type of this LogAnalyticsObjectCollectionRuleSummary. The type of log collection.
Allowed values for this property are: “LIVE”, “HISTORIC”, “HISTORIC_LIVE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The collection_type of this LogAnalyticsObjectCollectionRuleSummary.
- Return type
str
- property compartment_id¶
[Required] Gets the compartment_id of this LogAnalyticsObjectCollectionRuleSummary. The OCID of the compartment to which this rule belongs.
- Returns
The compartment_id of this LogAnalyticsObjectCollectionRuleSummary.
- Return type
str
- property defined_tags¶
Gets the defined_tags of this LogAnalyticsObjectCollectionRuleSummary. 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 LogAnalyticsObjectCollectionRuleSummary.
- Return type
dict(str, dict(str, object))
- property description¶
Gets the description of this LogAnalyticsObjectCollectionRuleSummary. A unique name given to the rule. The name must be unique within the tenancy, and cannot be modified. Avoid entering confidential information.
- Returns
The description of this LogAnalyticsObjectCollectionRuleSummary.
- Return type
str
- property freeform_tags¶
Gets the freeform_tags of this LogAnalyticsObjectCollectionRuleSummary. 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 LogAnalyticsObjectCollectionRuleSummary.
- Return type
dict(str, str)
- property id¶
[Required] Gets the id of this LogAnalyticsObjectCollectionRuleSummary. The OCID of this rule.
- Returns
The id of this LogAnalyticsObjectCollectionRuleSummary.
- Return type
str
- property is_enabled¶
[Required] Gets the is_enabled of this LogAnalyticsObjectCollectionRuleSummary. Whether or not this rule is currently enabled.
- Returns
The is_enabled of this LogAnalyticsObjectCollectionRuleSummary.
- Return type
bool
- property lifecycle_details¶
Gets the lifecycle_details of this LogAnalyticsObjectCollectionRuleSummary. A detailed status of the life cycle state.
- Returns
The lifecycle_details of this LogAnalyticsObjectCollectionRuleSummary.
- Return type
str
- property lifecycle_state¶
[Required] Gets the lifecycle_state of this LogAnalyticsObjectCollectionRuleSummary. The current state of the rule.
Allowed values for this property are: “ACTIVE”, “DELETED”, “INACTIVE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The lifecycle_state of this LogAnalyticsObjectCollectionRuleSummary.
- Return type
str
- property log_type¶
Gets the log_type of this LogAnalyticsObjectCollectionRuleSummary. Type of files/objects in this object collection rule.
Allowed values for this property are: “LOG”, “LOG_EVENTS”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The log_type of this LogAnalyticsObjectCollectionRuleSummary.
- Return type
str
- property name¶
[Required] Gets the name of this LogAnalyticsObjectCollectionRuleSummary. A unique name to the rule. The name must be unique, within the tenancy, and cannot be changed.
- Returns
The name of this LogAnalyticsObjectCollectionRuleSummary.
- Return type
str
- property object_name_filters¶
Gets the object_name_filters of this LogAnalyticsObjectCollectionRuleSummary. When the filters are provided, only the objects matching the filters are picked up for processing. The matchType supported is exact match and accommodates wildcard “*”. For more information on filters, see Event Filters.
- Returns
The object_name_filters of this LogAnalyticsObjectCollectionRuleSummary.
- Return type
list[str]
- property os_bucket_name¶
[Required] Gets the os_bucket_name of this LogAnalyticsObjectCollectionRuleSummary. Name of the Object Storage bucket.
- Returns
The os_bucket_name of this LogAnalyticsObjectCollectionRuleSummary.
- Return type
str
- property os_namespace¶
[Required] Gets the os_namespace of this LogAnalyticsObjectCollectionRuleSummary. Object Storage namespace.
- Returns
The os_namespace of this LogAnalyticsObjectCollectionRuleSummary.
- Return type
str
- property stream_id¶
Gets the stream_id of this LogAnalyticsObjectCollectionRuleSummary. A Stream OCID is required for Object Collection rules of type LIVE or HISTORIC_LIVE, which will be used by Log Analytics while creating Event Rule and consume the event notifications created by the Object Storage.
- Returns
The stream_id of this LogAnalyticsObjectCollectionRuleSummary.
- Return type
str
- property time_created¶
[Required] Gets the time_created of this LogAnalyticsObjectCollectionRuleSummary. The time when this rule was created. An RFC3339 formatted datetime string.
- Returns
The time_created of this LogAnalyticsObjectCollectionRuleSummary.
- Return type
datetime
- property time_updated¶
[Required] Gets the time_updated of this LogAnalyticsObjectCollectionRuleSummary. The time when this rule was last updated. An RFC3339 formatted datetime string.
- Returns
The time_updated of this LogAnalyticsObjectCollectionRuleSummary.
- Return type
datetime