LogAnalyticsField

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

Bases: object

Field Details

Methods:

__init__(**kwargs)

Initializes a new LogAnalyticsField object with values from keyword arguments.

Attributes:

cee_alias	Gets the cee_alias of this LogAnalyticsField.
data_type	Gets the data_type of this LogAnalyticsField.
description	Gets the description of this LogAnalyticsField.
display_name	Gets the display_name of this LogAnalyticsField.
edit_version	Gets the edit_version of this LogAnalyticsField.
facet_priority	Gets the facet_priority of this LogAnalyticsField.
is_facet_eligible	Gets the is_facet_eligible of this LogAnalyticsField.
is_high_cardinality	Gets the is_high_cardinality of this LogAnalyticsField.
is_keep_duplicates	Gets the is_keep_duplicates of this LogAnalyticsField.
is_large_data	Gets the is_large_data of this LogAnalyticsField.
is_metric_key_eligible	Gets the is_metric_key_eligible of this LogAnalyticsField.
is_metric_value_eligible	Gets the is_metric_value_eligible of this LogAnalyticsField.
is_multi_valued	Gets the is_multi_valued of this LogAnalyticsField.
is_primary	Gets the is_primary of this LogAnalyticsField.
is_summarizable	Gets the is_summarizable of this LogAnalyticsField.
is_system	Gets the is_system of this LogAnalyticsField.
is_table_eligible	Gets the is_table_eligible of this LogAnalyticsField.
mapped_value	Gets the mapped_value of this LogAnalyticsField.
name	Gets the name of this LogAnalyticsField.
range_facet_eligible	Gets the range_facet_eligible of this LogAnalyticsField.
regular_expression	Gets the regular_expression of this LogAnalyticsField.
time_updated	Gets the time_updated of this LogAnalyticsField.
unit_type	Gets the unit_type of this LogAnalyticsField.

__init__(**kwargs)

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

Parameters

• cee_alias (str) – The value to assign to the cee_alias property of this LogAnalyticsField.

• data_type (str) – The value to assign to the data_type property of this LogAnalyticsField.

• regular_expression (str) – The value to assign to the regular_expression property of this LogAnalyticsField.

• description (str) – The value to assign to the description property of this LogAnalyticsField.

• display_name (str) – The value to assign to the display_name property of this LogAnalyticsField.

• edit_version (int) – The value to assign to the edit_version property of this LogAnalyticsField.

• facet_priority (int) – The value to assign to the facet_priority property of this LogAnalyticsField.

• name (str) – The value to assign to the name property of this LogAnalyticsField.

• is_facet_eligible (bool) – The value to assign to the is_facet_eligible property of this LogAnalyticsField.

• is_high_cardinality (bool) – The value to assign to the is_high_cardinality property of this LogAnalyticsField.

• is_large_data (bool) – The value to assign to the is_large_data property of this LogAnalyticsField.

• is_multi_valued (bool) – The value to assign to the is_multi_valued property of this LogAnalyticsField.

• is_primary (bool) – The value to assign to the is_primary property of this LogAnalyticsField.

• is_system (bool) – The value to assign to the is_system property of this LogAnalyticsField.

• is_summarizable (bool) – The value to assign to the is_summarizable property of this LogAnalyticsField.

• mapped_value (str) – The value to assign to the mapped_value property of this LogAnalyticsField.

• is_metric_key_eligible (bool) – The value to assign to the is_metric_key_eligible property of this LogAnalyticsField.

• is_metric_value_eligible (bool) – The value to assign to the is_metric_value_eligible property of this LogAnalyticsField.

• range_facet_eligible (int) – The value to assign to the range_facet_eligible property of this LogAnalyticsField.

• is_table_eligible (bool) – The value to assign to the is_table_eligible property of this LogAnalyticsField.

• unit_type (str) – The value to assign to the unit_type property of this LogAnalyticsField.

• time_updated (datetime) – The value to assign to the time_updated property of this LogAnalyticsField.

• is_keep_duplicates (bool) – The value to assign to the is_keep_duplicates property of this LogAnalyticsField.

property cee_alias

Gets the cee_alias of this LogAnalyticsField. The name this field is given in the common event expression standard from mitre.org. This is used for reference when exporting content conforming to CEE standard

