Package com.oracle.bmc.monitoring.model

Class ListMetricsDetails

  • @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).

    • Method Detail

      • getName

        public String getName()
        The metric name to use when searching for metric definitions.

        Example: CpuUtilization

        Returns:
        the value

      • getNamespace

        public String getNamespace()
        The source service or application to use when searching for metric definitions.

        Example: oci_computeagent

        Returns:
        the value

      • getResourceGroup

        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

        Returns:
        the value

      • 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": "ocid1.instance.region1.phx.exampleuniqueID"}

        Returns:
        the value

      • 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. If groupBy is used, then dimensionFilters is ignored.

        Example - group by namespace: [ "namespace" ]

        Returns:
        the value

      • getSortBy

        public ListMetricsDetails.SortBy getSortBy()
        The field to use when sorting returned metric definitions.

        Only one sorting level is provided.

        Example: NAMESPACE

        Returns:
        the value

      • getSortOrder

        public ListMetricsDetails.SortOrder getSortOrder()
        The sort order to use when sorting returned metric definitions.

        Ascending (ASC) or descending (DESC).

        Example: ASC

        Returns:
        the value

      • toString

        public String toString()
        Overrides:
        toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • toString

        public String toString​(boolean includeByteArrayContents)
        Return a string representation of the object.
        Parameters:
        includeByteArrayContents - true to include the full contents of byte arrays
        Returns:
        string representation

      • equals

        public boolean equals​(Object o)
        Overrides:
        equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel