Class MetricDataQuery
- java.lang.Object
-
- software.amazon.awssdk.services.cloudwatch.model.MetricDataQuery
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<MetricDataQuery.Builder,MetricDataQuery>
@Generated("software.amazon.awssdk:codegen") public final class MetricDataQuery extends Object implements SdkPojo, Serializable, ToCopyableBuilder<MetricDataQuery.Builder,MetricDataQuery>
This structure is used in both
GetMetricData
andPutMetricAlarm
. The supported use of this structure is different for those two operations.When used in
GetMetricData
, it indicates the metric data to return, and whether this call is just retrieving a batch set of data for one metric, or is performing a Metrics Insights query or a math expression. A singleGetMetricData
call can include up to 500MetricDataQuery
structures.When used in
PutMetricAlarm
, it enables you to create an alarm based on a metric math expression. EachMetricDataQuery
in the array specifies either a metric to retrieve, or a math expression to be performed on retrieved metrics. A singlePutMetricAlarm
call can include up to 20MetricDataQuery
structures in the array. The 20 structures can include as many as 10 structures that contain aMetricStat
parameter to retrieve a metric, and as many as 10 structures that contain theExpression
parameter to perform a math expression. Of thoseExpression
structures, one must havetrue
as the value forReturnData
. The result of this expression is the value the alarm watches.Any expression used in a
PutMetricAlarm
operation must return a single time series. For more information, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide.Some of the parameters of this structure also have different uses whether you are using this structure in a
GetMetricData
operation or aPutMetricAlarm
operation. These differences are explained in the following parameter list.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
MetricDataQuery.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description String
accountId()
The ID of the account where the metrics are located.static MetricDataQuery.Builder
builder()
boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
String
expression()
This field can contain either a Metrics Insights query, or a metric math expression to be performed on the returned data.<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
String
id()
A short name used to tie this object to the results in the response.String
label()
A human-readable label for this metric or expression.MetricStat
metricStat()
The metric to be returned, along with statistics, period, and units.Integer
period()
The granularity, in seconds, of the returned data points.Boolean
returnData()
When used inGetMetricData
, this option indicates whether to return the timestamps and raw data values of this metric.List<SdkField<?>>
sdkFields()
static Class<? extends MetricDataQuery.Builder>
serializableBuilderClass()
MetricDataQuery.Builder
toBuilder()
String
toString()
Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
id
public final 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.- Returns:
- 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.
-
metricStat
public final 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
orMetricStat
but not both.- Returns:
- 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
orMetricStat
but not both.
-
expression
public final String expression()
This field can contain either a Metrics Insights query, or a metric math expression to be performed on the returned data. For more information about Metrics Insights queries, see Metrics Insights query components and syntax in the Amazon CloudWatch User Guide.
A math expression can use the
Id
of the other metrics or queries to refer to those metrics, and can also use theId
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
orMetricStat
but not both.- Returns:
- This field can contain either a Metrics Insights query, or a metric math expression to be performed on
the returned data. For more information about Metrics Insights queries, see Metrics Insights query components and syntax in the Amazon CloudWatch User Guide.
A math expression can use the
Id
of the other metrics or queries to refer to those metrics, and can also use theId
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
orMetricStat
but not both.
-
label
public final 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.
- Returns:
- 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.
-
returnData
public final 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 specifyfalse
. If you omit this, the default oftrue
is used.When used in
PutMetricAlarm
, specifytrue
for the one expression result to use as the alarm. For all other metrics and expressions in the samePutMetricAlarm
operation, specifyReturnData
as False.- Returns:
- 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 specifyfalse
. If you omit this, the default oftrue
is used.When used in
PutMetricAlarm
, specifytrue
for the one expression result to use as the alarm. For all other metrics and expressions in the samePutMetricAlarm
operation, specifyReturnData
as False.
-
period
public final 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 aStorageResolution of 1 second
.- Returns:
- 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 aStorageResolution of 1 second
.
-
accountId
public final String accountId()
The ID of the account where the metrics are located.
If you are performing a
GetMetricData
operation in a monitoring account, use this to specify which account to retrieve this metric from.If you are performing a
PutMetricAlarm
operation, use this to specify which account contains the metric that the alarm is watching.- Returns:
- The ID of the account where the metrics are located.
If you are performing a
GetMetricData
operation in a monitoring account, use this to specify which account to retrieve this metric from.If you are performing a
PutMetricAlarm
operation, use this to specify which account contains the metric that the alarm is watching.
-
toBuilder
public MetricDataQuery.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<MetricDataQuery.Builder,MetricDataQuery>
-
builder
public static MetricDataQuery.Builder builder()
-
serializableBuilderClass
public static Class<? extends MetricDataQuery.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
toString
public final String toString()
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.
-
-