Returns

The cee_alias of this LogAnalyticsField.

Return type

str

property data_type

Gets the data_type of this LogAnalyticsField. The field data type.

Returns

The data_type of this LogAnalyticsField.

Return type

str

property description

Gets the description of this LogAnalyticsField. The field description.

Returns

The description of this LogAnalyticsField.

Return type

str

property display_name

Gets the display_name of this LogAnalyticsField. The field display name.

Returns

The display_name of this LogAnalyticsField.

Return type

str

property edit_version

Gets the edit_version of this LogAnalyticsField. The field edit version.

Returns

The edit_version of this LogAnalyticsField.

Return type

int

property facet_priority

Gets the facet_priority of this LogAnalyticsField. The facet priority.

Returns

The facet_priority of this LogAnalyticsField.

Return type

int

property is_facet_eligible

Gets the is_facet_eligible of this LogAnalyticsField. A flag indicating whether or not the facet is eligible for use.

Returns

The is_facet_eligible of this LogAnalyticsField.

Return type

bool

property is_high_cardinality

Gets the is_high_cardinality of this LogAnalyticsField. A flag indicating whether or not the cardinality of the field is high.

Returns

The is_high_cardinality of this LogAnalyticsField.

Return type

bool

property is_keep_duplicates

Gets the is_keep_duplicates of this LogAnalyticsField. A flag indicating whether or not duplicates would be retained.

Returns

The is_keep_duplicates of this LogAnalyticsField.

Return type

bool

property is_large_data

Gets the is_large_data of this LogAnalyticsField. A flag indicating whether or not the field is a large data field.

Returns

The is_large_data of this LogAnalyticsField.

Return type

bool

property is_metric_key_eligible

Gets the is_metric_key_eligible of this LogAnalyticsField. A flag indicating whether or not the field is metric key eligible.

Returns

The is_metric_key_eligible of this LogAnalyticsField.

Return type

bool

property is_metric_value_eligible

Gets the is_metric_value_eligible of this LogAnalyticsField. A flag indicating whether or not the field is metric value eligible.

Returns

The is_metric_value_eligible of this LogAnalyticsField.

Return type

bool

property is_multi_valued

Gets the is_multi_valued of this LogAnalyticsField. A flag indicating whether or not the field is multi-valued.

Returns

The is_multi_valued of this LogAnalyticsField.

Return type

bool

property is_primary

Gets the is_primary of this LogAnalyticsField. A flag indicating whether or not this is a primary field.

Returns

The is_primary of this LogAnalyticsField.

Return type

bool

property is_summarizable

Gets the is_summarizable of this LogAnalyticsField. A flag indicating whether or not the field can be summarized.

Returns

The is_summarizable of this LogAnalyticsField.

Return type

bool

property is_system

Gets the is_system of this LogAnalyticsField. The system flag. A value of false denotes a custom, or user defined object. A value of true denotes a built in object.

Returns

The is_system of this LogAnalyticsField.

Return type

bool

property is_table_eligible

Gets the is_table_eligible of this LogAnalyticsField. A flag indicating whether or not the field is table eligible.

Returns

The is_table_eligible of this LogAnalyticsField.

Return type

bool

property mapped_value

Gets the mapped_value of this LogAnalyticsField. The mapped value.

Returns

The mapped_value of this LogAnalyticsField.

Return type

str

property name

Gets the name of this LogAnalyticsField. The field internal name.

Returns

The name of this LogAnalyticsField.

Return type

str

property range_facet_eligible

Gets the range_facet_eligible of this LogAnalyticsField. A flag indicating whether or not the field is range facet eligible.

Returns

The range_facet_eligible of this LogAnalyticsField.

Return type

int

property regular_expression

Gets the regular_expression of this LogAnalyticsField. The field default regular expression.

Returns

The regular_expression of this LogAnalyticsField.

Return type

str

property time_updated

Gets the time_updated of this LogAnalyticsField. The last updated date and time.

Returns

The time_updated of this LogAnalyticsField.

Return type

datetime

property unit_type

Gets the unit_type of this LogAnalyticsField. The field unit type.

Returns

The unit_type of this LogAnalyticsField.

Return type

str