Interface MetricDatum.Builder
-
- All Superinterfaces:
Buildable
,CopyableBuilder<MetricDatum.Builder,MetricDatum>
,SdkBuilder<MetricDatum.Builder,MetricDatum>
,SdkPojo
- Enclosing class:
- MetricDatum
public static interface MetricDatum.Builder extends SdkPojo, CopyableBuilder<MetricDatum.Builder,MetricDatum>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description MetricDatum.Builder
counts(Double... counts)
Array of numbers that is used along with theValues
array.MetricDatum.Builder
counts(Collection<Double> counts)
Array of numbers that is used along with theValues
array.MetricDatum.Builder
dimensions(Collection<Dimension> dimensions)
The dimensions associated with the metric.MetricDatum.Builder
dimensions(Consumer<Dimension.Builder>... dimensions)
The dimensions associated with the metric.MetricDatum.Builder
dimensions(Dimension... dimensions)
The dimensions associated with the metric.MetricDatum.Builder
metricName(String metricName)
The name of the metric.default MetricDatum.Builder
statisticValues(Consumer<StatisticSet.Builder> statisticValues)
The statistical values for the metric.MetricDatum.Builder
statisticValues(StatisticSet statisticValues)
The statistical values for the metric.MetricDatum.Builder
storageResolution(Integer storageResolution)
Valid values are 1 and 60.MetricDatum.Builder
timestamp(Instant timestamp)
The time the metric data was received, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.MetricDatum.Builder
unit(String unit)
When you are using aPut
operation, this defines what unit you want to use when storing the metric.MetricDatum.Builder
unit(StandardUnit unit)
When you are using aPut
operation, this defines what unit you want to use when storing the metric.MetricDatum.Builder
value(Double value)
The value for the metric.MetricDatum.Builder
values(Double... values)
Array of numbers representing the values for the metric during the period.MetricDatum.Builder
values(Collection<Double> values)
Array of numbers representing the values for the metric during the period.-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
Method Detail
-
metricName
MetricDatum.Builder metricName(String metricName)
The name of the metric.
- Parameters:
metricName
- The name of the metric.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dimensions
MetricDatum.Builder dimensions(Collection<Dimension> dimensions)
The dimensions associated with the metric.
- Parameters:
dimensions
- The dimensions associated with the metric.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dimensions
MetricDatum.Builder dimensions(Dimension... dimensions)
The dimensions associated with the metric.
- Parameters:
dimensions
- The dimensions associated with the metric.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dimensions
MetricDatum.Builder dimensions(Consumer<Dimension.Builder>... dimensions)
The dimensions associated with the metric.
This is a convenience method that creates an instance of theDimension.Builder
avoiding the need to create one manually viaDimension.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed to#dimensions(List
.) - Parameters:
dimensions
- a consumer that will call methods onDimension.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#dimensions(java.util.Collection
)
-
timestamp
MetricDatum.Builder timestamp(Instant timestamp)
The time the metric data was received, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.
- Parameters:
timestamp
- The time the metric data was received, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
value
MetricDatum.Builder value(Double 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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
statisticValues
MetricDatum.Builder statisticValues(StatisticSet statisticValues)
The statistical values for the metric.
- Parameters:
statisticValues
- The statistical values for the metric.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
statisticValues
default MetricDatum.Builder statisticValues(Consumer<StatisticSet.Builder> statisticValues)
The statistical values for the metric.
This is a convenience method that creates an instance of theStatisticSet.Builder
avoiding the need to create one manually viaStatisticSet.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tostatisticValues(StatisticSet)
.- Parameters:
statisticValues
- a consumer that will call methods onStatisticSet.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
statisticValues(StatisticSet)
-
values
MetricDatum.Builder values(Collection<Double> values)
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 eachPutMetricData
action that specifies aValues
array.Although the
Values
array accepts numbers of typeDouble
, 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.- Parameters:
values
- 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 theCounts
array specifies the number of times that value occurred during the period. You can include up to 150 unique values in eachPutMetricData
action that specifies aValues
array.Although the
Values
array accepts numbers of typeDouble
, 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
values
MetricDatum.Builder values(Double... values)
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 eachPutMetricData
action that specifies aValues
array.Although the
Values
array accepts numbers of typeDouble
, 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.- Parameters:
values
- 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 theCounts
array specifies the number of times that value occurred during the period. You can include up to 150 unique values in eachPutMetricData
action that specifies aValues
array.Although the
Values
array accepts numbers of typeDouble
, 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
counts
MetricDatum.Builder counts(Collection<Double> counts)
Array of numbers that is used along with the
Values
array. Each number in theCount
array is the number of times the corresponding value in theValues
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 aCounts
array, it must include the same amount of values as theValues
array.- Parameters:
counts
- Array of numbers that is used along with theValues
array. Each number in theCount
array is the number of times the corresponding value in theValues
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 aCounts
array, it must include the same amount of values as theValues
array.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
counts
MetricDatum.Builder counts(Double... counts)
Array of numbers that is used along with the
Values
array. Each number in theCount
array is the number of times the corresponding value in theValues
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 aCounts
array, it must include the same amount of values as theValues
array.- Parameters:
counts
- Array of numbers that is used along with theValues
array. Each number in theCount
array is the number of times the corresponding value in theValues
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 aCounts
array, it must include the same amount of values as theValues
array.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
unit
MetricDatum.Builder unit(String 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.- Parameters:
unit
- When you are using aPut
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
StandardUnit
,StandardUnit
-
unit
MetricDatum.Builder unit(StandardUnit 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.- Parameters:
unit
- When you are using aPut
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
StandardUnit
,StandardUnit
-
storageResolution
MetricDatum.Builder storageResolution(Integer 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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-