UpdateMetricGroupDetails¶

class oci.apm_config.models.UpdateMetricGroupDetails(**kwargs)¶

Bases: oci.apm_config.models.update_config_details.UpdateConfigDetails

A metric group defines a set of metrics to collect from a span. It uses a span filter to specify which spans to process. The set is then published to a namespace, which is a product level subdivision of metrics.

Attributes

`CONFIG_TYPE_APDEX`	str(object=’’) -> str
`CONFIG_TYPE_METRIC_GROUP`	str(object=’’) -> str
`CONFIG_TYPE_OPTIONS`	str(object=’’) -> str
`CONFIG_TYPE_SPAN_FILTER`	str(object=’’) -> str
`config_type`	[Required] Gets the config_type of this UpdateConfigDetails.
`defined_tags`	Gets the defined_tags of this UpdateConfigDetails.
`dimensions`	Gets the dimensions of this UpdateMetricGroupDetails.
`display_name`	Gets the display_name of this UpdateMetricGroupDetails.
`filter_id`	Gets the filter_id of this UpdateMetricGroupDetails.
`freeform_tags`	Gets the freeform_tags of this UpdateConfigDetails.
`metrics`	Gets the metrics of this UpdateMetricGroupDetails.
`namespace`	Gets the namespace of this UpdateMetricGroupDetails.

Methods

`__init__`(**kwargs)	Initializes a new UpdateMetricGroupDetails object with values from keyword arguments.
`get_subtype`(object_dictionary)	Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

CONFIG_TYPE_APDEX = 'APDEX'¶

CONFIG_TYPE_METRIC_GROUP = 'METRIC_GROUP'¶

CONFIG_TYPE_OPTIONS = 'OPTIONS'¶

CONFIG_TYPE_SPAN_FILTER = 'SPAN_FILTER'¶

__init__(**kwargs)¶

Initializes a new UpdateMetricGroupDetails object with values from keyword arguments. The default value of the config_type attribute of this class is METRIC_GROUP and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

config_type (str) – The value to assign to the config_type property of this UpdateMetricGroupDetails. Allowed values for this property are: “SPAN_FILTER”, “METRIC_GROUP”, “APDEX”, “OPTIONS”
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this UpdateMetricGroupDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this UpdateMetricGroupDetails.
display_name (str) – The value to assign to the display_name property of this UpdateMetricGroupDetails.
filter_id (str) – The value to assign to the filter_id property of this UpdateMetricGroupDetails.
namespace (str) – The value to assign to the namespace property of this UpdateMetricGroupDetails.
dimensions (list[oci.apm_config.models.Dimension]) – The value to assign to the dimensions property of this UpdateMetricGroupDetails.
metrics (list[oci.apm_config.models.Metric]) – The value to assign to the metrics property of this UpdateMetricGroupDetails.

config_type¶

[Required] Gets the config_type of this UpdateConfigDetails. The type of configuration item.

Allowed values for this property are: “SPAN_FILTER”, “METRIC_GROUP”, “APDEX”, “OPTIONS”

Returns:	The config_type of this UpdateConfigDetails.
Return type:	str

defined_tags¶

Gets the defined_tags of this UpdateConfigDetails. 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 UpdateConfigDetails.
Return type:	dict(str, dict(str, object))

dimensions¶

Gets the dimensions of this UpdateMetricGroupDetails. A list of dimensions for the metric. This variable should not be used.

Returns:	The dimensions of this UpdateMetricGroupDetails.
Return type:	list[oci.apm_config.models.Dimension]

display_name¶

Gets the display_name of this UpdateMetricGroupDetails. The name by which a configuration entity is displayed to the end user.

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

filter_id¶

Gets the filter_id of this UpdateMetricGroupDetails. The OCID of a Span Filter. The filterId is mandatory for the creation of MetricGroups. A filterId is generated when a Span Filter is created.

Returns:	The filter_id of this UpdateMetricGroupDetails.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this UpdateConfigDetails. 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 UpdateConfigDetails.
Return type:	dict(str, str)

static get_subtype(object_dictionary)¶: Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

metrics¶

Gets the metrics of this UpdateMetricGroupDetails. The list of metrics in this group.

Returns:	The metrics of this UpdateMetricGroupDetails.
Return type:	list[oci.apm_config.models.Metric]

namespace¶

Gets the namespace of this UpdateMetricGroupDetails. The namespace to which the metrics are published. It must be one of several predefined namespaces.

Returns:	The namespace of this UpdateMetricGroupDetails.
Return type:	str