public static interface MetricDataQuery.Builder extends SdkPojo, CopyableBuilder<MetricDataQuery.Builder,MetricDataQuery>
Modifier and Type | Method and Description |
---|---|
MetricDataQuery.Builder |
accountId(String accountId)
The ID of the account where the metrics are located, if this is a cross-account alarm.
|
MetricDataQuery.Builder |
expression(String expression)
The math expression to be performed on the returned data, if this object is performing a math expression.
|
MetricDataQuery.Builder |
id(String id)
A short name used to tie this object to the results in the response.
|
MetricDataQuery.Builder |
label(String label)
A human-readable label for this metric or expression.
|
default MetricDataQuery.Builder |
metricStat(Consumer<MetricStat.Builder> metricStat)
The metric to be returned, along with statistics, period, and units.
|
MetricDataQuery.Builder |
metricStat(MetricStat metricStat)
The metric to be returned, along with statistics, period, and units.
|
MetricDataQuery.Builder |
period(Integer period)
The granularity, in seconds, of the returned data points.
|
MetricDataQuery.Builder |
returnData(Boolean returnData)
When used in
GetMetricData , this option indicates whether to return the timestamps and raw data
values of this metric. |
equalsBySdkFields, sdkFields
copy
applyMutation, build
MetricDataQuery.Builder id(String id)
A short name used to tie this object to the results in the response. This name must be unique within a single
call to GetMetricData
. If you are performing math expressions on this set of data, this name
represents that data and can serve as a variable in the mathematical expression. The valid characters are
letters, numbers, and underscore. The first character must be a lowercase letter.
id
- A short name used to tie this object to the results in the response. This name must be unique within a
single call to GetMetricData
. If you are performing math expressions on this set of data,
this name represents that data and can serve as a variable in the mathematical expression. The valid
characters are letters, numbers, and underscore. The first character must be a lowercase letter.MetricDataQuery.Builder metricStat(MetricStat metricStat)
The metric to be returned, along with statistics, period, and units. Use this parameter only if this object is retrieving a metric and not performing a math expression on returned data.
Within one MetricDataQuery object, you must specify either Expression
or MetricStat
but not both.
metricStat
- The metric to be returned, along with statistics, period, and units. Use this parameter only if this
object is retrieving a metric and not performing a math expression on returned data.
Within one MetricDataQuery object, you must specify either Expression
or
MetricStat
but not both.
default MetricDataQuery.Builder metricStat(Consumer<MetricStat.Builder> metricStat)
The metric to be returned, along with statistics, period, and units. Use this parameter only if this object is retrieving a metric and not performing a math expression on returned data.
Within one MetricDataQuery object, you must specify either Expression
or MetricStat
but not both.
MetricStat.Builder
avoiding the need to create
one manually via MetricStat.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and its result
is passed to metricStat(MetricStat)
.metricStat
- a consumer that will call methods on MetricStat.Builder
metricStat(MetricStat)
MetricDataQuery.Builder expression(String expression)
The math expression to be performed on the returned data, if this object is performing a math expression.
This expression can use the Id
of the other metrics to refer to those metrics, and can also use
the Id
of other expressions to use the result of those expressions. For more information about
metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide.
Within each MetricDataQuery object, you must specify either Expression
or
MetricStat
but not both.
expression
- The math expression to be performed on the returned data, if this object is performing a math
expression. This expression can use the Id
of the other metrics to refer to those
metrics, and can also use the Id
of other expressions to use the result of those
expressions. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide.
Within each MetricDataQuery object, you must specify either Expression
or
MetricStat
but not both.
MetricDataQuery.Builder label(String label)
A human-readable label for this metric or expression. This is especially useful if this is an expression, so that you know what the value represents. If the metric or expression is shown in a CloudWatch dashboard widget, the label is shown. If Label is omitted, CloudWatch generates a default.
You can put dynamic expressions into a label, so that it is more descriptive. For more information, see Using Dynamic Labels.
label
- A human-readable label for this metric or expression. This is especially useful if this is an
expression, so that you know what the value represents. If the metric or expression is shown in a
CloudWatch dashboard widget, the label is shown. If Label is omitted, CloudWatch generates a
default.
You can put dynamic expressions into a label, so that it is more descriptive. For more information, see Using Dynamic Labels.
MetricDataQuery.Builder returnData(Boolean returnData)
When used in GetMetricData
, this option indicates whether to return the timestamps and raw data
values of this metric. If you are performing this call just to do math expressions and do not also need the
raw data returned, you can specify False
. If you omit this, the default of True
is
used.
When used in PutMetricAlarm
, specify True
for the one expression result to use as
the alarm. For all other metrics and expressions in the same PutMetricAlarm
operation, specify
ReturnData
as False.
returnData
- When used in GetMetricData
, this option indicates whether to return the timestamps and
raw data values of this metric. If you are performing this call just to do math expressions and do not
also need the raw data returned, you can specify False
. If you omit this, the default of
True
is used.
When used in PutMetricAlarm
, specify True
for the one expression result to
use as the alarm. For all other metrics and expressions in the same PutMetricAlarm
operation, specify ReturnData
as False.
MetricDataQuery.Builder period(Integer period)
The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can
be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are
collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60.
High-resolution metrics are those metrics stored by a PutMetricData
operation that includes a
StorageResolution of 1 second
.
period
- The granularity, in seconds, of the returned data points. For metrics with regular resolution, a
period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution
metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60,
or any multiple of 60. High-resolution metrics are those metrics stored by a
PutMetricData
operation that includes a StorageResolution of 1 second
.MetricDataQuery.Builder accountId(String accountId)
The ID of the account where the metrics are located, if this is a cross-account alarm.
Use this field only for PutMetricAlarm
operations. It is not used in GetMetricData
operations.
accountId
- The ID of the account where the metrics are located, if this is a cross-account alarm.
Use this field only for PutMetricAlarm
operations. It is not used in
GetMetricData
operations.
Copyright © 2021. All rights reserved.