Class TimeSeries

java.lang.Object
software.amazon.awssdk.services.lookoutmetrics.model.TimeSeries
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<TimeSeries.Builder,TimeSeries>
@Generated("software.amazon.awssdk:codegen") public final class TimeSeries extends Object implements SdkPojo, Serializable, ToCopyableBuilder<TimeSeries.Builder,TimeSeries>

Details about a metric. A metric is an aggregation of the values of a measure for a dimension value, such as availability in the us-east-1 Region.

See Also:

  • Method Details

    • timeSeriesId

      public final String timeSeriesId()

      The ID of the metric.

      Returns:
      The ID of the metric.

    • hasDimensionList

      public final boolean hasDimensionList()
      For responses, this returns true if the service returned a value for the DimensionList 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.

    • dimensionList

      public final List<DimensionNameValue> dimensionList()

      The dimensions of 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 hasDimensionList() method.

      Returns:
      The dimensions of the metric.

    • hasMetricValueList

      public final boolean hasMetricValueList()
      For responses, this returns true if the service returned a value for the MetricValueList 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.

    • metricValueList

      public final List<Double> metricValueList()

      The values for 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 hasMetricValueList() method.

      Returns:
      The values for the metric.

    • toBuilder

      public TimeSeries.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<TimeSeries.Builder,TimeSeries>
      Returns:
      a builder for type T

    • builder

      public static TimeSeries.Builder builder()

    • serializableBuilderClass

      public static Class<? extends TimeSeries.Builder> serializableBuilderClass()

    • hashCode

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

    • equals

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

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

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

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.