AWS SDK for C++  1.9.175
AWS SDK for C++
Public Member Functions | List of all members
Aws::TimestreamWrite::Model::Record Class Reference

#include <Record.h>

Public Member Functions

 Record ()
 
 Record (Aws::Utils::Json::JsonView jsonValue)
 
Recordoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::Vector< Dimension > & GetDimensions () const
 
bool DimensionsHasBeenSet () const
 
void SetDimensions (const Aws::Vector< Dimension > &value)
 
void SetDimensions (Aws::Vector< Dimension > &&value)
 
RecordWithDimensions (const Aws::Vector< Dimension > &value)
 
RecordWithDimensions (Aws::Vector< Dimension > &&value)
 
RecordAddDimensions (const Dimension &value)
 
RecordAddDimensions (Dimension &&value)
 
const Aws::StringGetMeasureName () const
 
bool MeasureNameHasBeenSet () const
 
void SetMeasureName (const Aws::String &value)
 
void SetMeasureName (Aws::String &&value)
 
void SetMeasureName (const char *value)
 
RecordWithMeasureName (const Aws::String &value)
 
RecordWithMeasureName (Aws::String &&value)
 
RecordWithMeasureName (const char *value)
 
const Aws::StringGetMeasureValue () const
 
bool MeasureValueHasBeenSet () const
 
void SetMeasureValue (const Aws::String &value)
 
void SetMeasureValue (Aws::String &&value)
 
void SetMeasureValue (const char *value)
 
RecordWithMeasureValue (const Aws::String &value)
 
RecordWithMeasureValue (Aws::String &&value)
 
RecordWithMeasureValue (const char *value)
 
const MeasureValueTypeGetMeasureValueType () const
 
bool MeasureValueTypeHasBeenSet () const
 
void SetMeasureValueType (const MeasureValueType &value)
 
void SetMeasureValueType (MeasureValueType &&value)
 
RecordWithMeasureValueType (const MeasureValueType &value)
 
RecordWithMeasureValueType (MeasureValueType &&value)
 
const Aws::StringGetTime () const
 
bool TimeHasBeenSet () const
 
void SetTime (const Aws::String &value)
 
void SetTime (Aws::String &&value)
 
void SetTime (const char *value)
 
RecordWithTime (const Aws::String &value)
 
RecordWithTime (Aws::String &&value)
 
RecordWithTime (const char *value)
 
const TimeUnitGetTimeUnit () const
 
bool TimeUnitHasBeenSet () const
 
void SetTimeUnit (const TimeUnit &value)
 
void SetTimeUnit (TimeUnit &&value)
 
RecordWithTimeUnit (const TimeUnit &value)
 
RecordWithTimeUnit (TimeUnit &&value)
 
long long GetVersion () const
 
bool VersionHasBeenSet () const
 
void SetVersion (long long value)
 
RecordWithVersion (long long value)
 
const Aws::Vector< MeasureValue > & GetMeasureValues () const
 
bool MeasureValuesHasBeenSet () const
 
void SetMeasureValues (const Aws::Vector< MeasureValue > &value)
 
void SetMeasureValues (Aws::Vector< MeasureValue > &&value)
 
RecordWithMeasureValues (const Aws::Vector< MeasureValue > &value)
 
RecordWithMeasureValues (Aws::Vector< MeasureValue > &&value)
 
RecordAddMeasureValues (const MeasureValue &value)
 
RecordAddMeasureValues (MeasureValue &&value)
 

Detailed Description

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:

AWS API Reference

Definition at line 51 of file Record.h.

Constructor & Destructor Documentation

◆ Record() [1/2]

Aws::TimestreamWrite::Model::Record::Record ( )

◆ Record() [2/2]

Aws::TimestreamWrite::Model::Record::Record ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddDimensions() [1/2]

Record& Aws::TimestreamWrite::Model::Record::AddDimensions ( const Dimension value)
inline

Contains the list of dimensions for time series data points.

Definition at line 93 of file Record.h.

