timestreamwrite/aws.sdk.kotlin.services.timestreamwrite.model/Record

Record

Represents a time-series data point being written into Timestream. Each record contains an array of dimensions. Dimensions represent the metadata 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). Additionally, a record contains the measure value and the value type, which is the data type of the measure value. Also, the record contains the timestamp of when the measure was collected and the timestamp unit, which represents the granularity of the timestamp.

Records have a Version field, which is a 64-bit long that you can use for updating data points. Writes of a duplicate record with the same dimension, timestamp, and measure name but different measure value will only succeed if the Version attribute of the record in the write request is higher than that of the existing record. Timestream defaults to a Version of 1 for records without the Version field.

Types

Builder

class Builder

Companion

object Companion

Properties

dimensions

val dimensions: List<Dimension>?

Contains the list of dimensions for time-series data points.

measureName

val measureName: String?

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

val measureValue: String?

Contains the measure value for the time-series data point.

measureValues

val measureValues: List<MeasureValue>?

Contains the list of MeasureValue for time-series data points.

measureValueType

val measureValueType: MeasureValueType?

Contains the data type of the measure value for the time-series data point. Default type is DOUBLE. For more information, see Data types.

time

val time: String?

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

val timeUnit: TimeUnit?

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

version

val version: Long?

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 1.

Functions

copy

inline fun copy(block: Record.Builder.() -> Unit = {}): Record

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String