Class MetricDatum

    • Method Detail

      • hasDimensions

        public final boolean hasDimensions()
        For responses, this returns true if the service returned a value for the Dimensions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • dimensions

        public final List<Dimension> dimensions()

        Internal only. The dimensions associated with the metric.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDimensions() method.

        Returns:
        Internal only. The dimensions associated with the metric.
      • metricName

        public final String metricName()

        Internal only. The name of the metric.

        Returns:
        Internal only. The name of the metric.
      • statisticValues

        public final StatisticSet statisticValues()

        Internal only. The statistical values for the metric.

        Returns:
        Internal only. The statistical values for the metric.
      • timestamp

        public final Instant timestamp()

        Internal only. The time the metric data was received.

        Returns:
        Internal only. The time the metric data was received.
      • unit

        public final Unit unit()

        Internal only. The unit used to store the metric.

        If the service returns an enum value that is not available in the current SDK version, unit will return Unit.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from unitAsString().

        Returns:
        Internal only. The unit used to store the metric.
        See Also:
        Unit
      • unitAsString

        public final String unitAsString()

        Internal only. The unit used to store the metric.

        If the service returns an enum value that is not available in the current SDK version, unit will return Unit.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from unitAsString().

        Returns:
        Internal only. The unit used to store the metric.
        See Also:
        Unit
      • value

        public final Double value()

        Internal only. The value for the metric.

        Returns:
        Internal only. The value for the metric.
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object
      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                                      Class<T> clazz)