IngestTimeRuleSummary¶
- class oci.log_analytics.models.IngestTimeRuleSummary(**kwargs)¶
Bases:
objectSummary of an ingest time rule.
Attributes:
A constant which can be used with the condition_kind property of a IngestTimeRuleSummary.
A constant which can be used with the lifecycle_state property of a IngestTimeRuleSummary.
A constant which can be used with the lifecycle_state property of a IngestTimeRuleSummary.
[Required] Gets the compartment_id of this IngestTimeRuleSummary.
Gets the condition_kind of this IngestTimeRuleSummary.
Gets the defined_tags of this IngestTimeRuleSummary.
Gets the description of this IngestTimeRuleSummary.
[Required] Gets the display_name of this IngestTimeRuleSummary.
Gets the field_name of this IngestTimeRuleSummary.
Gets the field_value of this IngestTimeRuleSummary.
Gets the freeform_tags of this IngestTimeRuleSummary.
[Required] Gets the id of this IngestTimeRuleSummary.
Gets the is_enabled of this IngestTimeRuleSummary.
Gets the lifecycle_state of this IngestTimeRuleSummary.
Gets the time_created of this IngestTimeRuleSummary.
Gets the time_updated of this IngestTimeRuleSummary.
Methods:
__init__(**kwargs)Initializes a new IngestTimeRuleSummary object with values from keyword arguments.
- CONDITION_KIND_FIELD = 'FIELD'¶
A constant which can be used with the condition_kind property of a IngestTimeRuleSummary. This constant has a value of “FIELD”
- LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶
A constant which can be used with the lifecycle_state property of a IngestTimeRuleSummary. This constant has a value of “ACTIVE”
- LIFECYCLE_STATE_DELETED = 'DELETED'¶
A constant which can be used with the lifecycle_state property of a IngestTimeRuleSummary. This constant has a value of “DELETED”
- __init__(**kwargs)¶
Initializes a new IngestTimeRuleSummary 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 IngestTimeRuleSummary.
description (str) – The value to assign to the description property of this IngestTimeRuleSummary.
compartment_id (str) – The value to assign to the compartment_id property of this IngestTimeRuleSummary.
time_created (datetime) – The value to assign to the time_created property of this IngestTimeRuleSummary.
time_updated (datetime) – The value to assign to the time_updated property of this IngestTimeRuleSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this IngestTimeRuleSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this IngestTimeRuleSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this IngestTimeRuleSummary. 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’.
display_name (str) – The value to assign to the display_name property of this IngestTimeRuleSummary.
is_enabled (bool) – The value to assign to the is_enabled property of this IngestTimeRuleSummary.
condition_kind (str) – The value to assign to the condition_kind property of this IngestTimeRuleSummary. Allowed values for this property are: “FIELD”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
field_name (str) – The value to assign to the field_name property of this IngestTimeRuleSummary.
field_value (str) – The value to assign to the field_value property of this IngestTimeRuleSummary.
- property compartment_id¶
[Required] Gets the compartment_id of this IngestTimeRuleSummary. Compartment Identifier OCID].
- Returns
The compartment_id of this IngestTimeRuleSummary.
- Return type
str
- property condition_kind¶
Gets the condition_kind of this IngestTimeRuleSummary. The ingest time rule condition kind.
Allowed values for this property are: “FIELD”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The condition_kind of this IngestTimeRuleSummary.
- Return type
str
- property defined_tags¶
Gets the defined_tags of this IngestTimeRuleSummary. 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 IngestTimeRuleSummary.
- Return type
dict(str, dict(str, object))
- property description¶
Gets the description of this IngestTimeRuleSummary. Description for this resource.
- Returns
The description of this IngestTimeRuleSummary.
- Return type
str
- property display_name¶
[Required] Gets the display_name of this IngestTimeRuleSummary. The ingest time rule display name.
- Returns
The display_name of this IngestTimeRuleSummary.
- Return type
str
- property field_name¶
Gets the field_name of this IngestTimeRuleSummary. The ingest time rule condition field name.
- Returns
The field_name of this IngestTimeRuleSummary.
- Return type
str
- property field_value¶
Gets the field_value of this IngestTimeRuleSummary. The ingest time rule condition field value.
- Returns
The field_value of this IngestTimeRuleSummary.
- Return type
str
- property freeform_tags¶
Gets the freeform_tags of this IngestTimeRuleSummary. 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 IngestTimeRuleSummary.
- Return type
dict(str, str)
- property id¶
[Required] Gets the id of this IngestTimeRuleSummary. 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 IngestTimeRuleSummary.
- Return type
str
- property is_enabled¶
Gets the is_enabled of this IngestTimeRuleSummary. A flag indicating whether or not the ingest time rule is enabled.
- Returns
The is_enabled of this IngestTimeRuleSummary.
- Return type
bool
- property lifecycle_state¶
Gets the lifecycle_state of this IngestTimeRuleSummary. The current state of the ingest time rule.
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 IngestTimeRuleSummary.
- Return type
str
- property time_created¶
Gets the time_created of this IngestTimeRuleSummary. The date and time the resource was created, in the format defined by RFC3339.
- Returns
The time_created of this IngestTimeRuleSummary.
- Return type
datetime
- property time_updated¶
Gets the time_updated of this IngestTimeRuleSummary. The date and time the resource was last updated, in the format defined by RFC3339.
- Returns
The time_updated of this IngestTimeRuleSummary.
- Return type
datetime