ExportImportMetricGroupSummary

class oci.apm_config.models.ExportImportMetricGroupSummary(**kwargs)

Bases: ExportImportConfigSummary

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_AGENT	A constant which can be used with the config_type property of a ExportImportConfigSummary.
CONFIG_TYPE_APDEX	A constant which can be used with the config_type property of a ExportImportConfigSummary.
CONFIG_TYPE_MACS_APM_EXTENSION	A constant which can be used with the config_type property of a ExportImportConfigSummary.
CONFIG_TYPE_METRIC_GROUP	A constant which can be used with the config_type property of a ExportImportConfigSummary.
CONFIG_TYPE_OPTIONS	A constant which can be used with the config_type property of a ExportImportConfigSummary.
CONFIG_TYPE_SPAN_FILTER	A constant which can be used with the config_type property of a ExportImportConfigSummary.
config_type	[Required] Gets the config_type of this ExportImportConfigSummary.
defined_tags	Gets the defined_tags of this ExportImportConfigSummary.
dimensions	Gets the dimensions of this ExportImportMetricGroupSummary.
display_name	Gets the display_name of this ExportImportMetricGroupSummary.
filter_id	Gets the filter_id of this ExportImportMetricGroupSummary.
freeform_tags	Gets the freeform_tags of this ExportImportConfigSummary.
id	Gets the id of this ExportImportConfigSummary.
metrics	Gets the metrics of this ExportImportMetricGroupSummary.
namespace	Gets the namespace of this ExportImportMetricGroupSummary.

Methods:

__init__(**kwargs)	Initializes a new ExportImportMetricGroupSummary 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 ExportImportConfigSummary. This constant has a value of “AGENT”

CONFIG_TYPE_APDEX = 'APDEX'

A constant which can be used with the config_type property of a ExportImportConfigSummary. 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 ExportImportConfigSummary. 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 ExportImportConfigSummary. 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 ExportImportConfigSummary. 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 ExportImportConfigSummary. This constant has a value of “SPAN_FILTER”

__init__(**kwargs)

Initializes a new ExportImportMetricGroupSummary 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

• id (str) – The value to assign to the id property of this ExportImportMetricGroupSummary.

• config_type (str) – The value to assign to the config_type property of this ExportImportMetricGroupSummary. 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 ExportImportMetricGroupSummary.

• defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this ExportImportMetricGroupSummary.

• display_name (str) – The value to assign to the display_name property of this ExportImportMetricGroupSummary.

• filter_id (str) – The value to assign to the filter_id property of this ExportImportMetricGroupSummary.

• namespace (str) – The value to assign to the namespace property of this ExportImportMetricGroupSummary.

• dimensions (list[oci.apm_config.models.Dimension]) – The value to assign to the dimensions property of this ExportImportMetricGroupSummary.

• metrics (list[oci.apm_config.models.Metric]) – The value to assign to the metrics property of this ExportImportMetricGroupSummary.

property config_type

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

Allowed values for this property are: “SPAN_FILTER”, “METRIC_GROUP”, “APDEX”, “OPTIONS”, “AGENT”, “MACS_APM_EXTENSION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The config_type of this ExportImportConfigSummary.

Return type

str

property defined_tags

Gets the defined_tags of this ExportImportConfigSummary. 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 ExportImportConfigSummary.

Return type

dict(str, dict(str, object))

property dimensions

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

Returns

The dimensions of this ExportImportMetricGroupSummary.

Return type

list[oci.apm_config.models.Dimension]

property display_name

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

Returns

The display_name of this ExportImportMetricGroupSummary.

Return type

str

property filter_id

Gets the filter_id of this ExportImportMetricGroupSummary. 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 ExportImportMetricGroupSummary.

Return type

str

property freeform_tags

Gets the freeform_tags of this ExportImportConfigSummary. 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 ExportImportConfigSummary.

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 id

Gets the id of this ExportImportConfigSummary. The OCID of the configuration item. An OCID is generated when the item is created.

Returns

The id of this ExportImportConfigSummary.

Return type

str

property metrics

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

Returns

The metrics of this ExportImportMetricGroupSummary.

Return type

list[oci.apm_config.models.Metric]

property namespace

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

Returns

The namespace of this ExportImportMetricGroupSummary.

Return type

str