software.amazon.awssdk.services.timestreamquery.model

Class Datum

java.lang.Object

software.amazon.awssdk.services.timestreamquery.model.Datum

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Datum.Builder,Datum>

@Generated(value="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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Datum.Builder

Method Summary

Modifier and Type	Method and Description
List<Datum>	arrayValue() Indicates if the data point is an array.
static Datum.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasArrayValue() For responses, this returns true if the service returned a value for the ArrayValue property.
int	hashCode()
boolean	hasTimeSeriesValue() For responses, this returns true if the service returned a value for the TimeSeriesValue property.
Boolean	nullValue() Indicates if the data point is null.
Row	rowValue() Indicates if the data point is a row.
String	scalarValue() Indicates if the data point is a scalar value such as integer, string, double, or Boolean.
List<SdkField<?>>	sdkFields()
static Class<? extends Datum.Builder>	serializableBuilderClass()
List<TimeSeriesDataPoint>	timeSeriesValue() Indicates if the data point is a timeseries data type.
Datum.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

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

Specified by:

toBuilder in interface ToCopyableBuilder<Datum.Builder,Datum>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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