com.oracle.bmc.monitoring.model

Class ListMetricsDetails

java.lang.Object

com.oracle.bmc.monitoring.model.ListMetricsDetails

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20180401")
public final class ListMetricsDetails
extends 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.

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 __explicitlySet__. The hashCode() and equals(Object) methods are implemented to take __explicitlySet__ into account. The constructor, on the other hand, does not set __explicitlySet__ (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

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.

Constructor Summary

Constructors

Constructor and Description
ListMetricsDetails(String name, String namespace, String resourceGroup, Map<String,String> dimensionFilters, List<String> groupBy, ListMetricsDetails.SortBy sortBy, ListMetricsDetails.SortOrder sortOrder) Deprecated.

Method Summary

Modifier and Type	Method and Description
static ListMetricsDetails.Builder	builder() Create a new builder.
boolean	equals(Object o)
Set<String>	get__explicitlySet__()
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 use as a filter.
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()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListMetricsDetails

@ConstructorProperties(value={"name","namespace","resourceGroup","dimensionFilters","groupBy","sortBy","sortOrder"})
 @Deprecated
public ListMetricsDetails(String name,
                                                                                                                                                            String namespace,
                                                                                                                                                            String resourceGroup,
                                                                                                                                                            Map<String,String> dimensionFilters,
                                                                                                                                                            List<String> groupBy,
                                                                                                                                                            ListMetricsDetails.SortBy sortBy,
                                                                                                                                                            ListMetricsDetails.SortOrder sortOrder)

Deprecated.

Method Detail

builder

public static ListMetricsDetails.Builder builder()

Create a new builder.

getName

public String getName()

The metric name to use when searching for metric definitions.

Example: CpuUtilization

getNamespace

public String getNamespace()

The source service or application to use when searching for metric definitions.

Example: oci_computeagent

getResourceGroup

public String getResourceGroup()

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

getDimensionFilters

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": "<instance_OCID>" }

getGroupBy

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.

Example - group by namespace: [ \"namespace\" ]

getSortBy

public ListMetricsDetails.SortBy getSortBy()

The field to use when sorting returned metric definitions. Only one sorting level is provided.

Example: NAMESPACE

getSortOrder

public ListMetricsDetails.SortOrder getSortOrder()

The sort order to use when sorting returned metric definitions. Ascending (ASC) or descending (DESC).

Example: ASC

get__explicitlySet__

public Set<String> get__explicitlySet__()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object