ListMetricsDetails¶

class oci.monitoring.models.ListMetricsDetails(**kwargs)¶

Bases: object

The request details for retrieving metric definitions. Specify optional properties to filter the returned results. Use an asterisk (*) as a wildcard character, placed anywhere in the string. For example, to search for all metrics with names that begin with “disk”, specify “name” as “disk*”. If no properties are specified, then all metric definitions within the request scope are returned.

Attributes

`SORT_BY_NAME`	A constant which can be used with the sort_by property of a ListMetricsDetails.
`SORT_BY_NAMESPACE`	A constant which can be used with the sort_by property of a ListMetricsDetails.
`SORT_BY_RESOURCEGROUP`	A constant which can be used with the sort_by property of a ListMetricsDetails.
`SORT_ORDER_ASC`	A constant which can be used with the sort_order property of a ListMetricsDetails.
`SORT_ORDER_DESC`	A constant which can be used with the sort_order property of a ListMetricsDetails.
`dimension_filters`	Gets the dimension_filters of this ListMetricsDetails.
`group_by`	Gets the group_by of this ListMetricsDetails.
`name`	Gets the name of this ListMetricsDetails.
`namespace`	Gets the namespace of this ListMetricsDetails.
`resource_group`	Gets the resource_group of this ListMetricsDetails.
`sort_by`	Gets the sort_by of this ListMetricsDetails.
`sort_order`	Gets the sort_order of this ListMetricsDetails.

Methods

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

SORT_BY_NAME = 'NAME'¶: A constant which can be used with the sort_by property of a ListMetricsDetails. This constant has a value of “NAME”

SORT_BY_NAMESPACE = 'NAMESPACE'¶: A constant which can be used with the sort_by property of a ListMetricsDetails. This constant has a value of “NAMESPACE”

SORT_BY_RESOURCEGROUP = 'RESOURCEGROUP'¶: A constant which can be used with the sort_by property of a ListMetricsDetails. This constant has a value of “RESOURCEGROUP”

SORT_ORDER_ASC = 'ASC'¶: A constant which can be used with the sort_order property of a ListMetricsDetails. This constant has a value of “ASC”

SORT_ORDER_DESC = 'DESC'¶: A constant which can be used with the sort_order property of a ListMetricsDetails. This constant has a value of “DESC”

__init__(**kwargs)¶

Initializes a new ListMetricsDetails 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 ListMetricsDetails.
namespace (str) – The value to assign to the namespace property of this ListMetricsDetails.
resource_group (str) – The value to assign to the resource_group property of this ListMetricsDetails.
dimension_filters (dict(str, str)) – The value to assign to the dimension_filters property of this ListMetricsDetails.
group_by (list[str]) – The value to assign to the group_by property of this ListMetricsDetails.
sort_by (str) – The value to assign to the sort_by property of this ListMetricsDetails. Allowed values for this property are: “NAMESPACE”, “NAME”, “RESOURCEGROUP”
sort_order (str) – The value to assign to the sort_order property of this ListMetricsDetails. Allowed values for this property are: “ASC”, “DESC”

dimension_filters¶

Gets the dimension_filters of this ListMetricsDetails. Qualifiers that you want to use when searching for metric definitions. Available dimensions vary by metric namespace. Each dimension takes the form of a key-value pair.

Example: { “resourceId”: “<var><instance_OCID></var>” }

Returns:	The dimension_filters of this ListMetricsDetails.
Return type:	dict(str, str)

group_by¶

Gets the group_by of this ListMetricsDetails. Group metrics by these fields in the response. For example, to list all metric namespaces available

in a compartment, groupBy the “namespace” field. Supported fields: namespace, name, resourceGroup.

Example - group by namespace: [ “namespace” ]

Returns:	The group_by of this ListMetricsDetails.
Return type:	list[str]

name¶

Gets the name of this ListMetricsDetails. The metric name to use when searching for metric definitions.

Example: CpuUtilization

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

namespace¶

Gets the namespace of this ListMetricsDetails. The source service or application to use when searching for metric definitions.

Example: oci_computeagent

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

resource_group¶

Gets the resource_group of this ListMetricsDetails. Resource group that you want to use as a filter. The specified resource group must exist in the definition of the posted metric. Only one resource group can be applied per metric. A valid resourceGroup value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($). Avoid entering confidential information.

Example: frontend-fleet

Returns:	The resource_group of this ListMetricsDetails.
Return type:	str

sort_by¶

Gets the sort_by of this ListMetricsDetails. The field to use when sorting returned metric definitions. Only one sorting level is provided.

Example: NAMESPACE

Allowed values for this property are: “NAMESPACE”, “NAME”, “RESOURCEGROUP”

Returns:	The sort_by of this ListMetricsDetails.
Return type:	str

sort_order¶

Gets the sort_order of this ListMetricsDetails. The sort order to use when sorting returned metric definitions. Ascending (ASC) or descending (DESC).

Example: ASC

Allowed values for this property are: “ASC”, “DESC”

Returns:	The sort_order of this ListMetricsDetails.
Return type:	str