@Generated(value="com.amazonaws:awsjavasdkcodegenerator") public class MetricDataQuery extends Object implements Serializable, Cloneable
This structure 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 math expression on metric data. A single GetMetricData
call can include
up to 100 MetricDataQuery
structures.
Constructor and Description 

MetricDataQuery() 
Modifier and Type  Method and Description 

MetricDataQuery 
clone() 
boolean 
equals(Object obj) 
String 
getExpression()
The math expression to be performed on the returned data, if this structure is performing a math expression.

String 
getId()
A short name used to tie this structure 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.

Boolean 
getReturnData()
Indicates whether to return the time stamps and raw data values of this metric.

int 
hashCode() 
Boolean 
isReturnData()
Indicates whether to return the time stamps and raw data values of this metric.

void 
setExpression(String expression)
The math expression to be performed on the returned data, if this structure is performing a math expression.

void 
setId(String id)
A short name used to tie this structure 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 
setReturnData(Boolean returnData)
Indicates whether to return the time stamps and raw data values of this metric.

String 
toString()
Returns a string representation of this object; useful for testing and debugging.

MetricDataQuery 
withExpression(String expression)
The math expression to be performed on the returned data, if this structure is performing a math expression.

MetricDataQuery 
withId(String id)
A short name used to tie this structure 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 
withReturnData(Boolean returnData)
Indicates whether to return the time stamps and raw data values of this metric.

public void setId(String id)
A short name used to tie this structure 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 structure 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 structure 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 structure 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 structure 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 structure is performing a data retrieval and not performing a math expression on the returned data.
Within one MetricDataQuery structure, 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
structure is performing a data retrieval and not performing a math expression on the returned data.
Within one MetricDataQuery structure, 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 structure is performing a data retrieval and not performing a math expression on the returned data.
Within one MetricDataQuery structure, you must specify either Expression
or MetricStat
but not both.
Within one MetricDataQuery structure, 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 structure is performing a data retrieval and not performing a math expression on the returned data.
Within one MetricDataQuery structure, 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
structure is performing a data retrieval and not performing a math expression on the returned data.
Within one MetricDataQuery structure, you must specify either Expression
or
MetricStat
but not both.
public void setExpression(String expression)
The math expression to be performed on the returned data, if this structure is performing a math expression. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide.
Within one MetricDataQuery structure, you must specify either Expression
or MetricStat
but not both.
expression
 The math expression to be performed on the returned data, if this structure is performing a math
expression. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide.
Within one MetricDataQuery structure, you must specify either Expression
or
MetricStat
but not both.
public String getExpression()
The math expression to be performed on the returned data, if this structure is performing a math expression. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide.
Within one MetricDataQuery structure, you must specify either Expression
or MetricStat
but not both.
Within one MetricDataQuery structure, you must specify either Expression
or
MetricStat
but not both.
public MetricDataQuery withExpression(String expression)
The math expression to be performed on the returned data, if this structure is performing a math expression. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide.
Within one MetricDataQuery structure, you must specify either Expression
or MetricStat
but not both.
expression
 The math expression to be performed on the returned data, if this structure is performing a math
expression. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide.
Within one MetricDataQuery structure, 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.
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.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.
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.
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.public void setReturnData(Boolean returnData)
Indicates whether to return the time stamps 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.
returnData
 Indicates whether to return the time stamps 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.public Boolean getReturnData()
Indicates whether to return the time stamps 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.
False
. If you omit this, the default of True
is used.public MetricDataQuery withReturnData(Boolean returnData)
Indicates whether to return the time stamps 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.
returnData
 Indicates whether to return the time stamps 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.public Boolean isReturnData()
Indicates whether to return the time stamps 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.
False
. If you omit this, the default of True
is used.public String toString()
toString
in class Object
Object.toString()
public MetricDataQuery clone()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.