com.amazonaws.services.timestreamwrite.model.Record Maven / Gradle / Ivy
Show all versions of aws-java-sdk-timestreamwrite Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.timestreamwrite.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* 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 AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class Record implements Serializable, Cloneable, StructuredPojo {
/**
*
* Contains the list of dimensions for time-series data points.
*
*/
private java.util.List dimensions;
/**
*
* 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.
*
*/
private String measureName;
/**
*
* Contains the measure value for the time-series data point.
*
*/
private String measureValue;
/**
*
* Contains the data type of the measure value for the time-series data point. Default type is DOUBLE.
* For more information, see Data types.
*
*/
private String measureValueType;
/**
*
* 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.
*
*/
private String time;
/**
*
* The granularity of the timestamp unit. It indicates if the time value is in seconds, milliseconds, nanoseconds,
* or other supported values. Default is MILLISECONDS.
*
*/
private String timeUnit;
/**
*
* 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.
*
*
*/
private Long version;
/**
*
* 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.
*
*/
private java.util.List measureValues;
/**
*
* Contains the list of dimensions for time-series data points.
*
*
* @return Contains the list of dimensions for time-series data points.
*/
public java.util.List getDimensions() {
return dimensions;
}
/**
*
* Contains the list of dimensions for time-series data points.
*
*
* @param dimensions
* Contains the list of dimensions for time-series data points.
*/
public void setDimensions(java.util.Collection dimensions) {
if (dimensions == null) {
this.dimensions = null;
return;
}
this.dimensions = new java.util.ArrayList(dimensions);
}
/**
*
* Contains the list of dimensions for time-series data points.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setDimensions(java.util.Collection)} or {@link #withDimensions(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param dimensions
* Contains the list of dimensions for time-series data points.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Record withDimensions(Dimension... dimensions) {
if (this.dimensions == null) {
setDimensions(new java.util.ArrayList(dimensions.length));
}
for (Dimension ele : dimensions) {
this.dimensions.add(ele);
}
return this;
}
/**
*
* Contains the list of dimensions for time-series data points.
*
*
* @param dimensions
* Contains the list of dimensions for time-series data points.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Record withDimensions(java.util.Collection dimensions) {
setDimensions(dimensions);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setMeasureName(String measureName) {
this.measureName = 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.
*
*
* @return 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.
*/
public String getMeasureName() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Record withMeasureName(String measureName) {
setMeasureName(measureName);
return this;
}
/**
*
* Contains the measure value for the time-series data point.
*
*
* @param measureValue
* Contains the measure value for the time-series data point.
*/
public void setMeasureValue(String measureValue) {
this.measureValue = measureValue;
}
/**
*
* Contains the measure value for the time-series data point.
*
*
* @return Contains the measure value for the time-series data point.
*/
public String getMeasureValue() {
return this.measureValue;
}
/**
*
* Contains the measure value for the time-series data point.
*
*
* @param measureValue
* Contains the measure value for the time-series data point.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Record withMeasureValue(String measureValue) {
setMeasureValue(measureValue);
return this;
}
/**
*
* Contains the data type of the measure value for the time-series data point. Default type is DOUBLE.
* For more information, see Data types.
*
*
* @param 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 MeasureValueType
*/
public void setMeasureValueType(String measureValueType) {
this.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.
*
*
* @return 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 MeasureValueType
*/
public String getMeasureValueType() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see MeasureValueType
*/
public Record withMeasureValueType(String measureValueType) {
setMeasureValueType(measureValueType);
return this;
}
/**
*
* Contains the data type of the measure value for the time-series data point. Default type is DOUBLE.
* For more information, see Data types.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see MeasureValueType
*/
public Record withMeasureValueType(MeasureValueType measureValueType) {
this.measureValueType = measureValueType.toString();
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setTime(String time) {
this.time = 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.
*
*
* @return 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.
*/
public String getTime() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Record withTime(String time) {
setTime(time);
return this;
}
/**
*
* The granularity of the timestamp unit. It indicates if the time value is in seconds, milliseconds, nanoseconds,
* or other supported values. Default is MILLISECONDS.
*
*
* @param 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 TimeUnit
*/
public void setTimeUnit(String timeUnit) {
this.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.
*
*
* @return 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 TimeUnit
*/
public String getTimeUnit() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see TimeUnit
*/
public Record withTimeUnit(String timeUnit) {
setTimeUnit(timeUnit);
return this;
}
/**
*
* The granularity of the timestamp unit. It indicates if the time value is in seconds, milliseconds, nanoseconds,
* or other supported values. Default is MILLISECONDS.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see TimeUnit
*/
public Record withTimeUnit(TimeUnit timeUnit) {
this.timeUnit = timeUnit.toString();
return this;
}
/**
*
* 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.
*
*
*
* @param 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.
*
*/
public void setVersion(Long version) {
this.version = 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.
*
*
*
* @return 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.
*
*/
public Long getVersion() {
return this.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.
*
*
*
* @param 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.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Record withVersion(Long version) {
setVersion(version);
return this;
}
/**
*
* 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.
*
*
* @return 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.
*/
public java.util.List getMeasureValues() {
return 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.
*
*
* @param 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.
*/
public void setMeasureValues(java.util.Collection measureValues) {
if (measureValues == null) {
this.measureValues = null;
return;
}
this.measureValues = new java.util.ArrayList(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
* {@link #setMeasureValues(java.util.Collection)} or {@link #withMeasureValues(java.util.Collection)} if you want
* to override the existing values.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Record withMeasureValues(MeasureValue... measureValues) {
if (this.measureValues == null) {
setMeasureValues(new java.util.ArrayList(measureValues.length));
}
for (MeasureValue ele : measureValues) {
this.measureValues.add(ele);
}
return this;
}
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Record withMeasureValues(java.util.Collection measureValues) {
setMeasureValues(measureValues);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getDimensions() != null)
sb.append("Dimensions: ").append(getDimensions()).append(",");
if (getMeasureName() != null)
sb.append("MeasureName: ").append(getMeasureName()).append(",");
if (getMeasureValue() != null)
sb.append("MeasureValue: ").append(getMeasureValue()).append(",");
if (getMeasureValueType() != null)
sb.append("MeasureValueType: ").append(getMeasureValueType()).append(",");
if (getTime() != null)
sb.append("Time: ").append(getTime()).append(",");
if (getTimeUnit() != null)
sb.append("TimeUnit: ").append(getTimeUnit()).append(",");
if (getVersion() != null)
sb.append("Version: ").append(getVersion()).append(",");
if (getMeasureValues() != null)
sb.append("MeasureValues: ").append(getMeasureValues());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof Record == false)
return false;
Record other = (Record) obj;
if (other.getDimensions() == null ^ this.getDimensions() == null)
return false;
if (other.getDimensions() != null && other.getDimensions().equals(this.getDimensions()) == false)
return false;
if (other.getMeasureName() == null ^ this.getMeasureName() == null)
return false;
if (other.getMeasureName() != null && other.getMeasureName().equals(this.getMeasureName()) == false)
return false;
if (other.getMeasureValue() == null ^ this.getMeasureValue() == null)
return false;
if (other.getMeasureValue() != null && other.getMeasureValue().equals(this.getMeasureValue()) == false)
return false;
if (other.getMeasureValueType() == null ^ this.getMeasureValueType() == null)
return false;
if (other.getMeasureValueType() != null && other.getMeasureValueType().equals(this.getMeasureValueType()) == false)
return false;
if (other.getTime() == null ^ this.getTime() == null)
return false;
if (other.getTime() != null && other.getTime().equals(this.getTime()) == false)
return false;
if (other.getTimeUnit() == null ^ this.getTimeUnit() == null)
return false;
if (other.getTimeUnit() != null && other.getTimeUnit().equals(this.getTimeUnit()) == false)
return false;
if (other.getVersion() == null ^ this.getVersion() == null)
return false;
if (other.getVersion() != null && other.getVersion().equals(this.getVersion()) == false)
return false;
if (other.getMeasureValues() == null ^ this.getMeasureValues() == null)
return false;
if (other.getMeasureValues() != null && other.getMeasureValues().equals(this.getMeasureValues()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getDimensions() == null) ? 0 : getDimensions().hashCode());
hashCode = prime * hashCode + ((getMeasureName() == null) ? 0 : getMeasureName().hashCode());
hashCode = prime * hashCode + ((getMeasureValue() == null) ? 0 : getMeasureValue().hashCode());
hashCode = prime * hashCode + ((getMeasureValueType() == null) ? 0 : getMeasureValueType().hashCode());
hashCode = prime * hashCode + ((getTime() == null) ? 0 : getTime().hashCode());
hashCode = prime * hashCode + ((getTimeUnit() == null) ? 0 : getTimeUnit().hashCode());
hashCode = prime * hashCode + ((getVersion() == null) ? 0 : getVersion().hashCode());
hashCode = prime * hashCode + ((getMeasureValues() == null) ? 0 : getMeasureValues().hashCode());
return hashCode;
}
@Override
public Record clone() {
try {
return (Record) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.timestreamwrite.model.transform.RecordMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}