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

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

Overview

Note:

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

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

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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#dimensionsArray<Types::Dimension>

Contains the list of dimensions for time series data points.

Returns:



620
621
622
623
624
625
626
627
628
629
630
# File 'gems/aws-sdk-timestreamwrite/lib/aws-sdk-timestreamwrite/types.rb', line 620

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

#measure_nameString

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)


620
621
622
623
624
625
626
627
628
629
630
# File 'gems/aws-sdk-timestreamwrite/lib/aws-sdk-timestreamwrite/types.rb', line 620

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

#measure_valueString

Contains the measure value for the time series data point.

Returns:

  • (String)


620
621
622
623
624
625
626
627
628
629
630
# File 'gems/aws-sdk-timestreamwrite/lib/aws-sdk-timestreamwrite/types.rb', line 620

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

#measure_value_typeString

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

Returns:

  • (String)


620
621
622
623
624
625
626
627
628
629
630
# File 'gems/aws-sdk-timestreamwrite/lib/aws-sdk-timestreamwrite/types.rb', line 620

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

#timeString

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)


620
621
622
623
624
625
626
627
628
629
630
# File 'gems/aws-sdk-timestreamwrite/lib/aws-sdk-timestreamwrite/types.rb', line 620

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

#time_unitString

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

Returns:

  • (String)


620
621
622
623
624
625
626
627
628
629
630
# File 'gems/aws-sdk-timestreamwrite/lib/aws-sdk-timestreamwrite/types.rb', line 620

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

#versionInteger

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:

  • (Integer)


620
621
622
623
624
625
626
627
628
629
630
# File 'gems/aws-sdk-timestreamwrite/lib/aws-sdk-timestreamwrite/types.rb', line 620

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