LogAnalyticsObjectCollectionRule¶

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

Bases: object

The configuration details of an Object Storage based collection rule.

Attributes

`COLLECTION_TYPE_HISTORIC`	A constant which can be used with the collection_type property of a LogAnalyticsObjectCollectionRule.
`COLLECTION_TYPE_HISTORIC_LIVE`	A constant which can be used with the collection_type property of a LogAnalyticsObjectCollectionRule.
`COLLECTION_TYPE_LIVE`	A constant which can be used with the collection_type property of a LogAnalyticsObjectCollectionRule.
`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a LogAnalyticsObjectCollectionRule.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a LogAnalyticsObjectCollectionRule.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a LogAnalyticsObjectCollectionRule.
`LOG_SET_KEY_OBJECT_PATH`	A constant which can be used with the log_set_key property of a LogAnalyticsObjectCollectionRule.
`LOG_TYPE_LOG`	A constant which can be used with the log_type property of a LogAnalyticsObjectCollectionRule.
`LOG_TYPE_LOG_EVENTS`	A constant which can be used with the log_type property of a LogAnalyticsObjectCollectionRule.
`char_encoding`	Gets the char_encoding of this LogAnalyticsObjectCollectionRule.
`collection_type`	[Required] Gets the collection_type of this LogAnalyticsObjectCollectionRule.
`compartment_id`	[Required] Gets the compartment_id of this LogAnalyticsObjectCollectionRule.
`defined_tags`	Gets the defined_tags of this LogAnalyticsObjectCollectionRule.
`description`	Gets the description of this LogAnalyticsObjectCollectionRule.
`entity_id`	Gets the entity_id of this LogAnalyticsObjectCollectionRule.
`freeform_tags`	Gets the freeform_tags of this LogAnalyticsObjectCollectionRule.
`id`	[Required] Gets the id of this LogAnalyticsObjectCollectionRule.
`is_enabled`	[Required] Gets the is_enabled of this LogAnalyticsObjectCollectionRule.
`is_force_historic_collection`	Gets the is_force_historic_collection of this LogAnalyticsObjectCollectionRule.
`lifecycle_details`	Gets the lifecycle_details of this LogAnalyticsObjectCollectionRule.
`lifecycle_state`	[Required] Gets the lifecycle_state of this LogAnalyticsObjectCollectionRule.
`log_group_id`	[Required] Gets the log_group_id of this LogAnalyticsObjectCollectionRule.
`log_set`	Gets the log_set of this LogAnalyticsObjectCollectionRule.
`log_set_ext_regex`	Gets the log_set_ext_regex of this LogAnalyticsObjectCollectionRule.
`log_set_key`	Gets the log_set_key of this LogAnalyticsObjectCollectionRule.
`log_source_name`	[Required] Gets the log_source_name of this LogAnalyticsObjectCollectionRule.
`log_type`	Gets the log_type of this LogAnalyticsObjectCollectionRule.
`name`	[Required] Gets the name of this LogAnalyticsObjectCollectionRule.
`object_name_filters`	Gets the object_name_filters of this LogAnalyticsObjectCollectionRule.
`os_bucket_name`	[Required] Gets the os_bucket_name of this LogAnalyticsObjectCollectionRule.
`os_namespace`	[Required] Gets the os_namespace of this LogAnalyticsObjectCollectionRule.
`overrides`	Gets the overrides of this LogAnalyticsObjectCollectionRule.
`poll_since`	[Required] Gets the poll_since of this LogAnalyticsObjectCollectionRule.
`poll_till`	Gets the poll_till of this LogAnalyticsObjectCollectionRule.
`time_created`	[Required] Gets the time_created of this LogAnalyticsObjectCollectionRule.
`time_updated`	[Required] Gets the time_updated of this LogAnalyticsObjectCollectionRule.
`timezone`	Gets the timezone of this LogAnalyticsObjectCollectionRule.

Methods

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

COLLECTION_TYPE_HISTORIC = 'HISTORIC'¶: A constant which can be used with the collection_type property of a LogAnalyticsObjectCollectionRule. 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 LogAnalyticsObjectCollectionRule. 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 LogAnalyticsObjectCollectionRule. This constant has a value of “LIVE”

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

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

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶: A constant which can be used with the lifecycle_state property of a LogAnalyticsObjectCollectionRule. This constant has a value of “INACTIVE”

LOG_SET_KEY_OBJECT_PATH = 'OBJECT_PATH'¶: A constant which can be used with the log_set_key property of a LogAnalyticsObjectCollectionRule. This constant has a value of “OBJECT_PATH”

LOG_TYPE_LOG = 'LOG'¶: A constant which can be used with the log_type property of a LogAnalyticsObjectCollectionRule. 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 LogAnalyticsObjectCollectionRule. This constant has a value of “LOG_EVENTS”

__init__(**kwargs)¶

Initializes a new LogAnalyticsObjectCollectionRule 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 LogAnalyticsObjectCollectionRule.
name (str) – The value to assign to the name property of this LogAnalyticsObjectCollectionRule.
description (str) – The value to assign to the description property of this LogAnalyticsObjectCollectionRule.
compartment_id (str) – The value to assign to the compartment_id property of this LogAnalyticsObjectCollectionRule.
os_namespace (str) – The value to assign to the os_namespace property of this LogAnalyticsObjectCollectionRule.
os_bucket_name (str) – The value to assign to the os_bucket_name property of this LogAnalyticsObjectCollectionRule.
collection_type (str) – The value to assign to the collection_type property of this LogAnalyticsObjectCollectionRule. 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’.
poll_since (str) – The value to assign to the poll_since property of this LogAnalyticsObjectCollectionRule.
poll_till (str) – The value to assign to the poll_till property of this LogAnalyticsObjectCollectionRule.
log_group_id (str) – The value to assign to the log_group_id property of this LogAnalyticsObjectCollectionRule.
log_source_name (str) – The value to assign to the log_source_name property of this LogAnalyticsObjectCollectionRule.
entity_id (str) – The value to assign to the entity_id property of this LogAnalyticsObjectCollectionRule.
char_encoding (str) – The value to assign to the char_encoding property of this LogAnalyticsObjectCollectionRule.
timezone (str) – The value to assign to the timezone property of this LogAnalyticsObjectCollectionRule.
log_set (str) – The value to assign to the log_set property of this LogAnalyticsObjectCollectionRule.
log_set_key (str) – The value to assign to the log_set_key property of this LogAnalyticsObjectCollectionRule. Allowed values for this property are: “OBJECT_PATH”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
log_set_ext_regex (str) – The value to assign to the log_set_ext_regex property of this LogAnalyticsObjectCollectionRule.
overrides (dict(str, list[PropertyOverride])) – The value to assign to the overrides property of this LogAnalyticsObjectCollectionRule.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this LogAnalyticsObjectCollectionRule. 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 LogAnalyticsObjectCollectionRule.
time_created (datetime) – The value to assign to the time_created property of this LogAnalyticsObjectCollectionRule.
time_updated (datetime) – The value to assign to the time_updated property of this LogAnalyticsObjectCollectionRule.
is_enabled (bool) – The value to assign to the is_enabled property of this LogAnalyticsObjectCollectionRule.
object_name_filters (list[str]) – The value to assign to the object_name_filters property of this LogAnalyticsObjectCollectionRule.
log_type (str) – The value to assign to the log_type property of this LogAnalyticsObjectCollectionRule. 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’.
is_force_historic_collection (bool) – The value to assign to the is_force_historic_collection property of this LogAnalyticsObjectCollectionRule.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this LogAnalyticsObjectCollectionRule.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this LogAnalyticsObjectCollectionRule.

char_encoding¶

Gets the char_encoding of this LogAnalyticsObjectCollectionRule. An optional character encoding to aid in detecting the character encoding of the contents of the objects while processing. It is recommended to set this value as ISO_8859_1 when configuring content of the objects having more numeric characters, and very few alphabets. For e.g. this applies when configuring VCN Flow Logs.

Returns:	The char_encoding of this LogAnalyticsObjectCollectionRule.
Return type:	str

collection_type¶

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

compartment_id¶

[Required] Gets the compartment_id of this LogAnalyticsObjectCollectionRule. The OCID of the compartment to which this rule belongs.

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

defined_tags¶

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

description¶

Gets the description of this LogAnalyticsObjectCollectionRule. A string that describes the details of the rule. It does not have to be unique, and can be changed. Avoid entering confidential information.

Returns:	The description of this LogAnalyticsObjectCollectionRule.
Return type:	str

entity_id¶

Gets the entity_id of this LogAnalyticsObjectCollectionRule. Logging Analytics entity OCID to associate the processed logs with.

Returns:	The entity_id of this LogAnalyticsObjectCollectionRule.
Return type:	str

freeform_tags¶

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

id¶

[Required] Gets the id of this LogAnalyticsObjectCollectionRule. The OCID of this rule.

Returns:	The id of this LogAnalyticsObjectCollectionRule.
Return type:	str

is_enabled¶

[Required] Gets the is_enabled of this LogAnalyticsObjectCollectionRule. Whether or not this rule is currently enabled.

Returns:	The is_enabled of this LogAnalyticsObjectCollectionRule.
Return type:	bool

is_force_historic_collection¶

Gets the is_force_historic_collection of this LogAnalyticsObjectCollectionRule. Flag to allow historic collection if poll period overlaps with existing ACTIVE collection rule

Returns:	The is_force_historic_collection of this LogAnalyticsObjectCollectionRule.
Return type:	bool

lifecycle_details¶

Gets the lifecycle_details of this LogAnalyticsObjectCollectionRule. A detailed status of the life cycle state.

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

lifecycle_state¶

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

log_group_id¶

[Required] Gets the log_group_id of this LogAnalyticsObjectCollectionRule. Logging Analytics Log group OCID to associate the processed logs with.

Returns:	The log_group_id of this LogAnalyticsObjectCollectionRule.
Return type:	str

log_set¶

Gets the log_set of this LogAnalyticsObjectCollectionRule. The logSet to be associated with the processed logs. The logSet feature can be used by customers with high volume of data and this feature has to be enabled for a given tenancy prior to its usage. When logSetExtRegex value is provided, it will take precedence over this logSet value and logSet will be computed dynamically using logSetKey and logSetExtRegex.

Returns:	The log_set of this LogAnalyticsObjectCollectionRule.
Return type:	str

log_set_ext_regex¶

Gets the log_set_ext_regex of this LogAnalyticsObjectCollectionRule. The regex to be applied against given logSetKey. Regex has to be in string escaped format.

Returns:	The log_set_ext_regex of this LogAnalyticsObjectCollectionRule.
Return type:	str

log_set_key¶

Gets the log_set_key of this LogAnalyticsObjectCollectionRule. An optional parameter to indicate from where the logSet to be extracted using logSetExtRegex. Default value is OBJECT_PATH (e.g. /n/<namespace>/b/<bucketname>/o/<objectname>).

Allowed values for this property are: “OBJECT_PATH”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The log_set_key of this LogAnalyticsObjectCollectionRule.
Return type:	str

log_source_name¶

[Required] Gets the log_source_name of this LogAnalyticsObjectCollectionRule. Name of the Logging Analytics Source to use for the processing.

Returns:	The log_source_name of this LogAnalyticsObjectCollectionRule.
Return type:	str

log_type¶

Gets the log_type of this LogAnalyticsObjectCollectionRule. 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 LogAnalyticsObjectCollectionRule.
Return type:	str

name¶

[Required] Gets the name of this LogAnalyticsObjectCollectionRule. A unique name to the rule. The name must be unique, within the tenancy, and cannot be changed.

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

object_name_filters¶

Gets the object_name_filters of this LogAnalyticsObjectCollectionRule. 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 LogAnalyticsObjectCollectionRule.
Return type:	list[str]

os_bucket_name¶

[Required] Gets the os_bucket_name of this LogAnalyticsObjectCollectionRule. Name of the Object Storage bucket.

Returns:	The os_bucket_name of this LogAnalyticsObjectCollectionRule.
Return type:	str

os_namespace¶

[Required] Gets the os_namespace of this LogAnalyticsObjectCollectionRule. Object Storage namespace.

Returns:	The os_namespace of this LogAnalyticsObjectCollectionRule.
Return type:	str

overrides¶

Gets the overrides of this LogAnalyticsObjectCollectionRule. Use this to override some property values which are defined at bucket level to the scope of object. Supported propeties for override are: logSourceName, charEncoding, entityId. Supported matchType for override are “contains”.

Returns:	The overrides of this LogAnalyticsObjectCollectionRule.
Return type:	dict(str, list[PropertyOverride])

poll_since¶

[Required] Gets the poll_since of this LogAnalyticsObjectCollectionRule. The oldest time of the file in the bucket to consider for collection. Accepted values are: BEGINNING or CURRENT_TIME or RFC3339 formatted datetime string. Use this for HISTORIC or HISTORIC_LIVE collection types. When collectionType is LIVE, specifying pollSince value other than CURRENT_TIME will result in error.

Returns:	The poll_since of this LogAnalyticsObjectCollectionRule.
Return type:	str

poll_till¶

Gets the poll_till of this LogAnalyticsObjectCollectionRule. The newest time of the file in the bucket to consider for collection. Accepted values are: CURRENT_TIME or RFC3339 formatted datetime string. Use this for HISTORIC collection type. When collectionType is LIVE or HISTORIC_LIVE, specifying pollTill will result in error.

Returns:	The poll_till of this LogAnalyticsObjectCollectionRule.
Return type:	str

time_created¶

[Required] Gets the time_created of this LogAnalyticsObjectCollectionRule. The time when this rule was created. An RFC3339 formatted datetime string.

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

time_updated¶

[Required] Gets the time_updated of this LogAnalyticsObjectCollectionRule. The time when this rule was last updated. An RFC3339 formatted datetime string.

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

timezone¶

Gets the timezone of this LogAnalyticsObjectCollectionRule. Timezone to be used when processing log entries whose timestamps do not include an explicit timezone. When this property is not specified, the timezone of the entity specified is used. If the entity is also not specified or do not have a valid timezone then UTC is used.

Returns:	The timezone of this LogAnalyticsObjectCollectionRule.
Return type:	str