Class SummaryMetricQueryResult

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

The result of the summary metrics aggregation operation.

See Also:

  • Method Details

    • queryId

      public final String queryId()

      The ID of the summary metric results query operation.

      Returns:
      The ID of the summary metric results query operation.

    • queryStatus

      public final MetricQueryStatus queryStatus()

      The status of the summary metric query result.

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

      Returns:
      The status of the summary metric query result.
      See Also:

    • queryStatusAsString

      public final String queryStatusAsString()

      The status of the summary metric query result.

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

      Returns:
      The status of the summary metric query result.
      See Also:

    • error

      public final String error()

      The error message for the summary metric query result.

      Returns:
      The error message for the summary metric query result.

    • metricName

      public final MetricName metricName()

      The name of the summary metric query result.

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

      Returns:
      The name of the summary metric query result.
      See Also:

    • metricNameAsString

      public final String metricNameAsString()

      The name of the summary metric query result.

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

      Returns:
      The name of the summary metric query result.
      See Also:

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

      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 hasDimensions() method.

      Returns:
      The dimensions of the metric.

    • aggregationPeriod

      public final AggregationPeriod aggregationPeriod()

      The aggregation period of the metric.

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

      Returns:
      The aggregation period of the metric.
      See Also:

    • aggregationPeriodAsString

      public final String aggregationPeriodAsString()

      The aggregation period of the metric.

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

      Returns:
      The aggregation period of the metric.
      See Also:

    • startTimestamp

      public final Instant startTimestamp()

      The start timestamp for the summary metric query.

      Returns:
      The start timestamp for the summary metric query.

    • endTimestamp

      public final Instant endTimestamp()

      The end timestamp for the summary metric query.

      Returns:
      The end timestamp for the summary metric query.

    • hasTimestamps

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

    • timestamps

      public final List<Instant> timestamps()

      The timestamp of each aggregation result.

      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 hasTimestamps() method.

      Returns:
      The timestamp of each aggregation result.

    • hasValues

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

    • values

      public final List<MetricQueryValue> values()

      The list of aggregated summary metric query results.

      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 hasValues() method.

      Returns:
      The list of aggregated summary metric query results.

    • unit

      public final String unit()

      The units of measurement to be used for interpreting the aggregation result.

      Returns:
      The units of measurement to be used for interpreting the aggregation result.

    • toBuilder

      public SummaryMetricQueryResult.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<SummaryMetricQueryResult.Builder,SummaryMetricQueryResult>
      Returns:
      a builder for type T

    • builder

      public static SummaryMetricQueryResult.Builder builder()

    • serializableBuilderClass

      public static Class<? extends SummaryMetricQueryResult.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.