@Generated(value="OracleSDKGenerator", comments="API Version: 20180401") public final class ListMetricsDetails extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
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.
Note: Objects should always be created or deserialized using the ListMetricsDetails.Builder
. This model
distinguishes fields that are null
because they are unset from fields that are explicitly
set to null
. This is done in the setter methods of the ListMetricsDetails.Builder
, which maintain a
set of all explicitly set fields called ListMetricsDetails.Builder.__explicitlySet__
. The hashCode()
and equals(Object)
methods are implemented to take the explicitly set
fields into account. The constructor, on the other hand, does not take the explicitly set fields
into account (since the constructor cannot distinguish explicit null
from unset null
).
Modifier and Type | Class and Description |
---|---|
static class |
ListMetricsDetails.Builder |
static class |
ListMetricsDetails.SortBy
The field to use when sorting returned metric definitions.
|
static class |
ListMetricsDetails.SortOrder
The sort order to use when sorting returned metric definitions.
|
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME
Constructor and Description |
---|
ListMetricsDetails(String name,
String namespace,
String resourceGroup,
Map<String,String> dimensionFilters,
List<String> groupBy,
ListMetricsDetails.SortBy sortBy,
ListMetricsDetails.SortOrder sortOrder)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
static ListMetricsDetails.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
Map<String,String> |
getDimensionFilters()
Qualifiers that you want to use when searching for metric definitions.
|
List<String> |
getGroupBy()
Group metrics by these fields in the response.
|
String |
getName()
The metric name to use when searching for metric definitions.
|
String |
getNamespace()
The source service or application to use when searching for metric definitions.
|
String |
getResourceGroup()
Resource group that you want to match.
|
ListMetricsDetails.SortBy |
getSortBy()
The field to use when sorting returned metric definitions.
|
ListMetricsDetails.SortOrder |
getSortOrder()
The sort order to use when sorting returned metric definitions.
|
int |
hashCode() |
ListMetricsDetails.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet
@Deprecated @ConstructorProperties(value={"name","namespace","resourceGroup","dimensionFilters","groupBy","sortBy","sortOrder"}) public ListMetricsDetails(String name, String namespace, String resourceGroup, Map<String,String> dimensionFilters, List<String> groupBy, ListMetricsDetails.SortBy sortBy, ListMetricsDetails.SortOrder sortOrder)
public static ListMetricsDetails.Builder builder()
Create a new builder.
public ListMetricsDetails.Builder toBuilder()
public String getName()
The metric name to use when searching for metric definitions.
Example: CpuUtilization
public String getNamespace()
The source service or application to use when searching for metric definitions.
Example: oci_computeagent
public String getResourceGroup()
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 ($).
Example: frontend-fleet
public Map<String,String> getDimensionFilters()
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": "ocid1.instance.region1.phx.exampleuniqueID"}
public List<String> getGroupBy()
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 groupBy
is used, then dimensionFilters
is ignored.
Example - group by namespace: [ "namespace" ]
public ListMetricsDetails.SortBy getSortBy()
The field to use when sorting returned metric definitions. Only one sorting level is provided.
Example: NAMESPACE
public ListMetricsDetails.SortOrder getSortOrder()
The sort order to use when sorting returned metric definitions. Ascending (ASC) or descending (DESC).
Example: ASC
public String toString()
toString
in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
public String toString(boolean includeByteArrayContents)
Return a string representation of the object.
includeByteArrayContents
- true to include the full contents of byte arrayspublic boolean equals(Object o)
equals
in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
public int hashCode()
hashCode
in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
Copyright © 2016–2024. All rights reserved.