software.amazon.awssdk.services.timestreamwrite.model

Class Record

java.lang.Object

software.amazon.awssdk.services.timestreamwrite.model.Record

All Implemented Interfaces:

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

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

Record represents a time series data point being written into Timestream. Each record contains an array of dimensions. Dimensions represent the meta data attributes of a time series data point such as the instance name or availability zone of an EC2 instance. A record also contains the measure name which is the name of the measure being collected for example the CPU utilization of an EC2 instance. A record also contains the measure value and the value type which is the data type of the measure value. In addition, the record contains the timestamp when the measure was collected that the timestamp unit which represents the granularity of the timestamp.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Record.Builder

Method Summary

Modifier and Type	Method and Description
static Record.Builder	builder()
List<Dimension>	dimensions() Contains the list of dimensions for time series data points.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDimensions() Returns true if the Dimensions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
String	measureName() Measure represents the data attribute of the time series.
String	measureValue() Contains the measure value for the time series data point.
MeasureValueType	measureValueType() Contains the data type of the measure value for the time series data point.
String	measureValueTypeAsString() Contains the data type of the measure value for the time series data point.
List<SdkField<?>>	sdkFields()
static Class<? extends Record.Builder>	serializableBuilderClass()
String	time() Contains the time at which the measure value for the data point was collected.
TimeUnit	timeUnit() The granularity of the timestamp unit.
String	timeUnitAsString() The granularity of the timestamp unit.
Record.Builder	toBuilder()
String	toString() Returns a string representation of this object.
Long	version() 64-bit attribute used for record updates.

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

hasDimensions

public final boolean hasDimensions()

Returns true if the Dimensions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

dimensions

public final List<Dimension> dimensions()

Contains the list of dimensions for time series data points.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasDimensions() to see if a value was sent in this field.

Returns:

Contains the list of dimensions for time series data points.

measureName

public final String measureName()

Measure represents the data attribute of the time series. For example, the CPU utilization of an EC2 instance or the RPM of a wind turbine are measures.

Returns:

Measure represents the data attribute of the time series. For example, the CPU utilization of an EC2 instance or the RPM of a wind turbine are measures.

measureValue

public final String measureValue()

Contains the measure value for the time series data point.

Returns:

Contains the measure value for the time series data point.

measureValueType

public final MeasureValueType measureValueType()

Contains the data type of the measure value for the time series data point.

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

Returns:

Contains the data type of the measure value for the time series data point.

See Also:

MeasureValueType

measureValueTypeAsString

public final String measureValueTypeAsString()

Contains the data type of the measure value for the time series data point.

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

Returns:

Contains the data type of the measure value for the time series data point.

See Also:

MeasureValueType

time

public final String time()

Contains the time at which the measure value for the data point was collected. The time value plus the unit provides the time elapsed since the epoch. For example, if the time value is 12345 and the unit is ms, then 12345 ms have elapsed since the epoch.

Returns:

Contains the time at which the measure value for the data point was collected. The time value plus the unit provides the time elapsed since the epoch. For example, if the time value is 12345 and the unit is ms, then 12345 ms have elapsed since the epoch.

timeUnit

public final TimeUnit timeUnit()

The granularity of the timestamp unit. It indicates if the time value is in seconds, milliseconds, nanoseconds or other supported values.

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

Returns:

The granularity of the timestamp unit. It indicates if the time value is in seconds, milliseconds, nanoseconds or other supported values.

See Also:

TimeUnit

timeUnitAsString

public final String timeUnitAsString()

The granularity of the timestamp unit. It indicates if the time value is in seconds, milliseconds, nanoseconds or other supported values.

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

Returns:

The granularity of the timestamp unit. It indicates if the time value is in seconds, milliseconds, nanoseconds or other supported values.

See Also:

TimeUnit

version

public final Long version()

64-bit attribute used for record updates. Write requests for duplicate data with a higher version number will update the existing measure value and version. In cases where the measure value is the same, Version will still be updated . Default value is to 1.

Returns:

64-bit attribute used for record updates. Write requests for duplicate data with a higher version number will update the existing measure value and version. In cases where the measure value is the same, Version will still be updated . Default value is to 1.

toBuilder

public Record.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Record.Builder,Record>

builder

public static Record.Builder builder()

serializableBuilderClass

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