UpdateLogAnalyticsObjectCollectionRuleDetails¶

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

Bases: object

Configuration of the collection rule to be updated.

Attributes

`LOG_SET_KEY_OBJECT_PATH`	A constant which can be used with the log_set_key property of a UpdateLogAnalyticsObjectCollectionRuleDetails.
`char_encoding`	Gets the char_encoding of this UpdateLogAnalyticsObjectCollectionRuleDetails.
`defined_tags`	Gets the defined_tags of this UpdateLogAnalyticsObjectCollectionRuleDetails.
`description`	Gets the description of this UpdateLogAnalyticsObjectCollectionRuleDetails.
`entity_id`	Gets the entity_id of this UpdateLogAnalyticsObjectCollectionRuleDetails.
`freeform_tags`	Gets the freeform_tags of this UpdateLogAnalyticsObjectCollectionRuleDetails.
`is_enabled`	Gets the is_enabled of this UpdateLogAnalyticsObjectCollectionRuleDetails.
`log_group_id`	Gets the log_group_id of this UpdateLogAnalyticsObjectCollectionRuleDetails.
`log_set`	Gets the log_set of this UpdateLogAnalyticsObjectCollectionRuleDetails.
`log_set_ext_regex`	Gets the log_set_ext_regex of this UpdateLogAnalyticsObjectCollectionRuleDetails.
`log_set_key`	Gets the log_set_key of this UpdateLogAnalyticsObjectCollectionRuleDetails.
`log_source_name`	Gets the log_source_name of this UpdateLogAnalyticsObjectCollectionRuleDetails.
`object_name_filters`	Gets the object_name_filters of this UpdateLogAnalyticsObjectCollectionRuleDetails.
`overrides`	Gets the overrides of this UpdateLogAnalyticsObjectCollectionRuleDetails.
`timezone`	Gets the timezone of this UpdateLogAnalyticsObjectCollectionRuleDetails.

Methods

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

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

__init__(**kwargs)¶

Initializes a new UpdateLogAnalyticsObjectCollectionRuleDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

description (str) – The value to assign to the description property of this UpdateLogAnalyticsObjectCollectionRuleDetails.
log_group_id (str) – The value to assign to the log_group_id property of this UpdateLogAnalyticsObjectCollectionRuleDetails.
log_source_name (str) – The value to assign to the log_source_name property of this UpdateLogAnalyticsObjectCollectionRuleDetails.
entity_id (str) – The value to assign to the entity_id property of this UpdateLogAnalyticsObjectCollectionRuleDetails.
char_encoding (str) – The value to assign to the char_encoding property of this UpdateLogAnalyticsObjectCollectionRuleDetails.
is_enabled (bool) – The value to assign to the is_enabled property of this UpdateLogAnalyticsObjectCollectionRuleDetails.
timezone (str) – The value to assign to the timezone property of this UpdateLogAnalyticsObjectCollectionRuleDetails.
log_set (str) – The value to assign to the log_set property of this UpdateLogAnalyticsObjectCollectionRuleDetails.
log_set_key (str) – The value to assign to the log_set_key property of this UpdateLogAnalyticsObjectCollectionRuleDetails. Allowed values for this property are: “OBJECT_PATH”
log_set_ext_regex (str) – The value to assign to the log_set_ext_regex property of this UpdateLogAnalyticsObjectCollectionRuleDetails.
overrides (dict(str, list[PropertyOverride])) – The value to assign to the overrides property of this UpdateLogAnalyticsObjectCollectionRuleDetails.
object_name_filters (list[str]) – The value to assign to the object_name_filters property of this UpdateLogAnalyticsObjectCollectionRuleDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this UpdateLogAnalyticsObjectCollectionRuleDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this UpdateLogAnalyticsObjectCollectionRuleDetails.

char_encoding¶

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

defined_tags¶

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

description¶

Gets the description of this UpdateLogAnalyticsObjectCollectionRuleDetails. A string that describes the details of the rule. Avoid entering confidential information.

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

entity_id¶

Gets the entity_id of this UpdateLogAnalyticsObjectCollectionRuleDetails. Logging Analytics entity OCID. Associates the processed logs with the given entity (optional).

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

freeform_tags¶

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

is_enabled¶

Gets the is_enabled of this UpdateLogAnalyticsObjectCollectionRuleDetails. Whether or not this rule is currently enabled.

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

log_group_id¶

Gets the log_group_id of this UpdateLogAnalyticsObjectCollectionRuleDetails. Logging Analytics Log group OCID to associate the processed logs with.

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

log_set¶

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

log_set_ext_regex¶

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

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

log_set_key¶

Gets the log_set_key of this UpdateLogAnalyticsObjectCollectionRuleDetails. 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”

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

log_source_name¶

Gets the log_source_name of this UpdateLogAnalyticsObjectCollectionRuleDetails. Name of the Logging Analytics Source to use for the processing.

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

object_name_filters¶

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

overrides¶

Gets the overrides of this UpdateLogAnalyticsObjectCollectionRuleDetails. 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 UpdateLogAnalyticsObjectCollectionRuleDetails.
Return type:	dict(str, list[PropertyOverride])

timezone¶

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