LogAnalyticsMetric¶

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

Bases: object

Attributes

`METRIC_TYPE_AVERAGE`	A constant which can be used with the metric_type property of a LogAnalyticsMetric.
`METRIC_TYPE_AVERAGE_DISTRIBUTION`	A constant which can be used with the metric_type property of a LogAnalyticsMetric.
`METRIC_TYPE_COUNT`	A constant which can be used with the metric_type property of a LogAnalyticsMetric.
`METRIC_TYPE_COUNT_DISTRIBUTION`	A constant which can be used with the metric_type property of a LogAnalyticsMetric.
`METRIC_TYPE_SUM`	A constant which can be used with the metric_type property of a LogAnalyticsMetric.
`METRIC_TYPE_SUM_DISTRIBUTION`	A constant which can be used with the metric_type property of a LogAnalyticsMetric.
`OPERATOR_CONTAINS_IGNORE_CASE`	A constant which can be used with the operator property of a LogAnalyticsMetric.
`OPERATOR_EQUAL_IGNORE_CASE`	A constant which can be used with the operator property of a LogAnalyticsMetric.
`OPERATOR_IN_IGNORE_CASE`	A constant which can be used with the operator property of a LogAnalyticsMetric.
`OPERATOR_NOT_NULL`	A constant which can be used with the operator property of a LogAnalyticsMetric.
`aggregation_field`	Gets the aggregation_field of this LogAnalyticsMetric.
`bucket_metadata`	Gets the bucket_metadata of this LogAnalyticsMetric.
`clock_period`	Gets the clock_period of this LogAnalyticsMetric.
`description`	Gets the description of this LogAnalyticsMetric.
`display_name`	Gets the display_name of this LogAnalyticsMetric.
`edit_version`	Gets the edit_version of this LogAnalyticsMetric.
`entity_type`	Gets the entity_type of this LogAnalyticsMetric.
`field_name`	Gets the field_name of this LogAnalyticsMetric.
`field_values`	Gets the field_values of this LogAnalyticsMetric.
`grouping_field`	Gets the grouping_field of this LogAnalyticsMetric.
`is_enabled`	Gets the is_enabled of this LogAnalyticsMetric.
`is_metric_source_enabled`	Gets the is_metric_source_enabled of this LogAnalyticsMetric.
`is_system`	Gets the is_system of this LogAnalyticsMetric.
`is_user_customized`	Gets the is_user_customized of this LogAnalyticsMetric.
`metric_reference`	Gets the metric_reference of this LogAnalyticsMetric.
`metric_type`	Gets the metric_type of this LogAnalyticsMetric.
`name`	Gets the name of this LogAnalyticsMetric.
`operator`	Gets the operator of this LogAnalyticsMetric.
`sources`	Gets the sources of this LogAnalyticsMetric.
`time_updated`	Gets the time_updated of this LogAnalyticsMetric.
`unit_type`	Gets the unit_type of this LogAnalyticsMetric.

Methods

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

METRIC_TYPE_AVERAGE = 'AVERAGE'¶: A constant which can be used with the metric_type property of a LogAnalyticsMetric. This constant has a value of “AVERAGE”

METRIC_TYPE_AVERAGE_DISTRIBUTION = 'AVERAGE_DISTRIBUTION'¶: A constant which can be used with the metric_type property of a LogAnalyticsMetric. This constant has a value of “AVERAGE_DISTRIBUTION”

METRIC_TYPE_COUNT = 'COUNT'¶: A constant which can be used with the metric_type property of a LogAnalyticsMetric. This constant has a value of “COUNT”

METRIC_TYPE_COUNT_DISTRIBUTION = 'COUNT_DISTRIBUTION'¶: A constant which can be used with the metric_type property of a LogAnalyticsMetric. This constant has a value of “COUNT_DISTRIBUTION”

METRIC_TYPE_SUM = 'SUM'¶: A constant which can be used with the metric_type property of a LogAnalyticsMetric. This constant has a value of “SUM”

METRIC_TYPE_SUM_DISTRIBUTION = 'SUM_DISTRIBUTION'¶: A constant which can be used with the metric_type property of a LogAnalyticsMetric. This constant has a value of “SUM_DISTRIBUTION”

OPERATOR_CONTAINS_IGNORE_CASE = 'CONTAINS_IGNORE_CASE'¶: A constant which can be used with the operator property of a LogAnalyticsMetric. This constant has a value of “CONTAINS_IGNORE_CASE”

OPERATOR_EQUAL_IGNORE_CASE = 'EQUAL_IGNORE_CASE'¶: A constant which can be used with the operator property of a LogAnalyticsMetric. This constant has a value of “EQUAL_IGNORE_CASE”

OPERATOR_IN_IGNORE_CASE = 'IN_IGNORE_CASE'¶: A constant which can be used with the operator property of a LogAnalyticsMetric. This constant has a value of “IN_IGNORE_CASE”

OPERATOR_NOT_NULL = 'NOT_NULL'¶: A constant which can be used with the operator property of a LogAnalyticsMetric. This constant has a value of “NOT_NULL”

__init__(**kwargs)¶

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

Parameters:

