java.lang.Object
software.amazon.awssdk.services.timestreamquery.model.Datum
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Datum.Builder,Datum>

@Generated("software.amazon.awssdk:codegen") public final class Datum extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Datum.Builder,Datum>

Datum represents a single data point in a query result.

See Also:
  • Method Details

    • scalarValue

      public final String scalarValue()

      Indicates if the data point is a scalar value such as integer, string, double, or Boolean.

      Returns:
      Indicates if the data point is a scalar value such as integer, string, double, or Boolean.
    • hasTimeSeriesValue

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

      public final List<TimeSeriesDataPoint> timeSeriesValue()

      Indicates if the data point is a timeseries data type.

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

      Returns:
      Indicates if the data point is a timeseries data type.
    • hasArrayValue

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

      public final List<Datum> arrayValue()

      Indicates if the data point is an array.

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

      Returns:
      Indicates if the data point is an array.
    • rowValue

      public final Row rowValue()

      Indicates if the data point is a row.

      Returns:
      Indicates if the data point is a row.
    • nullValue

      public final Boolean nullValue()

      Indicates if the data point is null.

      Returns:
      Indicates if the data point is null.
    • toBuilder

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

      public static Datum.Builder builder()
    • serializableBuilderClass

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