◆ AddDimensions() [2/2]

Record& Aws::TimestreamWrite::Model::Record::AddDimensions ( Dimension &&  value)
inline

Contains the list of dimensions for time series data points.

Definition at line 98 of file Record.h.

◆ AddMeasureValues() [1/2]

Record& Aws::TimestreamWrite::Model::Record::AddMeasureValues ( const MeasureValue value)
inline

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.

Definition at line 432 of file Record.h.

◆ AddMeasureValues() [2/2]

Record& Aws::TimestreamWrite::Model::Record::AddMeasureValues ( MeasureValue &&  value)
inline

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.

Definition at line 439 of file Record.h.

◆ DimensionsHasBeenSet()

bool Aws::TimestreamWrite::Model::Record::DimensionsHasBeenSet ( ) const
inline

Contains the list of dimensions for time series data points.

Definition at line 68 of file Record.h.

◆ GetDimensions()

const Aws::Vector<Dimension>& Aws::TimestreamWrite::Model::Record::GetDimensions ( ) const
inline

Contains the list of dimensions for time series data points.

Definition at line 63 of file Record.h.

◆ GetMeasureName()

const Aws::String& Aws::TimestreamWrite::Model::Record::GetMeasureName ( ) const
inline

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.

Definition at line 106 of file Record.h.

◆ GetMeasureValue()

const Aws::String& Aws::TimestreamWrite::Model::Record::GetMeasureValue ( ) const
inline

Contains the measure value for the time series data point.

Definition at line 161 of file Record.h.

◆ GetMeasureValues()

const Aws::Vector<MeasureValue>& Aws::TimestreamWrite::Model::Record::GetMeasureValues ( ) const
inline

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.

Definition at line 390 of file Record.h.

◆ GetMeasureValueType()

const MeasureValueType& Aws::TimestreamWrite::Model::Record::GetMeasureValueType ( ) const
inline

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

Definition at line 203 of file Record.h.

◆ GetTime()

const Aws::String& Aws::TimestreamWrite::Model::Record::GetTime ( ) const
inline

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.

Definition at line 242 of file Record.h.

◆ GetTimeUnit()

const TimeUnit& Aws::TimestreamWrite::Model::Record::GetTimeUnit ( ) const
inline

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

Definition at line 306 of file Record.h.

◆ GetVersion()

long long Aws::TimestreamWrite::Model::Record::GetVersion ( ) const
inline

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.

Version must be 1 or greater, or you will receive a ValidationException error.

Definition at line 352 of file Record.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::TimestreamWrite::Model::Record::Jsonize ( ) const

◆ MeasureNameHasBeenSet()

bool Aws::TimestreamWrite::Model::Record::MeasureNameHasBeenSet ( ) const
inline

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.

Definition at line 113 of file Record.h.

◆ MeasureValueHasBeenSet()

bool Aws::TimestreamWrite::Model::Record::MeasureValueHasBeenSet ( ) const
inline

Contains the measure value for the time series data point.

Definition at line 166 of file Record.h.

◆ MeasureValuesHasBeenSet()

bool Aws::TimestreamWrite::Model::Record::MeasureValuesHasBeenSet ( ) const
inline

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.

Definition at line 397 of file Record.h.

◆ MeasureValueTypeHasBeenSet()

bool Aws::TimestreamWrite::Model::Record::MeasureValueTypeHasBeenSet ( ) const
inline

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

Definition at line 209 of file Record.h.

◆ operator=()

Record& Aws::TimestreamWrite::Model::Record::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetDimensions() [1/2]

void Aws::TimestreamWrite::Model::Record::SetDimensions ( Aws::Vector< Dimension > &&  value)
inline

Contains the list of dimensions for time series data points.

Definition at line 78 of file Record.h.

◆ SetDimensions() [2/2]

void Aws::TimestreamWrite::Model::Record::SetDimensions ( const Aws::Vector< Dimension > &  value)
inline

Contains the list of dimensions for time series data points.

