LogAnalyticsFieldSummary¶

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

Bases: object

A summary of a field.

Methods

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

Attributes

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

__init__(**kwargs)¶

Initializes a new LogAnalyticsFieldSummary 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 LogAnalyticsFieldSummary.
data_type (str) – The value to assign to the data_type property of this LogAnalyticsFieldSummary.
regular_expression (str) – The value to assign to the regular_expression property of this LogAnalyticsFieldSummary.
description (str) – The value to assign to the description property of this LogAnalyticsFieldSummary.
display_name (str) – The value to assign to the display_name property of this LogAnalyticsFieldSummary.
edit_version (int) – The value to assign to the edit_version property of this LogAnalyticsFieldSummary.
facet_priority (int) – The value to assign to the facet_priority property of this LogAnalyticsFieldSummary.
name (str) – The value to assign to the name property of this LogAnalyticsFieldSummary.
is_facet_eligible (bool) – The value to assign to the is_facet_eligible property of this LogAnalyticsFieldSummary.
is_high_cardinality (bool) – The value to assign to the is_high_cardinality property of this LogAnalyticsFieldSummary.
is_large_data (bool) – The value to assign to the is_large_data property of this LogAnalyticsFieldSummary.
is_multi_valued (bool) – The value to assign to the is_multi_valued property of this LogAnalyticsFieldSummary.
is_primary (bool) – The value to assign to the is_primary property of this LogAnalyticsFieldSummary.
is_system (bool) – The value to assign to the is_system property of this LogAnalyticsFieldSummary.
is_summarizable (bool) – The value to assign to the is_summarizable property of this LogAnalyticsFieldSummary.
mapped_value (str) – The value to assign to the mapped_value property of this LogAnalyticsFieldSummary.
is_metric_key_eligible (bool) – The value to assign to the is_metric_key_eligible property of this LogAnalyticsFieldSummary.
is_metric_value_eligible (bool) – The value to assign to the is_metric_value_eligible property of this LogAnalyticsFieldSummary.
range_facet_eligible (int) – The value to assign to the range_facet_eligible property of this LogAnalyticsFieldSummary.
is_table_eligible (bool) – The value to assign to the is_table_eligible property of this LogAnalyticsFieldSummary.
unit_type (str) – The value to assign to the unit_type property of this LogAnalyticsFieldSummary.

cee_alias¶

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

data_type¶

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

Returns:	The data_type of this LogAnalyticsFieldSummary.
Return type:	str

description¶

Gets the description of this LogAnalyticsFieldSummary. The field description.

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

display_name¶

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

Returns:	The display_name of this LogAnalyticsFieldSummary.
Return type:	str

edit_version¶

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

Returns:	The edit_version of this LogAnalyticsFieldSummary.
Return type:	int

facet_priority¶

Gets the facet_priority of this LogAnalyticsFieldSummary. The facet priority.

Returns:	The facet_priority of this LogAnalyticsFieldSummary.
Return type:	int

is_facet_eligible¶

Gets the is_facet_eligible of this LogAnalyticsFieldSummary. A flag inidcating whether or not the facet is elibigle for use.

Returns:	The is_facet_eligible of this LogAnalyticsFieldSummary.
Return type:	bool

is_high_cardinality¶

Gets the is_high_cardinality of this LogAnalyticsFieldSummary. A flag inidcating whether or not the cardinality of the field is high.

Returns:	The is_high_cardinality of this LogAnalyticsFieldSummary.
Return type:	bool

is_large_data¶

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

Returns:	The is_large_data of this LogAnalyticsFieldSummary.
Return type:	bool

is_metric_key_eligible¶

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

Returns:	The is_metric_key_eligible of this LogAnalyticsFieldSummary.
Return type:	bool

is_metric_value_eligible¶

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

Returns:	The is_metric_value_eligible of this LogAnalyticsFieldSummary.
Return type:	bool

is_multi_valued¶

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

Returns:	The is_multi_valued of this LogAnalyticsFieldSummary.
Return type:	bool

is_primary¶

Gets the is_primary of this LogAnalyticsFieldSummary. A flag inidcating whether or not this is a primary field.

Returns:	The is_primary of this LogAnalyticsFieldSummary.
Return type:	bool

is_summarizable¶

Gets the is_summarizable of this LogAnalyticsFieldSummary. A flag inidcating whether or not the field can be summarized.

Returns:	The is_summarizable of this LogAnalyticsFieldSummary.
Return type:	bool

is_system¶

Gets the is_system of this LogAnalyticsFieldSummary. 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 LogAnalyticsFieldSummary.
Return type:	bool

is_table_eligible¶

Gets the is_table_eligible of this LogAnalyticsFieldSummary. A flag inidcating whether or not the field is table eligible.

Returns:	The is_table_eligible of this LogAnalyticsFieldSummary.
Return type:	bool

mapped_value¶

Gets the mapped_value of this LogAnalyticsFieldSummary. The mapped value.

Returns:	The mapped_value of this LogAnalyticsFieldSummary.
Return type:	str

name¶

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

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

range_facet_eligible¶

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

Returns:	The range_facet_eligible of this LogAnalyticsFieldSummary.
Return type:	int

regular_expression¶

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

Returns:	The regular_expression of this LogAnalyticsFieldSummary.
Return type:	str

unit_type¶

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

Returns:	The unit_type of this LogAnalyticsFieldSummary.
Return type:	str