UpdateMetricGroupDetails¶
- class oci.apm_config.models.UpdateMetricGroupDetails(**kwargs)¶
Bases:
UpdateConfigDetailsA 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:
A constant which can be used with the config_type property of a UpdateConfigDetails.
A constant which can be used with the config_type property of a UpdateConfigDetails.
A constant which can be used with the config_type property of a UpdateConfigDetails.
A constant which can be used with the config_type property of a UpdateConfigDetails.
A constant which can be used with the config_type property of a UpdateConfigDetails.
A constant which can be used with the config_type property of a UpdateConfigDetails.
[Required] Gets the config_type of this UpdateConfigDetails.
Gets the defined_tags of this UpdateConfigDetails.
Gets the dimensions of this UpdateMetricGroupDetails.
Gets the display_name of this UpdateMetricGroupDetails.
Gets the filter_id of this UpdateMetricGroupDetails.
Gets the freeform_tags of this UpdateConfigDetails.
Gets the metrics of this UpdateMetricGroupDetails.
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_AGENT = 'AGENT'¶
A constant which can be used with the config_type property of a UpdateConfigDetails. This constant has a value of “AGENT”
- CONFIG_TYPE_APDEX = 'APDEX'¶
A constant which can be used with the config_type property of a UpdateConfigDetails. This constant has a value of “APDEX”
- CONFIG_TYPE_MACS_APM_EXTENSION = 'MACS_APM_EXTENSION'¶
A constant which can be used with the config_type property of a UpdateConfigDetails. This constant has a value of “MACS_APM_EXTENSION”
- CONFIG_TYPE_METRIC_GROUP = 'METRIC_GROUP'¶
A constant which can be used with the config_type property of a UpdateConfigDetails. This constant has a value of “METRIC_GROUP”
- CONFIG_TYPE_OPTIONS = 'OPTIONS'¶
A constant which can be used with the config_type property of a UpdateConfigDetails. This constant has a value of “OPTIONS”
- CONFIG_TYPE_SPAN_FILTER = 'SPAN_FILTER'¶
A constant which can be used with the config_type property of a UpdateConfigDetails. This constant has a value of “SPAN_FILTER”
- __init__(**kwargs)¶
Initializes a new UpdateMetricGroupDetails object with values from keyword arguments. The default value of the
config_typeattribute of this class isMETRIC_GROUPand 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”, “AGENT”, “MACS_APM_EXTENSION”
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.
- property 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”, “AGENT”, “MACS_APM_EXTENSION”
- Returns
The config_type of this UpdateConfigDetails.
- Return type
str
- property 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))
- property 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
- property 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
- property 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
- property 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.
- property metrics¶
Gets the metrics of this UpdateMetricGroupDetails. The list of metrics in this group.
- Returns
The metrics of this UpdateMetricGroupDetails.
- Return type
- property 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