Package com.oracle.bmc.monitoring.model

Class SummarizeMetricsDataDetails

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20180401")
public final class SummarizeMetricsDataDetails
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    The request details for retrieving aggregated data.

    Use the query and optional properties to filter the returned results.
    Note: Objects should always be created or deserialized using the SummarizeMetricsDataDetails.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 SummarizeMetricsDataDetails.Builder, which maintain a set of all explicitly set fields called SummarizeMetricsDataDetails.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

      • getNamespace

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

        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

      • getQuery

        public String getQuery()
        The Monitoring Query Language (MQL) expression to use when searching for metric data points to aggregate.

        The query must specify a metric, statistic, and interval. Supported values for interval depend on the specified time range. More interval values are supported for smaller time ranges. You can optionally specify dimensions and grouping functions. When specifying a dimension value, surround it with double quotes, and escape each double quote with a backslash (\) character. Supported grouping functions: grouping(), groupBy().

        Construct your query to avoid exceeding limits on returned data. See MetricData.

        For details about Monitoring Query Language (MQL), see [Monitoring Query Language (MQL) Reference](https://docs.oracle.com/iaas/Content/Monitoring/Reference/mql.htm). For available dimensions, review the metric definition for the supported service. See [Supported Services](https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#SupportedServices).

        Example 1: CpuUtilization[1m].sum()

        Example 2 (escaped double quotes for value string): CpuUtilization[1m]{resourceId = \\"<instance_OCID>\\"}.max()

        Returns:
        the value

      • getStartTime

        public Date getStartTime()
        The beginning of the time range to use when searching for metric data points.

        Format is defined by RFC3339. The response includes metric data points for the startTime. Default value: the timestamp 3 hours before the call was sent.

        Example: 2023-02-01T01:02:29.600Z

        Returns:
        the value

      • getEndTime

        public Date getEndTime()
        The end of the time range to use when searching for metric data points.

        Format is defined by RFC3339. The response excludes metric data points for the endTime. Default value: the timestamp representing when the call was sent.

        Example: 2023-02-01T02:02:29.600Z

        Returns:
        the value

      • getResolution

        public String getResolution()
        The time between calculated aggregation windows.

        Use with the query interval to vary the frequency for returning aggregated data points. For example, use a query interval of 5 minutes with a resolution of 1 minute to retrieve five-minute aggregations at a one-minute frequency. The resolution must be equal or less than the interval in the query. The default resolution is 1m (one minute). Supported values: 1m-60m, 1h- 24h, 1d.

        Example: 5m

        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