Class ListMetricsDetails
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.
Inherited Members
Namespace: Oci.MonitoringService.Models
Assembly: OCI.DotNetSDK.Monitoring.dll
Syntax
public class ListMetricsDetails
Properties
DimensionFilters
Declaration
[JsonProperty(PropertyName = "dimensionFilters")]
public Dictionary<string, string> DimensionFilters { get; set; }
Property Value
Type | Description |
---|---|
Dictionary<string, string> | 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.
|
GroupBy
Declaration
[JsonProperty(PropertyName = "groupBy")]
public List<string> GroupBy { get; set; }
Property Value
Type | Description |
---|---|
List<string> | 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.
If |
Name
Declaration
[JsonProperty(PropertyName = "name")]
public string Name { get; set; }
Property Value
Type | Description |
---|---|
string | The metric name to use when searching for metric definitions.
|
Namespace
Declaration
[JsonProperty(PropertyName = "namespace")]
public string Namespace { get; set; }
Property Value
Type | Description |
---|---|
string | The source service or application to use when searching for metric definitions.
|
ResourceGroup
Declaration
[JsonProperty(PropertyName = "resourceGroup")]
public string ResourceGroup { get; set; }
Property Value
Type | Description |
---|---|
string | Resource group that you want to match. A null value returns only metric data that has no resource groups. 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 ($).
|
SortBy
Declaration
[JsonProperty(PropertyName = "sortBy")]
[JsonConverter(typeof(StringEnumConverter))]
public ListMetricsDetails.SortByEnum? SortBy { get; set; }
Property Value
Type | Description |
---|---|
ListMetricsDetails.SortByEnum? | The field to use when sorting returned metric definitions. Only one sorting level is provided.
|
SortOrder
Declaration
[JsonProperty(PropertyName = "sortOrder")]
[JsonConverter(typeof(StringEnumConverter))]
public ListMetricsDetails.SortOrderEnum? SortOrder { get; set; }
Property Value
Type | Description |
---|---|
ListMetricsDetails.SortOrderEnum? | The sort order to use when sorting returned metric definitions. Ascending (ASC) or
descending (DESC).
|