/* * Copyright 2018-2023 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.cloudwatch.model; import java.io.Serializable; import javax.annotation.Generated; /** *
* Encapsulates the information sent to either create a metric or add new values to be aggregated into an existing * metric. *
* * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class MetricDatum implements Serializable, Cloneable { /** ** The name of the metric. *
*/ private String metricName; /** ** The dimensions associated with the metric. *
*/ private com.amazonaws.internal.SdkInternalList* The time the metric data was received, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. *
*/ private java.util.Date timestamp; /** ** The value for the metric. *
** Although the parameter accepts numbers of type Double, CloudWatch rejects values that are either too small or too * large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity, * -Infinity) are not supported. *
*/ private Double value; /** ** The statistical values for the metric. *
*/ private StatisticSet statisticValues; /** *
* Array of numbers representing the values for the metric during the period. Each unique value is listed just once
* in this array, and the corresponding number in the Counts
array specifies the number of times that
* value occurred during the period. You can include up to 150 unique values in each PutMetricData
* action that specifies a Values
array.
*
* Although the Values
array accepts numbers of type Double
, CloudWatch rejects values
* that are either too small or too large. Values must be in the range of -2^360 to 2^360. In addition, special
* values (for example, NaN, +Infinity, -Infinity) are not supported.
*
* Array of numbers that is used along with the Values
array. Each number in the Count
* array is the number of times the corresponding value in the Values
array occurred during the period.
*
* If you omit the Counts
array, the default of 1 is used as the value for each count. If you include a
* Counts
array, it must include the same amount of values as the Values
array.
*
* When you are using a Put
operation, this defines what unit you want to use when storing the metric.
*
* In a Get
operation, this displays the unit that is used for the metric.
*
* Valid values are 1 and 60. Setting this to 1 specifies this metric as a high-resolution metric, so that * CloudWatch stores the metric with sub-minute resolution down to one second. Setting this to 60 specifies this * metric as a regular-resolution metric, which CloudWatch stores at 1-minute resolution. Currently, high resolution * is available only for custom metrics. For more information about high-resolution metrics, see High-Resolution Metrics in the Amazon CloudWatch User Guide. *
** This field is optional, if you do not specify it the default of 60 is used. *
*/ private Integer storageResolution; /** ** The name of the metric. *
* * @param metricName * The name of the metric. */ public void setMetricName(String metricName) { this.metricName = metricName; } /** ** The name of the metric. *
* * @return The name of the metric. */ public String getMetricName() { return this.metricName; } /** ** The name of the metric. *
* * @param metricName * The name of the metric. * @return Returns a reference to this object so that method calls can be chained together. */ public MetricDatum withMetricName(String metricName) { setMetricName(metricName); return this; } /** ** The dimensions associated with the metric. *
* * @return The dimensions associated with the metric. */ public java.util.List* The dimensions associated with the metric. *
* * @param dimensions * The dimensions associated with the metric. */ public void setDimensions(java.util.Collection* The dimensions associated with the metric. *
** 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 * The dimensions associated with the metric. * @return Returns a reference to this object so that method calls can be chained together. */ public MetricDatum withDimensions(Dimension... dimensions) { if (this.dimensions == null) { setDimensions(new com.amazonaws.internal.SdkInternalList* The dimensions associated with the metric. *
* * @param dimensions * The dimensions associated with the metric. * @return Returns a reference to this object so that method calls can be chained together. */ public MetricDatum withDimensions(java.util.Collection* The time the metric data was received, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. *
* * @param timestamp * The time the metric data was received, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 * UTC. */ public void setTimestamp(java.util.Date timestamp) { this.timestamp = timestamp; } /** ** The time the metric data was received, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. *
* * @return The time the metric data was received, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 * UTC. */ public java.util.Date getTimestamp() { return this.timestamp; } /** ** The time the metric data was received, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. *
* * @param timestamp * The time the metric data was received, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 * UTC. * @return Returns a reference to this object so that method calls can be chained together. */ public MetricDatum withTimestamp(java.util.Date timestamp) { setTimestamp(timestamp); return this; } /** ** The value for the metric. *
** Although the parameter accepts numbers of type Double, CloudWatch rejects values that are either too small or too * large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity, * -Infinity) are not supported. *
* * @param value * The value for the metric. ** Although the parameter accepts numbers of type Double, CloudWatch rejects values that are either too small * or too large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, * NaN, +Infinity, -Infinity) are not supported. */ public void setValue(Double value) { this.value = value; } /** *
* The value for the metric. *
** Although the parameter accepts numbers of type Double, CloudWatch rejects values that are either too small or too * large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity, * -Infinity) are not supported. *
* * @return The value for the metric. ** Although the parameter accepts numbers of type Double, CloudWatch rejects values that are either too * small or too large. Values must be in the range of -2^360 to 2^360. In addition, special values (for * example, NaN, +Infinity, -Infinity) are not supported. */ public Double getValue() { return this.value; } /** *
* The value for the metric. *
** Although the parameter accepts numbers of type Double, CloudWatch rejects values that are either too small or too * large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity, * -Infinity) are not supported. *
* * @param value * The value for the metric. ** Although the parameter accepts numbers of type Double, CloudWatch rejects values that are either too small * or too large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, * NaN, +Infinity, -Infinity) are not supported. * @return Returns a reference to this object so that method calls can be chained together. */ public MetricDatum withValue(Double value) { setValue(value); return this; } /** *
* The statistical values for the metric. *
* * @param statisticValues * The statistical values for the metric. */ public void setStatisticValues(StatisticSet statisticValues) { this.statisticValues = statisticValues; } /** ** The statistical values for the metric. *
* * @return The statistical values for the metric. */ public StatisticSet getStatisticValues() { return this.statisticValues; } /** ** The statistical values for the metric. *
* * @param statisticValues * The statistical values for the metric. * @return Returns a reference to this object so that method calls can be chained together. */ public MetricDatum withStatisticValues(StatisticSet statisticValues) { setStatisticValues(statisticValues); return this; } /** *
* Array of numbers representing the values for the metric during the period. Each unique value is listed just once
* in this array, and the corresponding number in the Counts
array specifies the number of times that
* value occurred during the period. You can include up to 150 unique values in each PutMetricData
* action that specifies a Values
array.
*
* Although the Values
array accepts numbers of type Double
, CloudWatch rejects values
* that are either too small or too large. Values must be in the range of -2^360 to 2^360. In addition, special
* values (for example, NaN, +Infinity, -Infinity) are not supported.
*
Counts
array specifies the
* number of times that value occurred during the period. You can include up to 150 unique values in each
* PutMetricData
action that specifies a Values
array.
*
* Although the
* Array of numbers representing the values for the metric during the period. Each unique value is listed just once
* in this array, and the corresponding number in the
* Although the Values
array accepts numbers of type Double
, CloudWatch rejects
* values that are either too small or too large. Values must be in the range of -2^360 to 2^360. In
* addition, special values (for example, NaN, +Infinity, -Infinity) are not supported.
*/
public java.util.ListCounts
array specifies the number of times that
* value occurred during the period. You can include up to 150 unique values in each PutMetricData
* action that specifies a Values
array.
* Values
array accepts numbers of type Double
, CloudWatch rejects values
* that are either too small or too large. Values must be in the range of -2^360 to 2^360. In addition, special
* values (for example, NaN, +Infinity, -Infinity) are not supported.
* Counts
array specifies the
* number of times that value occurred during the period. You can include up to 150 unique values in each
* PutMetricData
action that specifies a Values
array.
* Although the
* Array of numbers representing the values for the metric during the period. Each unique value is listed just once
* in this array, and the corresponding number in the
* Although the
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setValues(java.util.Collection)} or {@link #withValues(java.util.Collection)} if you want to override the
* existing values.
* Values
array accepts numbers of type Double
, CloudWatch rejects
* values that are either too small or too large. Values must be in the range of -2^360 to 2^360. In
* addition, special values (for example, NaN, +Infinity, -Infinity) are not supported.
*/
public void setValues(java.util.CollectionCounts
array specifies the number of times that
* value occurred during the period. You can include up to 150 unique values in each PutMetricData
* action that specifies a Values
array.
* Values
array accepts numbers of type Double
, CloudWatch rejects values
* that are either too small or too large. Values must be in the range of -2^360 to 2^360. In addition, special
* values (for example, NaN, +Infinity, -Infinity) are not supported.
* Counts
array specifies the
* number of times that value occurred during the period. You can include up to 150 unique values in each
* PutMetricData
action that specifies a Values
array.
* Although the
* Array of numbers representing the values for the metric during the period. Each unique value is listed just once
* in this array, and the corresponding number in the
* Although the Values
array accepts numbers of type Double
, CloudWatch rejects
* values that are either too small or too large. Values must be in the range of -2^360 to 2^360. In
* addition, special values (for example, NaN, +Infinity, -Infinity) are not supported.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public MetricDatum withValues(Double... values) {
if (this.values == null) {
setValues(new com.amazonaws.internal.SdkInternalListCounts
array specifies the number of times that
* value occurred during the period. You can include up to 150 unique values in each PutMetricData
* action that specifies a Values
array.
* Values
array accepts numbers of type Double
, CloudWatch rejects values
* that are either too small or too large. Values must be in the range of -2^360 to 2^360. In addition, special
* values (for example, NaN, +Infinity, -Infinity) are not supported.
* Counts
array specifies the
* number of times that value occurred during the period. You can include up to 150 unique values in each
* PutMetricData
action that specifies a Values
array.
* Although the
* Array of numbers that is used along with the
* If you omit the Values
array accepts numbers of type Double
, CloudWatch rejects
* values that are either too small or too large. Values must be in the range of -2^360 to 2^360. In
* addition, special values (for example, NaN, +Infinity, -Infinity) are not supported.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public MetricDatum withValues(java.util.CollectionValues
array. Each number in the Count
* array is the number of times the corresponding value in the Values
array occurred during the period.
* Counts
array, the default of 1 is used as the value for each count. If you include a
* Counts
array, it must include the same amount of values as the Values
array.
* Values
array. Each number in the
* Count
array is the number of times the corresponding value in the Values
array
* occurred during the period.
* If you omit the
* Array of numbers that is used along with the
* If you omit the Counts
array, the default of 1 is used as the value for each count. If you
* include a Counts
array, it must include the same amount of values as the Values
* array.
*/
public java.util.ListValues
array. Each number in the Count
* array is the number of times the corresponding value in the Values
array occurred during the period.
* Counts
array, the default of 1 is used as the value for each count. If you include a
* Counts
array, it must include the same amount of values as the Values
array.
* Values
array. Each number in the
* Count
array is the number of times the corresponding value in the Values
array
* occurred during the period.
* If you omit the
* Array of numbers that is used along with the
* If you omit the
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setCounts(java.util.Collection)} or {@link #withCounts(java.util.Collection)} if you want to override the
* existing values.
* Counts
array, the default of 1 is used as the value for each count. If you
* include a Counts
array, it must include the same amount of values as the Values
* array.
*/
public void setCounts(java.util.CollectionValues
array. Each number in the Count
* array is the number of times the corresponding value in the Values
array occurred during the period.
* Counts
array, the default of 1 is used as the value for each count. If you include a
* Counts
array, it must include the same amount of values as the Values
array.
* Values
array. Each number in the
* Count
array is the number of times the corresponding value in the Values
array
* occurred during the period.
* If you omit the
* Array of numbers that is used along with the
* If you omit the Counts
array, the default of 1 is used as the value for each count. If you
* include a Counts
array, it must include the same amount of values as the Values
* array.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public MetricDatum withCounts(Double... counts) {
if (this.counts == null) {
setCounts(new com.amazonaws.internal.SdkInternalListValues
array. Each number in the Count
* array is the number of times the corresponding value in the Values
array occurred during the period.
* Counts
array, the default of 1 is used as the value for each count. If you include a
* Counts
array, it must include the same amount of values as the Values
array.
* Values
array. Each number in the
* Count
array is the number of times the corresponding value in the Values
array
* occurred during the period.
* If you omit the
* When you are using a
* In a Counts
array, the default of 1 is used as the value for each count. If you
* include a Counts
array, it must include the same amount of values as the Values
* array.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public MetricDatum withCounts(java.util.CollectionPut
operation, this defines what unit you want to use when storing the metric.
* Get
operation, this displays the unit that is used for the metric.
* Put
operation, this defines what unit you want to use when storing the
* metric.
* In a Get
operation, this displays the unit that is used for the metric.
* @see StandardUnit
*/
public void setUnit(String unit) {
this.unit = unit;
}
/**
*
* When you are using a Put
operation, this defines what unit you want to use when storing the metric.
*
* In a Get
operation, this displays the unit that is used for the metric.
*
Put
operation, this defines what unit you want to use when storing the
* metric.
*
* In a Get
operation, this displays the unit that is used for the metric.
* @see StandardUnit
*/
public String getUnit() {
return this.unit;
}
/**
*
* When you are using a Put
operation, this defines what unit you want to use when storing the metric.
*
* In a Get
operation, this displays the unit that is used for the metric.
*
Put
operation, this defines what unit you want to use when storing the
* metric.
*
* In a Get
operation, this displays the unit that is used for the metric.
* @return Returns a reference to this object so that method calls can be chained together.
* @see StandardUnit
*/
public MetricDatum withUnit(String unit) {
setUnit(unit);
return this;
}
/**
*
* When you are using a Put
operation, this defines what unit you want to use when storing the metric.
*
* In a Get
operation, this displays the unit that is used for the metric.
*
Put
operation, this defines what unit you want to use when storing the
* metric.
*
* In a Get
operation, this displays the unit that is used for the metric.
* @see StandardUnit
*/
public void setUnit(StandardUnit unit) {
withUnit(unit);
}
/**
*
* When you are using a Put
operation, this defines what unit you want to use when storing the metric.
*
* In a Get
operation, this displays the unit that is used for the metric.
*
Put
operation, this defines what unit you want to use when storing the
* metric.
*
* In a Get
operation, this displays the unit that is used for the metric.
* @return Returns a reference to this object so that method calls can be chained together.
* @see StandardUnit
*/
public MetricDatum withUnit(StandardUnit unit) {
this.unit = unit.toString();
return this;
}
/**
*
* Valid values are 1 and 60. Setting this to 1 specifies this metric as a high-resolution metric, so that * CloudWatch stores the metric with sub-minute resolution down to one second. Setting this to 60 specifies this * metric as a regular-resolution metric, which CloudWatch stores at 1-minute resolution. Currently, high resolution * is available only for custom metrics. For more information about high-resolution metrics, see High-Resolution Metrics in the Amazon CloudWatch User Guide. *
** This field is optional, if you do not specify it the default of 60 is used. *
* * @param storageResolution * Valid values are 1 and 60. Setting this to 1 specifies this metric as a high-resolution metric, so that * CloudWatch stores the metric with sub-minute resolution down to one second. Setting this to 60 specifies * this metric as a regular-resolution metric, which CloudWatch stores at 1-minute resolution. Currently, * high resolution is available only for custom metrics. For more information about high-resolution metrics, * see High-Resolution Metrics in the Amazon CloudWatch User Guide. ** This field is optional, if you do not specify it the default of 60 is used. */ public void setStorageResolution(Integer storageResolution) { this.storageResolution = storageResolution; } /** *
* Valid values are 1 and 60. Setting this to 1 specifies this metric as a high-resolution metric, so that * CloudWatch stores the metric with sub-minute resolution down to one second. Setting this to 60 specifies this * metric as a regular-resolution metric, which CloudWatch stores at 1-minute resolution. Currently, high resolution * is available only for custom metrics. For more information about high-resolution metrics, see High-Resolution Metrics in the Amazon CloudWatch User Guide. *
** This field is optional, if you do not specify it the default of 60 is used. *
* * @return Valid values are 1 and 60. Setting this to 1 specifies this metric as a high-resolution metric, so that * CloudWatch stores the metric with sub-minute resolution down to one second. Setting this to 60 specifies * this metric as a regular-resolution metric, which CloudWatch stores at 1-minute resolution. Currently, * high resolution is available only for custom metrics. For more information about high-resolution metrics, * see High-Resolution Metrics in the Amazon CloudWatch User Guide. ** This field is optional, if you do not specify it the default of 60 is used. */ public Integer getStorageResolution() { return this.storageResolution; } /** *
* Valid values are 1 and 60. Setting this to 1 specifies this metric as a high-resolution metric, so that * CloudWatch stores the metric with sub-minute resolution down to one second. Setting this to 60 specifies this * metric as a regular-resolution metric, which CloudWatch stores at 1-minute resolution. Currently, high resolution * is available only for custom metrics. For more information about high-resolution metrics, see High-Resolution Metrics in the Amazon CloudWatch User Guide. *
** This field is optional, if you do not specify it the default of 60 is used. *
* * @param storageResolution * Valid values are 1 and 60. Setting this to 1 specifies this metric as a high-resolution metric, so that * CloudWatch stores the metric with sub-minute resolution down to one second. Setting this to 60 specifies * this metric as a regular-resolution metric, which CloudWatch stores at 1-minute resolution. Currently, * high resolution is available only for custom metrics. For more information about high-resolution metrics, * see High-Resolution Metrics in the Amazon CloudWatch User Guide. ** This field is optional, if you do not specify it the default of 60 is used. * @return Returns a reference to this object so that method calls can be chained together. */ public MetricDatum withStorageResolution(Integer storageResolution) { setStorageResolution(storageResolution); 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 (getMetricName() != null) sb.append("MetricName: ").append(getMetricName()).append(","); if (getDimensions() != null) sb.append("Dimensions: ").append(getDimensions()).append(","); if (getTimestamp() != null) sb.append("Timestamp: ").append(getTimestamp()).append(","); if (getValue() != null) sb.append("Value: ").append(getValue()).append(","); if (getStatisticValues() != null) sb.append("StatisticValues: ").append(getStatisticValues()).append(","); if (getValues() != null) sb.append("Values: ").append(getValues()).append(","); if (getCounts() != null) sb.append("Counts: ").append(getCounts()).append(","); if (getUnit() != null) sb.append("Unit: ").append(getUnit()).append(","); if (getStorageResolution() != null) sb.append("StorageResolution: ").append(getStorageResolution()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof MetricDatum == false) return false; MetricDatum other = (MetricDatum) obj; if (other.getMetricName() == null ^ this.getMetricName() == null) return false; if (other.getMetricName() != null && other.getMetricName().equals(this.getMetricName()) == false) return false; if (other.getDimensions() == null ^ this.getDimensions() == null) return false; if (other.getDimensions() != null && other.getDimensions().equals(this.getDimensions()) == false) return false; if (other.getTimestamp() == null ^ this.getTimestamp() == null) return false; if (other.getTimestamp() != null && other.getTimestamp().equals(this.getTimestamp()) == false) return false; if (other.getValue() == null ^ this.getValue() == null) return false; if (other.getValue() != null && other.getValue().equals(this.getValue()) == false) return false; if (other.getStatisticValues() == null ^ this.getStatisticValues() == null) return false; if (other.getStatisticValues() != null && other.getStatisticValues().equals(this.getStatisticValues()) == false) return false; if (other.getValues() == null ^ this.getValues() == null) return false; if (other.getValues() != null && other.getValues().equals(this.getValues()) == false) return false; if (other.getCounts() == null ^ this.getCounts() == null) return false; if (other.getCounts() != null && other.getCounts().equals(this.getCounts()) == false) return false; if (other.getUnit() == null ^ this.getUnit() == null) return false; if (other.getUnit() != null && other.getUnit().equals(this.getUnit()) == false) return false; if (other.getStorageResolution() == null ^ this.getStorageResolution() == null) return false; if (other.getStorageResolution() != null && other.getStorageResolution().equals(this.getStorageResolution()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getMetricName() == null) ? 0 : getMetricName().hashCode()); hashCode = prime * hashCode + ((getDimensions() == null) ? 0 : getDimensions().hashCode()); hashCode = prime * hashCode + ((getTimestamp() == null) ? 0 : getTimestamp().hashCode()); hashCode = prime * hashCode + ((getValue() == null) ? 0 : getValue().hashCode()); hashCode = prime * hashCode + ((getStatisticValues() == null) ? 0 : getStatisticValues().hashCode()); hashCode = prime * hashCode + ((getValues() == null) ? 0 : getValues().hashCode()); hashCode = prime * hashCode + ((getCounts() == null) ? 0 : getCounts().hashCode()); hashCode = prime * hashCode + ((getUnit() == null) ? 0 : getUnit().hashCode()); hashCode = prime * hashCode + ((getStorageResolution() == null) ? 0 : getStorageResolution().hashCode()); return hashCode; } @Override public MetricDatum clone() { try { return (MetricDatum) super.clone(); } catch (CloneNotSupportedException e) { throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e); } } }