public static interface MetricStat.Builder extends SdkPojo, CopyableBuilder<MetricStat.Builder,MetricStat>
Modifier and Type | Method and Description |
---|---|
default MetricStat.Builder |
metric(Consumer<Metric.Builder> metric)
The metric to return, including the metric name, namespace, and dimensions.
|
MetricStat.Builder |
metric(Metric metric)
The metric to return, including the metric name, namespace, and dimensions.
|
MetricStat.Builder |
period(Integer period)
The period, in seconds, to use when retrieving the metric.
|
MetricStat.Builder |
stat(String stat)
The statistic to return.
|
MetricStat.Builder |
unit(StandardUnit unit)
When you are using a
Put operation, this defines what unit you want to use when storing the
metric. |
MetricStat.Builder |
unit(String unit)
When you are using a
Put operation, this defines what unit you want to use when storing the
metric. |
equalsBySdkFields, sdkFields
copy
applyMutation, build
MetricStat.Builder metric(Metric metric)
The metric to return, including the metric name, namespace, and dimensions.
metric
- The metric to return, including the metric name, namespace, and dimensions.default MetricStat.Builder metric(Consumer<Metric.Builder> metric)
The metric to return, including the metric name, namespace, and dimensions.
This is a convenience that creates an instance of theMetric.Builder
avoiding the need to create one
manually via Metric.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and its result is
passed to metric(Metric)
.metric
- a consumer that will call methods on Metric.Builder
metric(Metric)
MetricStat.Builder period(Integer period)
The period, in seconds, to use when retrieving the metric.
period
- The period, in seconds, to use when retrieving the metric.MetricStat.Builder stat(String stat)
The statistic to return. It can include any CloudWatch statistic or extended statistic.
stat
- The statistic to return. It can include any CloudWatch statistic or extended statistic.MetricStat.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, if you omit Unit
then all data that was collected with any unit
is returned, along with the corresponding units that were specified when the data was reported to CloudWatch.
If you specify a unit, the operation returns only data data that was collected with that unit specified. If
you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch
does not perform unit conversions.
unit
- When you are using a Put
operation, this defines what unit you want to use when storing
the metric.
In a Get
operation, if you omit Unit
then all data that was collected with
any unit is returned, along with the corresponding units that were specified when the data was
reported to CloudWatch. If you specify a unit, the operation returns only data data that was collected
with that unit specified. If you specify a unit that does not match the data collected, the results of
the operation are null. CloudWatch does not perform unit conversions.
StandardUnit
,
StandardUnit
MetricStat.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, if you omit Unit
then all data that was collected with any unit
is returned, along with the corresponding units that were specified when the data was reported to CloudWatch.
If you specify a unit, the operation returns only data data that was collected with that unit specified. If
you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch
does not perform unit conversions.
unit
- When you are using a Put
operation, this defines what unit you want to use when storing
the metric.
In a Get
operation, if you omit Unit
then all data that was collected with
any unit is returned, along with the corresponding units that were specified when the data was
reported to CloudWatch. If you specify a unit, the operation returns only data data that was collected
with that unit specified. If you specify a unit that does not match the data collected, the results of
the operation are null. CloudWatch does not perform unit conversions.
StandardUnit
,
StandardUnit
Copyright © 2019. All rights reserved.