aggregation_field (str) – The value to assign to the aggregation_field property of this LogAnalyticsMetric.
bucket_metadata (str) – The value to assign to the bucket_metadata property of this LogAnalyticsMetric.
clock_period (str) – The value to assign to the clock_period property of this LogAnalyticsMetric.
description (str) – The value to assign to the description property of this LogAnalyticsMetric.
edit_version (int) – The value to assign to the edit_version property of this LogAnalyticsMetric.
field_name (str) – The value to assign to the field_name property of this LogAnalyticsMetric.
field_values (list[str]) – The value to assign to the field_values property of this LogAnalyticsMetric.
grouping_field (str) – The value to assign to the grouping_field property of this LogAnalyticsMetric.
is_enabled (bool) – The value to assign to the is_enabled property of this LogAnalyticsMetric.
is_system (bool) – The value to assign to the is_system property of this LogAnalyticsMetric.
display_name (str) – The value to assign to the display_name property of this LogAnalyticsMetric.
metric_reference (int) – The value to assign to the metric_reference property of this LogAnalyticsMetric.
name (str) – The value to assign to the name property of this LogAnalyticsMetric.
metric_type (str) – The value to assign to the metric_type property of this LogAnalyticsMetric. Allowed values for this property are: “COUNT”, “SUM”, “AVERAGE”, “COUNT_DISTRIBUTION”, “SUM_DISTRIBUTION”, “AVERAGE_DISTRIBUTION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
is_metric_source_enabled (bool) – The value to assign to the is_metric_source_enabled property of this LogAnalyticsMetric.
operator (str) – The value to assign to the operator property of this LogAnalyticsMetric. Allowed values for this property are: “CONTAINS_IGNORE_CASE”, “IN_IGNORE_CASE”, “EQUAL_IGNORE_CASE”, “NOT_NULL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
sources (list[oci.log_analytics.models.LogAnalyticsSource]) – The value to assign to the sources property of this LogAnalyticsMetric.
entity_type (str) – The value to assign to the entity_type property of this LogAnalyticsMetric.
time_updated (datetime) – The value to assign to the time_updated property of this LogAnalyticsMetric.
unit_type (str) – The value to assign to the unit_type property of this LogAnalyticsMetric.
is_user_customized (bool) – The value to assign to the is_user_customized property of this LogAnalyticsMetric.

aggregation_field¶

Gets the aggregation_field of this LogAnalyticsMetric. The aggregation field.

Returns:	The aggregation_field of this LogAnalyticsMetric.
Return type:	str

bucket_metadata¶

Gets the bucket_metadata of this LogAnalyticsMetric. The bucket metadata.

Returns:	The bucket_metadata of this LogAnalyticsMetric.
Return type:	str

clock_period¶

Gets the clock_period of this LogAnalyticsMetric. The clock period.

Returns:	The clock_period of this LogAnalyticsMetric.
Return type:	str

description¶

Gets the description of this LogAnalyticsMetric. The metric description.

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

display_name¶

Gets the display_name of this LogAnalyticsMetric. The metric display name.

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

edit_version¶

Gets the edit_version of this LogAnalyticsMetric. The metric edit version.

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

entity_type¶

Gets the entity_type of this LogAnalyticsMetric. The entity type.

Returns:	The entity_type of this LogAnalyticsMetric.
Return type:	str

field_name¶

Gets the field_name of this LogAnalyticsMetric. The field name.

Returns:	The field_name of this LogAnalyticsMetric.
Return type:	str

field_values¶

Gets the field_values of this LogAnalyticsMetric. The field values.

Returns:	The field_values of this LogAnalyticsMetric.
Return type:	list[str]

grouping_field¶

Gets the grouping_field of this LogAnalyticsMetric. The grouping fields.

Returns:	The grouping_field of this LogAnalyticsMetric.
Return type:	str

is_enabled¶

Gets the is_enabled of this LogAnalyticsMetric. A flag inidcating whether or not the metric is enabled.

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

is_metric_source_enabled¶

Gets the is_metric_source_enabled of this LogAnalyticsMetric. A flag specifying whether or not the metric source is enabled.

Returns:	The is_metric_source_enabled of this LogAnalyticsMetric.
Return type:	bool

is_system¶

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

is_user_customized¶

Gets the is_user_customized of this LogAnalyticsMetric. A flag specifying whether or not this is a custom (user defined) metric.

Returns:	The is_user_customized of this LogAnalyticsMetric.
Return type:	bool

metric_reference¶

Gets the metric_reference of this LogAnalyticsMetric. The metric unique identifier.

Returns:	The metric_reference of this LogAnalyticsMetric.
Return type:	int

metric_type¶

Gets the metric_type of this LogAnalyticsMetric. The metric type, specifying the type of aggreation to perform. Default value is COUNT.

Allowed values for this property are: “COUNT”, “SUM”, “AVERAGE”, “COUNT_DISTRIBUTION”, “SUM_DISTRIBUTION”, “AVERAGE_DISTRIBUTION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The metric_type of this LogAnalyticsMetric.
Return type:	str

name¶

Gets the name of this LogAnalyticsMetric. The metric name.

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

operator¶

Gets the operator of this LogAnalyticsMetric. The metric operator.

Allowed values for this property are: “CONTAINS_IGNORE_CASE”, “IN_IGNORE_CASE”, “EQUAL_IGNORE_CASE”, “NOT_NULL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The operator of this LogAnalyticsMetric.
Return type:	str

sources¶

Gets the sources of this LogAnalyticsMetric. The metric sources.

Returns:	The sources of this LogAnalyticsMetric.
Return type:	list[oci.log_analytics.models.LogAnalyticsSource]

time_updated¶

Gets the time_updated of this LogAnalyticsMetric. The last updated date.

Returns:	The time_updated of this LogAnalyticsMetric.
Return type:	datetime

unit_type¶

Gets the unit_type of this LogAnalyticsMetric. The unit type.

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