Record (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.timestreamwrite.model.Record

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Record
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Record()

Constructors
Constructor and Description
`Record()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Record`	`clone()`
`boolean`	`equals(Object obj)`
`List<Dimension>`	`getDimensions()` Contains the list of dimensions for time-series data points.
`String`	`getMeasureName()` Measure represents the data attribute of the time series.
`String`	`getMeasureValue()` Contains the measure value for the time-series data point.
`List<MeasureValue>`	`getMeasureValues()` Contains the list of MeasureValue for time-series data points.
`String`	`getMeasureValueType()` Contains the data type of the measure value for the time-series data point.
`String`	`getTime()` Contains the time at which the measure value for the data point was collected.
`String`	`getTimeUnit()` The granularity of the timestamp unit.
`Long`	`getVersion()` 64-bit attribute used for record updates.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setDimensions(Collection<Dimension> dimensions)` Contains the list of dimensions for time-series data points.
`void`	`setMeasureName(String measureName)` Measure represents the data attribute of the time series.
`void`	`setMeasureValue(String measureValue)` Contains the measure value for the time-series data point.
`void`	`setMeasureValues(Collection<MeasureValue> measureValues)` Contains the list of MeasureValue for time-series data points.
`void`	`setMeasureValueType(String measureValueType)` Contains the data type of the measure value for the time-series data point.
`void`	`setTime(String time)` Contains the time at which the measure value for the data point was collected.
`void`	`setTimeUnit(String timeUnit)` The granularity of the timestamp unit.
`void`	`setVersion(Long version)` 64-bit attribute used for record updates.
`String`	`toString()` Returns a string representation of this object.
`Record`	`withDimensions(Collection<Dimension> dimensions)` Contains the list of dimensions for time-series data points.
`Record`	`withDimensions(Dimension... dimensions)` Contains the list of dimensions for time-series data points.
`Record`	`withMeasureName(String measureName)` Measure represents the data attribute of the time series.
`Record`	`withMeasureValue(String measureValue)` Contains the measure value for the time-series data point.
`Record`	`withMeasureValues(Collection<MeasureValue> measureValues)` Contains the list of MeasureValue for time-series data points.
`Record`	`withMeasureValues(MeasureValue... measureValues)` Contains the list of MeasureValue for time-series data points.
`Record`	`withMeasureValueType(MeasureValueType measureValueType)` Contains the data type of the measure value for the time-series data point.
`Record`	`withMeasureValueType(String measureValueType)` Contains the data type of the measure value for the time-series data point.
`Record`	`withTime(String time)` Contains the time at which the measure value for the data point was collected.
`Record`	`withTimeUnit(String timeUnit)` The granularity of the timestamp unit.
`Record`	`withTimeUnit(TimeUnit timeUnit)` The granularity of the timestamp unit.
`Record`	`withVersion(Long version)` 64-bit attribute used for record updates.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Record
```
public Record()
```
- Method Detail
  - getDimensions
```
public List<Dimension> getDimensions()
```
    Contains the list of dimensions for time-series data points.
    
    Returns:
    
    Contains the list of dimensions for time-series data points.
  - setDimensions
```
public void setDimensions(Collection<Dimension> dimensions)
```
    Contains the list of dimensions for time-series data points.
    
    Parameters:
    
    dimensions - Contains the list of dimensions for time-series data points.
  - withDimensions
```
public Record withDimensions(Dimension... dimensions)
```
    Contains the list of dimensions for time-series data points.
    
    NOTE: This method appends the values to the existing list (if any). Use setDimensions(java.util.Collection) or withDimensions(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    dimensions - Contains the list of dimensions for time-series data points.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withDimensions
```
public Record withDimensions(Collection<Dimension> dimensions)
```
    Contains the list of dimensions for time-series data points.
    
    Parameters:
    
    dimensions - Contains the list of dimensions for time-series data points.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMeasureName
```
public void setMeasureName(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.
    
    Parameters:
    
    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.
  - getMeasureName
```
public String getMeasureName()
```
    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.
  - withMeasureName
```
public Record withMeasureName(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMeasureValue
```
public void setMeasureValue(String measureValue)
```
    Contains the measure value for the time-series data point.
    
    Parameters:
    
    measureValue - Contains the measure value for the time-series data point.
  - getMeasureValue
```
public String getMeasureValue()
```
    Contains the measure value for the time-series data point.
    
    Returns:
    
    Contains the measure value for the time-series data point.
  - withMeasureValue
```
public Record withMeasureValue(String measureValue)
```
    Contains the measure value for the time-series data point.
    
    Parameters:
    
    measureValue - Contains the measure value for the time-series data point.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMeasureValueType
```
public void setMeasureValueType(String 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.
    
    Parameters:
    
    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.
    
    See Also:
    
    MeasureValueType
  - getMeasureValueType
```
public String getMeasureValueType()
```
    Contains the data type of the measure value for the time-series data point. Default type is DOUBLE. For more information, see Data types.
    
    Returns:
    
    Contains the data type of the measure value for the time-series data point. Default type is DOUBLE. For more information, see Data types.
    
    See Also:
    
    MeasureValueType
  - withMeasureValueType
```
public Record withMeasureValueType(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    MeasureValueType
  - withMeasureValueType
```
public Record withMeasureValueType(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    MeasureValueType
  - setTime
```
public void setTime(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.
    
    Parameters:
    
    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.
  - getTime
```
public String getTime()
```
    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.
  - withTime
```
public Record withTime(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTimeUnit
```
public void setTimeUnit(String 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.
    
    Parameters:
    
    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.
    
    See Also:
    
    TimeUnit
  - getTimeUnit
```
public String getTimeUnit()
```
    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:
    
    The granularity of the timestamp unit. It indicates if the time value is in seconds, milliseconds, nanoseconds, or other supported values. Default is MILLISECONDS.
    
    See Also:
    
    TimeUnit
  - withTimeUnit
```
public Record withTimeUnit(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TimeUnit
  - withTimeUnit
```
public Record withTimeUnit(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TimeUnit
  - setVersion
```
public void setVersion(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 1.
    
    Version must be 1 or greater, or you will receive a ValidationException error.
    
    Parameters:
    
    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 1.
    
    Version must be 1 or greater, or you will receive a ValidationException error.
  - getVersion
```
public Long getVersion()
```
    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.
    
    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 1.
    
    Version must be 1 or greater, or you will receive a ValidationException error.
  - withVersion
```
public Record withVersion(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 1.
    
    Version must be 1 or greater, or you will receive a ValidationException error.
    
    Parameters:
    
    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 1.
    
    Version must be 1 or greater, or you will receive a ValidationException error.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getMeasureValues
```
public List<MeasureValue> getMeasureValues()
```
    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:
    
    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.
  - setMeasureValues
```
public void setMeasureValues(Collection<MeasureValue> measureValues)
```
    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.
    
    Parameters:
    
    measureValues - 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.
  - withMeasureValues
```
public Record withMeasureValues(MeasureValue... measureValues)
```
    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.
    
    NOTE: This method appends the values to the existing list (if any). Use setMeasureValues(java.util.Collection) or withMeasureValues(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    measureValues - 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:
    
    Returns a reference to this object so that method calls can be chained together.
  - withMeasureValues
```
public Record withMeasureValues(Collection<MeasureValue> measureValues)
```
    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.
    
    Parameters:
    
    measureValues - 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:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Record clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.793

Class Record

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Record

Method Detail

getDimensions

setDimensions

withDimensions

withDimensions

setMeasureName

getMeasureName

withMeasureName

setMeasureValue

getMeasureValue

withMeasureValue

setMeasureValueType

getMeasureValueType

withMeasureValueType

withMeasureValueType

setTime

getTime

withTime

setTimeUnit

getTimeUnit

withTimeUnit

withTimeUnit

setVersion

getVersion

withVersion

getMeasureValues

setMeasureValues

withMeasureValues

withMeasureValues

toString

equals

hashCode

clone

marshall