Metric¶

class oci.stack_monitoring.models.Metric(**kwargs)¶

Bases: object

Details of a metric which is part of this metric extension

Attributes

`DATA_TYPE_NUMBER`	A constant which can be used with the data_type property of a Metric.
`DATA_TYPE_STRING`	A constant which can be used with the data_type property of a Metric.
`METRIC_CATEGORY_AVAILABILITY`	A constant which can be used with the metric_category property of a Metric.
`METRIC_CATEGORY_CAPACITY`	A constant which can be used with the metric_category property of a Metric.
`METRIC_CATEGORY_LOAD`	A constant which can be used with the metric_category property of a Metric.
`METRIC_CATEGORY_UTILIZATION`	A constant which can be used with the metric_category property of a Metric.
`compute_expression`	Gets the compute_expression of this Metric.
`data_type`	[Required] Gets the data_type of this Metric.
`display_name`	Gets the display_name of this Metric.
`is_dimension`	Gets the is_dimension of this Metric.
`is_hidden`	Gets the is_hidden of this Metric.
`metric_category`	Gets the metric_category of this Metric.
`name`	[Required] Gets the name of this Metric.
`unit`	Gets the unit of this Metric.

Methods

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

DATA_TYPE_NUMBER = 'NUMBER'¶: A constant which can be used with the data_type property of a Metric. This constant has a value of “NUMBER”

DATA_TYPE_STRING = 'STRING'¶: A constant which can be used with the data_type property of a Metric. This constant has a value of “STRING”

METRIC_CATEGORY_AVAILABILITY = 'AVAILABILITY'¶: A constant which can be used with the metric_category property of a Metric. This constant has a value of “AVAILABILITY”

METRIC_CATEGORY_CAPACITY = 'CAPACITY'¶: A constant which can be used with the metric_category property of a Metric. This constant has a value of “CAPACITY”

METRIC_CATEGORY_LOAD = 'LOAD'¶: A constant which can be used with the metric_category property of a Metric. This constant has a value of “LOAD”

METRIC_CATEGORY_UTILIZATION = 'UTILIZATION'¶: A constant which can be used with the metric_category property of a Metric. This constant has a value of “UTILIZATION”

__init__(**kwargs)¶

Initializes a new Metric 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 Metric.
display_name (str) – The value to assign to the display_name property of this Metric.
is_dimension (bool) – The value to assign to the is_dimension property of this Metric.
compute_expression (str) – The value to assign to the compute_expression property of this Metric.
data_type (str) – The value to assign to the data_type property of this Metric. Allowed values for this property are: “STRING”, “NUMBER”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
is_hidden (bool) – The value to assign to the is_hidden property of this Metric.
metric_category (str) – The value to assign to the metric_category property of this Metric. Allowed values for this property are: “LOAD”, “UTILIZATION”, “CAPACITY”, “AVAILABILITY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
unit (str) – The value to assign to the unit property of this Metric.

compute_expression¶

Gets the compute_expression of this Metric. Compute Expression to calculate the value of this metric

Returns:	The compute_expression of this Metric.
Return type:	str

data_type¶

[Required] Gets the data_type of this Metric. Data type of value of this metric

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

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

display_name¶

Gets the display_name of this Metric. Display name of the metric.

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

is_dimension¶

Gets the is_dimension of this Metric. Current metric need to be included as dimension or not

Returns:	The is_dimension of this Metric.
Return type:	bool

is_hidden¶

Gets the is_hidden of this Metric. Flag to marks whether a metric has to be uploaded or not. When isHidden = false -> Metric is uploaded, isHidden = true -> Metric is NOT uploaded

Returns:	The is_hidden of this Metric.
Return type:	bool

metric_category¶

Gets the metric_category of this Metric. Metric category

Allowed values for this property are: “LOAD”, “UTILIZATION”, “CAPACITY”, “AVAILABILITY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The metric_category of this Metric.
Return type:	str

name¶

[Required] Gets the name of this Metric. Name of the metric.

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

unit¶

Gets the unit of this Metric. Unit of metric value

Returns:	The unit of this Metric.
Return type:	str