Class MetricValue

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

The value to be compared with the metric.

See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static interface 
    MetricValue.Builder
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static MetricValue.Builder
    builder()
     
    final List<String>
    cidrs()
    If the comparisonOperator calls for a set of CIDRs, use this to specify that set to be compared with the metric.
    final Long
    count()
    If the comparisonOperator calls for a numeric value, use this to specify that numeric value to be compared with the metric.
    final boolean
    equals(Object obj)
     
    final boolean
    equalsBySdkFields(Object obj)
    Indicates whether some other object is "equal to" this one by SDK fields.
    final <T> Optional<T>
    getValueForField(String fieldName, Class<T> clazz)
     
    final boolean
    hasCidrs()
    For responses, this returns true if the service returned a value for the Cidrs property.
    final int
    hashCode()
     
    final boolean
    hasNumbers()
    For responses, this returns true if the service returned a value for the Numbers property.
    final boolean
    hasPorts()
    For responses, this returns true if the service returned a value for the Ports property.
    final boolean
    hasStrings()
    For responses, this returns true if the service returned a value for the Strings property.
    final Double
    number()
    The numeral value of a metric.
    final List<Double>
    numbers()
    The numeral values of a metric.
    final List<Integer>
    ports()
    If the comparisonOperator calls for a set of ports, use this to specify that set to be compared with the metric.
    final List<SdkField<?>>
    sdkFields()
     
    static Class<? extends MetricValue.Builder>
    serializableBuilderClass()
     
    final List<String>
    strings()
    The string values of a metric.
    MetricValue.Builder
    toBuilder()
    Take this object and create a builder that contains all of the current property values of this object.
    final String
    toString()
    Returns a string representation of this object.

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

    copy

  • Method Details

    • count

      public final Long count()

      If the comparisonOperator calls for a numeric value, use this to specify that numeric value to be compared with the metric.

      Returns:
      If the comparisonOperator calls for a numeric value, use this to specify that numeric value to be compared with the metric.

    • hasCidrs

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

    • cidrs

      public final List<String> cidrs()

      If the comparisonOperator calls for a set of CIDRs, use this to specify that set to be compared 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 hasCidrs() method.

      Returns:
      If the comparisonOperator calls for a set of CIDRs, use this to specify that set to be compared with the metric.

    • hasPorts

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

    • ports

      public final List<Integer> ports()

      If the comparisonOperator calls for a set of ports, use this to specify that set to be compared 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 hasPorts() method.

      Returns:
      If the comparisonOperator calls for a set of ports, use this to specify that set to be compared with the metric.

    • number

      public final Double number()

      The numeral value of a metric.

      Returns:
      The numeral value of a metric.

    • hasNumbers

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

    • numbers

      public final List<Double> numbers()

      The numeral values of a 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 hasNumbers() method.

      Returns:
      The numeral values of a metric.

    • hasStrings

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

    • strings

      public final List<String> strings()

      The string values of a 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 hasStrings() method.

      Returns:
      The string values of a metric.

    • toBuilder

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

    • builder

      public static MetricValue.Builder builder()

    • serializableBuilderClass

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