Class: Aws::TimestreamWrite::Types::Record

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-timestreamwrite/types.rb

Overview

Note:

When making an API call, you may pass Record data as a hash:

{
  dimensions: [
    {
      name: "SchemaName", # required
      value: "SchemaValue", # required
      dimension_value_type: "VARCHAR", # accepts VARCHAR
    },
  ],
  measure_name: "SchemaName",
  measure_value: "StringValue2048",
  measure_value_type: "DOUBLE", # accepts DOUBLE, BIGINT, VARCHAR, BOOLEAN, TIMESTAMP, MULTI
  time: "StringValue256",
  time_unit: "MILLISECONDS", # accepts MILLISECONDS, SECONDS, MICROSECONDS, NANOSECONDS
  version: 1,
  measure_values: [
    {
      name: "SchemaName", # required
      value: "StringValue2048", # required
      type: "DOUBLE", # required, accepts DOUBLE, BIGINT, VARCHAR, BOOLEAN, TIMESTAMP, MULTI
    },
  ],
}

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.

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.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#dimensions ⇒ Array<Types::Dimension>

Contains the list of dimensions for time series data points.

Returns:



776
777
778
779
780
781
782
783
784
785
786
787
 
# File 'lib/aws-sdk-timestreamwrite/types.rb', line 776

class Record < Struct.new(
  :dimensions,
  :measure_name,
  :measure_value,
  :measure_value_type,
  :time,
  :time_unit,
  :version,
  :measure_values)
  SENSITIVE = []
  include Aws::Structure
end

#measure_name ⇒ 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.

Returns:

  • (String) 


776
777
778
779
780
781
782
783
784
785
786
787
 
# File 'lib/aws-sdk-timestreamwrite/types.rb', line 776

class Record < Struct.new(
  :dimensions,
  :measure_name,
  :measure_value,
  :measure_value_type,
  :time,
  :time_unit,
  :version,
  :measure_values)
  SENSITIVE = []
  include Aws::Structure
end

#measure_value ⇒ String

Contains the measure value for the time series data point.

Returns:

  • (String) 


776
777
778
779
780
781
782
783
784
785
786
787
 
# File 'lib/aws-sdk-timestreamwrite/types.rb', line 776

class Record < Struct.new(
  :dimensions,
  :measure_name,
  :measure_value,
  :measure_value_type,
  :time,
  :time_unit,
  :version,
  :measure_values)
  SENSITIVE = []
  include Aws::Structure
end

#measure_value_type ⇒ String

Contains the data type of the measure value for the time series data point. Default type is ‘DOUBLE`.

Returns:

  • (String) 


776
777
778
779
780
781
782
783
784
785
786
787
 
# File 'lib/aws-sdk-timestreamwrite/types.rb', line 776

class Record < Struct.new(
  :dimensions,
  :measure_name,
  :measure_value,
  :measure_value_type,
  :time,
  :time_unit,
  :version,
  :measure_values)
  SENSITIVE = []
  include Aws::Structure
end

#measure_values ⇒ Array<Types::MeasureValue>

Contains the list of MeasureValue for time series data points.

This is only allowed for type ‘MULTI`. For scalar values, use `MeasureValue` attribute of the Record directly.

Returns:



776
777
778
779
780
781
782
783
784
785
786
787
 
# File 'lib/aws-sdk-timestreamwrite/types.rb', line 776

class Record < Struct.new(
  :dimensions,
  :measure_name,
  :measure_value,
  :measure_value_type,
  :time,
  :time_unit,
  :version,
  :measure_values)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

  • (String) 


776
777
778
779
780
781
782
783
784
785
786
787
 
# File 'lib/aws-sdk-timestreamwrite/types.rb', line 776

class Record < Struct.new(
  :dimensions,
  :measure_name,
  :measure_value,
  :measure_value_type,
  :time,
  :time_unit,
  :version,
  :measure_values)
  SENSITIVE = []
  include Aws::Structure
end

#time_unit ⇒ String

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

Returns:

  • (String) 


776
777
778
779
780
781
782
783
784
785
786
787
 
# File 'lib/aws-sdk-timestreamwrite/types.rb', line 776

class Record < Struct.new(
  :dimensions,
  :measure_name,
  :measure_value,
  :measure_value_type,
  :time,
  :time_unit,
  :version,
  :measure_values)
  SENSITIVE = []
  include Aws::Structure
end

#version ⇒ Integer

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

<note markdown=“1”> ‘Version` must be `1` or greater, or you will receive a `ValidationException` error.

</note>

Returns:

  • (Integer) 


776
777
778
779
780
781
782
783
784
785
786
787
 
# File 'lib/aws-sdk-timestreamwrite/types.rb', line 776

class Record < Struct.new(
  :dimensions,
  :measure_name,
  :measure_value,
  :measure_value_type,
  :time,
  :time_unit,
  :version,
  :measure_values)
  SENSITIVE = []
  include Aws::Structure
end