Definition at line 73 of file Record.h.

◆ SetMeasureName() [1/3]

void Aws::TimestreamWrite::Model::Record::SetMeasureName ( Aws::String &&  value)
inline

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.

Definition at line 127 of file Record.h.

◆ SetMeasureName() [2/3]

void Aws::TimestreamWrite::Model::Record::SetMeasureName ( const Aws::String value)
inline

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.

Definition at line 120 of file Record.h.

◆ SetMeasureName() [3/3]

void Aws::TimestreamWrite::Model::Record::SetMeasureName ( const char *  value)
inline

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.

Definition at line 134 of file Record.h.

◆ SetMeasureValue() [1/3]

void Aws::TimestreamWrite::Model::Record::SetMeasureValue ( Aws::String &&  value)
inline

Contains the measure value for the time series data point.

Definition at line 176 of file Record.h.

◆ SetMeasureValue() [2/3]

void Aws::TimestreamWrite::Model::Record::SetMeasureValue ( const Aws::String value)
inline

Contains the measure value for the time series data point.

Definition at line 171 of file Record.h.

◆ SetMeasureValue() [3/3]

void Aws::TimestreamWrite::Model::Record::SetMeasureValue ( const char *  value)
inline

Contains the measure value for the time series data point.

Definition at line 181 of file Record.h.

◆ SetMeasureValues() [1/2]

void Aws::TimestreamWrite::Model::Record::SetMeasureValues ( Aws::Vector< MeasureValue > &&  value)
inline

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.

Definition at line 411 of file Record.h.

◆ SetMeasureValues() [2/2]

void Aws::TimestreamWrite::Model::Record::SetMeasureValues ( const Aws::Vector< MeasureValue > &  value)
inline

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.

Definition at line 404 of file Record.h.

◆ SetMeasureValueType() [1/2]

void Aws::TimestreamWrite::Model::Record::SetMeasureValueType ( const MeasureValueType value)
inline

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

Definition at line 215 of file Record.h.

◆ SetMeasureValueType() [2/2]

void Aws::TimestreamWrite::Model::Record::SetMeasureValueType ( MeasureValueType &&  value)
inline

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

Definition at line 221 of file Record.h.

◆ SetTime() [1/3]

void Aws::TimestreamWrite::Model::Record::SetTime ( Aws::String &&  value)
inline

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.

Definition at line 266 of file Record.h.

◆ SetTime() [2/3]

void Aws::TimestreamWrite::Model::Record::SetTime ( const Aws::String value)
inline

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.

Definition at line 258 of file Record.h.

◆ SetTime() [3/3]

void Aws::TimestreamWrite::Model::Record::SetTime ( const char *  value)
inline

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.

Definition at line 274 of file Record.h.

◆ SetTimeUnit() [1/2]

void Aws::TimestreamWrite::Model::Record::SetTimeUnit ( const TimeUnit value)
inline

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

Definition at line 320 of file Record.h.

◆ SetTimeUnit() [2/2]

void Aws::TimestreamWrite::Model::Record::SetTimeUnit ( TimeUnit &&  value)
inline

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

Definition at line 327 of file Record.h.

◆ SetVersion()

void Aws::TimestreamWrite::Model::Record::SetVersion ( long long  value)
inline

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.

Version must be 1 or greater, or you will receive a ValidationException error.

Definition at line 372 of file Record.h.

◆ TimeHasBeenSet()

bool Aws::TimestreamWrite::Model::Record::TimeHasBeenSet ( ) const
inline

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.

Definition at line 250 of file Record.h.

◆ TimeUnitHasBeenSet()

bool Aws::TimestreamWrite::Model::Record::TimeUnitHasBeenSet ( ) const
inline

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

Definition at line 313 of file Record.h.

◆ VersionHasBeenSet()

bool Aws::TimestreamWrite::Model::Record::VersionHasBeenSet ( ) const
inline

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.

Version must be 1 or greater, or you will receive a ValidationException error.

