Package com.oracle.bmc.monitoring.model

Class MetricDataDetails

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20180401")
public final class MetricDataDetails
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    A metric object containing raw metric data points to be posted to the Monitoring service.
    Note: Objects should always be created or deserialized using the MetricDataDetails.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 MetricDataDetails.Builder, which maintain a set of all explicitly set fields called MetricDataDetails.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 emitting the metric.

        A valid namespace value starts with an alphabetical character and includes only alphanumeric characters and underscores. Custom metrics can't use the following reserved prefixes: oci_ and oracle_ Avoid entering confidential information.

        Example: my_namespace

        Returns:
        the value

      • getResourceGroup

        public String getResourceGroup()
        Resource group to assign to the metric.

        A resource group is a custom string that you can match when retrieving custom metrics. 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

        Returns:
        the value

      • getCompartmentId

        public String getCompartmentId()
        The OCID of the compartment to use for metrics.
        Returns:
        the value

      • getName

        public String getName()
        The name of the metric.

        A valid name value starts with an alphabetical character and includes only alphanumeric characters, dots, underscores, hyphens, and dollar signs. Avoid entering confidential information.

        Example: my_app.success_rate

        Returns:
        the value

      • getDimensions

        public Map<String,​String> getDimensions()
        Qualifiers provided in a metric definition.

        Available dimensions vary by metric namespace. Each dimension takes the form of a key-value pair. A valid dimension key includes only printable ASCII, excluding spaces. The character limit for a dimension key is 256. A valid dimension value includes only Unicode characters. The character limit for a dimension value is 512. Empty strings are not allowed for keys or values. Avoid entering confidential information.

        Example: {"resourceId": "ocid1.instance.region1.phx.exampleuniqueID"}

        Returns:
        the value

      • getMetadata

        public Map<String,​String> getMetadata()
        Properties describing metrics.

        These are not part of the unique fields identifying the metric. Each metadata item takes the form of a key-value pair. The character limit for a metadata key is 256. The character limit for a metadata value is 256.

        Example: "unit": "bytes"

        Returns:
        the value

      • getDatapoints

        public List<Datapoint> getDatapoints()
        A list of metric values with timestamps.

        At least one data point is required per call. For a data point to be posted, its timestamp must be near current time (less than two hours in the past and less than 10 minutes in the future).

        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