CreateLogAnalyticsObjectCollectionRuleDetails

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

Bases: object

The configuration details of collection rule to enable automatic log collection from an object storage bucket.

Attributes

COLLECTION_TYPE_HISTORIC A constant which can be used with the collection_type property of a CreateLogAnalyticsObjectCollectionRuleDetails.
COLLECTION_TYPE_HISTORIC_LIVE A constant which can be used with the collection_type property of a CreateLogAnalyticsObjectCollectionRuleDetails.
COLLECTION_TYPE_LIVE A constant which can be used with the collection_type property of a CreateLogAnalyticsObjectCollectionRuleDetails.
char_encoding Gets the char_encoding of this CreateLogAnalyticsObjectCollectionRuleDetails.
collection_type Gets the collection_type of this CreateLogAnalyticsObjectCollectionRuleDetails.
compartment_id [Required] Gets the compartment_id of this CreateLogAnalyticsObjectCollectionRuleDetails.
defined_tags Gets the defined_tags of this CreateLogAnalyticsObjectCollectionRuleDetails.
description Gets the description of this CreateLogAnalyticsObjectCollectionRuleDetails.
entity_id Gets the entity_id of this CreateLogAnalyticsObjectCollectionRuleDetails.
freeform_tags Gets the freeform_tags of this CreateLogAnalyticsObjectCollectionRuleDetails.
is_enabled Gets the is_enabled of this CreateLogAnalyticsObjectCollectionRuleDetails.
log_group_id [Required] Gets the log_group_id of this CreateLogAnalyticsObjectCollectionRuleDetails.
log_source_name [Required] Gets the log_source_name of this CreateLogAnalyticsObjectCollectionRuleDetails.
name [Required] Gets the name of this CreateLogAnalyticsObjectCollectionRuleDetails.
object_name_filters Gets the object_name_filters of this CreateLogAnalyticsObjectCollectionRuleDetails.
os_bucket_name [Required] Gets the os_bucket_name of this CreateLogAnalyticsObjectCollectionRuleDetails.
os_namespace [Required] Gets the os_namespace of this CreateLogAnalyticsObjectCollectionRuleDetails.
overrides Gets the overrides of this CreateLogAnalyticsObjectCollectionRuleDetails.
poll_since Gets the poll_since of this CreateLogAnalyticsObjectCollectionRuleDetails.
poll_till Gets the poll_till of this CreateLogAnalyticsObjectCollectionRuleDetails.

Methods

__init__(**kwargs) Initializes a new CreateLogAnalyticsObjectCollectionRuleDetails object with values from keyword arguments.
COLLECTION_TYPE_HISTORIC = 'HISTORIC'

A constant which can be used with the collection_type property of a CreateLogAnalyticsObjectCollectionRuleDetails. 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 CreateLogAnalyticsObjectCollectionRuleDetails. 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 CreateLogAnalyticsObjectCollectionRuleDetails. This constant has a value of “LIVE”

__init__(**kwargs)

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

Parameters:
  • name (str) – The value to assign to the name property of this CreateLogAnalyticsObjectCollectionRuleDetails.
  • description (str) – The value to assign to the description property of this CreateLogAnalyticsObjectCollectionRuleDetails.
  • compartment_id (str) – The value to assign to the compartment_id property of this CreateLogAnalyticsObjectCollectionRuleDetails.
  • os_namespace (str) – The value to assign to the os_namespace property of this CreateLogAnalyticsObjectCollectionRuleDetails.
  • os_bucket_name (str) – The value to assign to the os_bucket_name property of this CreateLogAnalyticsObjectCollectionRuleDetails.
  • collection_type (str) – The value to assign to the collection_type property of this CreateLogAnalyticsObjectCollectionRuleDetails. Allowed values for this property are: “LIVE”, “HISTORIC”, “HISTORIC_LIVE”
  • poll_since (str) – The value to assign to the poll_since property of this CreateLogAnalyticsObjectCollectionRuleDetails.
  • poll_till (str) – The value to assign to the poll_till property of this CreateLogAnalyticsObjectCollectionRuleDetails.
  • log_group_id (str) – The value to assign to the log_group_id property of this CreateLogAnalyticsObjectCollectionRuleDetails.
  • log_source_name (str) – The value to assign to the log_source_name property of this CreateLogAnalyticsObjectCollectionRuleDetails.
  • entity_id (str) – The value to assign to the entity_id property of this CreateLogAnalyticsObjectCollectionRuleDetails.
  • char_encoding (str) – The value to assign to the char_encoding property of this CreateLogAnalyticsObjectCollectionRuleDetails.
  • is_enabled (bool) – The value to assign to the is_enabled property of this CreateLogAnalyticsObjectCollectionRuleDetails.
  • overrides (dict(str, list[PropertyOverride])) – The value to assign to the overrides property of this CreateLogAnalyticsObjectCollectionRuleDetails.
  • object_name_filters (list[str]) – The value to assign to the object_name_filters property of this CreateLogAnalyticsObjectCollectionRuleDetails.
  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateLogAnalyticsObjectCollectionRuleDetails.
  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateLogAnalyticsObjectCollectionRuleDetails.
char_encoding

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

Gets the collection_type of this CreateLogAnalyticsObjectCollectionRuleDetails. The type of collection.

Allowed values for this property are: “LIVE”, “HISTORIC”, “HISTORIC_LIVE”

Returns:The collection_type of this CreateLogAnalyticsObjectCollectionRuleDetails.
Return type:str
compartment_id

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

Returns:The compartment_id of this CreateLogAnalyticsObjectCollectionRuleDetails.
Return type:str
defined_tags

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

Gets the description of this CreateLogAnalyticsObjectCollectionRuleDetails. 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 CreateLogAnalyticsObjectCollectionRuleDetails.
Return type:str
entity_id

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

Returns:The entity_id of this CreateLogAnalyticsObjectCollectionRuleDetails.
Return type:str
freeform_tags

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

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

Returns:The is_enabled of this CreateLogAnalyticsObjectCollectionRuleDetails.
Return type:bool
log_group_id

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

Returns:The log_group_id of this CreateLogAnalyticsObjectCollectionRuleDetails.
Return type:str
log_source_name

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

Returns:The log_source_name of this CreateLogAnalyticsObjectCollectionRuleDetails.
Return type:str
name

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

Returns:The name of this CreateLogAnalyticsObjectCollectionRuleDetails.
Return type:str
object_name_filters

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

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

Returns:The os_bucket_name of this CreateLogAnalyticsObjectCollectionRuleDetails.
Return type:str
os_namespace

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

Returns:The os_namespace of this CreateLogAnalyticsObjectCollectionRuleDetails.
Return type:str
overrides

Gets the overrides of this CreateLogAnalyticsObjectCollectionRuleDetails. The override is used to modify some important configuration properties for objects matching a specific pattern inside the bucket. Supported propeties for override are: logSourceName, charEncoding, entityId. Supported matchType for override are “contains”.

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

Gets the poll_since of this CreateLogAnalyticsObjectCollectionRuleDetails. 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 CreateLogAnalyticsObjectCollectionRuleDetails.
Return type:str
poll_till

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