Definition at line 362 of file Record.h.

◆ WithDimensions() [1/2]

Record& Aws::TimestreamWrite::Model::Record::WithDimensions ( Aws::Vector< Dimension > &&  value)
inline

Contains the list of dimensions for time series data points.

Definition at line 88 of file Record.h.

◆ WithDimensions() [2/2]

Record& Aws::TimestreamWrite::Model::Record::WithDimensions ( const Aws::Vector< Dimension > &  value)
inline

Contains the list of dimensions for time series data points.

Definition at line 83 of file Record.h.

◆ WithMeasureName() [1/3]

Record& Aws::TimestreamWrite::Model::Record::WithMeasureName ( Aws::String &&  value)
inline

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.

Definition at line 148 of file Record.h.

◆ WithMeasureName() [2/3]

Record& Aws::TimestreamWrite::Model::Record::WithMeasureName ( const Aws::String value)
inline

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.

Definition at line 141 of file Record.h.

◆ WithMeasureName() [3/3]

Record& Aws::TimestreamWrite::Model::Record::WithMeasureName ( const char *  value)
inline

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.

Definition at line 155 of file Record.h.

◆ WithMeasureValue() [1/3]

Record& Aws::TimestreamWrite::Model::Record::WithMeasureValue ( Aws::String &&  value)
inline

Contains the measure value for the time series data point.

Definition at line 191 of file Record.h.

◆ WithMeasureValue() [2/3]

Record& Aws::TimestreamWrite::Model::Record::WithMeasureValue ( const Aws::String value)
inline

Contains the measure value for the time series data point.

Definition at line 186 of file Record.h.

◆ WithMeasureValue() [3/3]

Record& Aws::TimestreamWrite::Model::Record::WithMeasureValue ( const char *  value)
inline

Contains the measure value for the time series data point.

Definition at line 196 of file Record.h.

◆ WithMeasureValues() [1/2]

Record& Aws::TimestreamWrite::Model::Record::WithMeasureValues ( Aws::Vector< MeasureValue > &&  value)
inline

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.

Definition at line 425 of file Record.h.

◆ WithMeasureValues() [2/2]

Record& Aws::TimestreamWrite::Model::Record::WithMeasureValues ( const Aws::Vector< MeasureValue > &  value)
inline

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.

Definition at line 418 of file Record.h.

◆ WithMeasureValueType() [1/2]

Record& Aws::TimestreamWrite::Model::Record::WithMeasureValueType ( const MeasureValueType value)
inline

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

Definition at line 227 of file Record.h.

◆ WithMeasureValueType() [2/2]

Record& Aws::TimestreamWrite::Model::Record::WithMeasureValueType ( MeasureValueType &&  value)
inline

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

Definition at line 233 of file Record.h.

◆ WithTime() [1/3]

Record& Aws::TimestreamWrite::Model::Record::WithTime ( Aws::String &&  value)
inline

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.

Definition at line 290 of file Record.h.

◆ WithTime() [2/3]

Record& Aws::TimestreamWrite::Model::Record::WithTime ( const Aws::String value)
inline

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.

Definition at line 282 of file Record.h.

◆ WithTime() [3/3]

Record& Aws::TimestreamWrite::Model::Record::WithTime ( const char *  value)
inline

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.

Definition at line 298 of file Record.h.

◆ WithTimeUnit() [1/2]

Record& Aws::TimestreamWrite::Model::Record::WithTimeUnit ( const TimeUnit value)
inline

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

Definition at line 334 of file Record.h.

◆ WithTimeUnit() [2/2]

Record& Aws::TimestreamWrite::Model::Record::WithTimeUnit ( TimeUnit &&  value)
inline

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

Definition at line 341 of file Record.h.

◆ WithVersion()

Record& Aws::TimestreamWrite::Model::Record::WithVersion ( long long  value)
inline

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.

Version must be 1 or greater, or you will receive a ValidationException error.

Definition at line 382 of file Record.h.


The documentation for this class was generated from the following file: