@Generated(value="com.amazonaws:awsjavasdkcodegenerator") public class MetricDataQuery extends Object implements Serializable, Cloneable
This structure is used in both GetMetricData
and PutMetricAlarm
. 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
single GetMetricData
call can include up to 500 MetricDataQuery
structures.
When used in PutMetricAlarm
, it enables you to create an alarm based on a metric math expression. Each
MetricDataQuery
in the array specifies either a metric to retrieve, or a math expression to be performed
on retrieved metrics. A single PutMetricAlarm
call can include up to 20 MetricDataQuery
structures in the array. The 20 structures can include as many as 10 structures that contain a
MetricStat
parameter to retrieve a metric, and as many as 10 structures that contain the
Expression
parameter to perform a math expression. Of those Expression
structures, one must
have True
as the value for ReturnData
. 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 a PutMetricAlarm
operation. These differences are explained in
the following parameter list.
Constructor and Description 

MetricDataQuery() 
Modifier and Type  Method and Description 

MetricDataQuery 
clone() 
boolean 
equals(Object obj) 
String 
getAccountId()
The ID of the account where the metrics are located, if this is a crossaccount alarm.

String 
getExpression()
This field can contain either a Metrics Insights query, or a metric math expression to be performed on the
returned data.

String 
getId()
A short name used to tie this object to the results in the response.

String 
getLabel()
A humanreadable label for this metric or expression.

MetricStat 
getMetricStat()
The metric to be returned, along with statistics, period, and units.

Integer 
getPeriod()
The granularity, in seconds, of the returned data points.

Boolean 
getReturnData()
When used in
GetMetricData , this option indicates whether to return the timestamps and raw data
values of this metric. 
int 
hashCode() 
Boolean 
isReturnData()
When used in
GetMetricData , this option indicates whether to return the timestamps and raw data
values of this metric. 
void 
setAccountId(String accountId)
The ID of the account where the metrics are located, if this is a crossaccount alarm.

void 
setExpression(String expression)
This field can contain either a Metrics Insights query, or a metric math expression to be performed on the
returned data.

void 
setId(String id)
A short name used to tie this object to the results in the response.

void 
setLabel(String label)
A humanreadable label for this metric or expression.

void 
setMetricStat(MetricStat metricStat)
The metric to be returned, along with statistics, period, and units.

void 
setPeriod(Integer period)
The granularity, in seconds, of the returned data points.

void 
setReturnData(Boolean returnData)
When used in
GetMetricData , this option indicates whether to return the timestamps and raw data
values of this metric. 
String 
toString()
Returns a string representation of this object.

MetricDataQuery 
withAccountId(String accountId)
The ID of the account where the metrics are located, if this is a crossaccount alarm.

MetricDataQuery 
withExpression(String expression)
This field can contain either a Metrics Insights query, or a metric math expression to be performed on the
returned data.

MetricDataQuery 
withId(String id)
A short name used to tie this object to the results in the response.

MetricDataQuery 
withLabel(String label)
A humanreadable label for this metric or expression.

MetricDataQuery 
withMetricStat(MetricStat metricStat)
The metric to be returned, along with statistics, period, and units.

MetricDataQuery 
withPeriod(Integer period)
The granularity, in seconds, of the returned data points.

MetricDataQuery 
withReturnData(Boolean returnData)
When used in
GetMetricData , this option indicates whether to return the timestamps and raw data
values of this metric. 
public void setId(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.public String getId()
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.
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.public MetricDataQuery withId(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.public void setMetricStat(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.
public MetricStat getMetricStat()
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.
Within one MetricDataQuery object, you must specify either Expression
or
MetricStat
but not both.
public MetricDataQuery withMetricStat(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.
public void setExpression(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 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
 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 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.
public String getExpression()
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 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.
A math expression can use the Id
of the other metrics or queries 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.
public MetricDataQuery withExpression(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 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
 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 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.
public void setLabel(String label)
A humanreadable 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 humanreadable 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.
public String getLabel()
A humanreadable 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.
You can put dynamic expressions into a label, so that it is more descriptive. For more information, see Using Dynamic Labels.
public MetricDataQuery withLabel(String label)
A humanreadable 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 humanreadable 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.
public void setReturnData(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.
public Boolean getReturnData()
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.
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.
public MetricDataQuery withReturnData(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.
public Boolean isReturnData()
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.
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.
public void setPeriod(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 highresolution 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. Highresolution
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 highresolution 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. Highresolution metrics are those metrics stored by a PutMetricData
operation that
includes a StorageResolution of 1 second
.public Integer getPeriod()
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 highresolution 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. Highresolution
metrics are those metrics stored by a PutMetricData
operation that includes a
StorageResolution of 1 second
.
PutMetricData
operation that
includes a StorageResolution of 1 second
.public MetricDataQuery withPeriod(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 highresolution 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. Highresolution
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 highresolution 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. Highresolution metrics are those metrics stored by a PutMetricData
operation that
includes a StorageResolution of 1 second
.public void setAccountId(String accountId)
The ID of the account where the metrics are located, if this is a crossaccount 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 crossaccount alarm.
Use this field only for PutMetricAlarm
operations. It is not used in
GetMetricData
operations.
public String getAccountId()
The ID of the account where the metrics are located, if this is a crossaccount alarm.
Use this field only for PutMetricAlarm
operations. It is not used in GetMetricData
operations.
Use this field only for PutMetricAlarm
operations. It is not used in
GetMetricData
operations.
public MetricDataQuery withAccountId(String accountId)
The ID of the account where the metrics are located, if this is a crossaccount 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 crossaccount alarm.
Use this field only for PutMetricAlarm
operations. It is not used in
GetMetricData
operations.
public String toString()
toString
in class Object
Object.toString()
public MetricDataQuery clone()