@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class TargetTrackingMetricDataQuery extends Object implements Serializable, Cloneable
The metric data to return. Also defines whether this call is returning data for one metric only, or whether it is performing a math expression on the values of returned metric statistics to create a new time series. A time series is a series of data points, each of which is associated with a timestamp.
Constructor and Description |
---|
TargetTrackingMetricDataQuery() |
Modifier and Type | Method and Description |
---|---|
TargetTrackingMetricDataQuery |
clone() |
boolean |
equals(Object obj) |
String |
getExpression()
The math expression to perform on the returned data, if this object is performing a math expression.
|
String |
getId()
A short name that identifies the object's results in the response.
|
String |
getLabel()
A human-readable label for this metric or expression.
|
TargetTrackingMetricStat |
getMetricStat()
Information about the metric data to return.
|
Boolean |
getReturnData()
Indicates whether to return the timestamps and raw data values of this metric.
|
int |
hashCode() |
Boolean |
isReturnData()
Indicates whether to return the timestamps and raw data values of this metric.
|
void |
setExpression(String expression)
The math expression to perform on the returned data, if this object is performing a math expression.
|
void |
setId(String id)
A short name that identifies the object's results in the response.
|
void |
setLabel(String label)
A human-readable label for this metric or expression.
|
void |
setMetricStat(TargetTrackingMetricStat metricStat)
Information about the metric data to return.
|
void |
setReturnData(Boolean returnData)
Indicates whether to return the timestamps and raw data values of this metric.
|
String |
toString()
Returns a string representation of this object.
|
TargetTrackingMetricDataQuery |
withExpression(String expression)
The math expression to perform on the returned data, if this object is performing a math expression.
|
TargetTrackingMetricDataQuery |
withId(String id)
A short name that identifies the object's results in the response.
|
TargetTrackingMetricDataQuery |
withLabel(String label)
A human-readable label for this metric or expression.
|
TargetTrackingMetricDataQuery |
withMetricStat(TargetTrackingMetricStat metricStat)
Information about the metric data to return.
|
TargetTrackingMetricDataQuery |
withReturnData(Boolean returnData)
Indicates whether to return the timestamps and raw data values of this metric.
|
public void setId(String id)
A short name that identifies the object's results in the response. This name must be unique among all
TargetTrackingMetricDataQuery
objects specified for a single scaling policy. 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 underscores. The first character must be
a lowercase letter.
id
- A short name that identifies the object's results in the response. This name must be unique among all
TargetTrackingMetricDataQuery
objects specified for a single scaling policy. 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 underscores. The
first character must be a lowercase letter.public String getId()
A short name that identifies the object's results in the response. This name must be unique among all
TargetTrackingMetricDataQuery
objects specified for a single scaling policy. 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 underscores. The first character must be
a lowercase letter.
TargetTrackingMetricDataQuery
objects specified for a single scaling policy. 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 underscores. The
first character must be a lowercase letter.public TargetTrackingMetricDataQuery withId(String id)
A short name that identifies the object's results in the response. This name must be unique among all
TargetTrackingMetricDataQuery
objects specified for a single scaling policy. 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 underscores. The first character must be
a lowercase letter.
id
- A short name that identifies the object's results in the response. This name must be unique among all
TargetTrackingMetricDataQuery
objects specified for a single scaling policy. 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 underscores. The
first character must be a lowercase letter.public void setExpression(String expression)
The math expression to perform 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.
Conditional: Within each TargetTrackingMetricDataQuery
object, you must specify either
Expression
or MetricStat
, but not both.
expression
- The math expression to perform 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.
Conditional: Within each TargetTrackingMetricDataQuery
object, you must specify either
Expression
or MetricStat
, but not both.
public String getExpression()
The math expression to perform 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.
Conditional: Within each TargetTrackingMetricDataQuery
object, you must specify either
Expression
or MetricStat
, but not both.
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.
Conditional: Within each TargetTrackingMetricDataQuery
object, you must specify either
Expression
or MetricStat
, but not both.
public TargetTrackingMetricDataQuery withExpression(String expression)
The math expression to perform 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.
Conditional: Within each TargetTrackingMetricDataQuery
object, you must specify either
Expression
or MetricStat
, but not both.
expression
- The math expression to perform 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.
Conditional: Within each TargetTrackingMetricDataQuery
object, you must specify either
Expression
or MetricStat
, but not both.
public void setMetricStat(TargetTrackingMetricStat metricStat)
Information about the metric data to return.
Conditional: Within each TargetTrackingMetricDataQuery
object, you must specify either
Expression
or MetricStat
, but not both.
metricStat
- Information about the metric data to return.
Conditional: Within each TargetTrackingMetricDataQuery
object, you must specify either
Expression
or MetricStat
, but not both.
public TargetTrackingMetricStat getMetricStat()
Information about the metric data to return.
Conditional: Within each TargetTrackingMetricDataQuery
object, you must specify either
Expression
or MetricStat
, but not both.
Conditional: Within each TargetTrackingMetricDataQuery
object, you must specify either
Expression
or MetricStat
, but not both.
public TargetTrackingMetricDataQuery withMetricStat(TargetTrackingMetricStat metricStat)
Information about the metric data to return.
Conditional: Within each TargetTrackingMetricDataQuery
object, you must specify either
Expression
or MetricStat
, but not both.
metricStat
- Information about the metric data to return.
Conditional: Within each TargetTrackingMetricDataQuery
object, you must specify either
Expression
or MetricStat
, but not both.
public void setLabel(String label)
A human-readable label for this metric or expression. This is especially useful if this is a math expression, so that you know what the value represents.
label
- A human-readable label for this metric or expression. This is especially useful if this is a math
expression, so that you know what the value represents.public String getLabel()
A human-readable label for this metric or expression. This is especially useful if this is a math expression, so that you know what the value represents.
public TargetTrackingMetricDataQuery withLabel(String label)
A human-readable label for this metric or expression. This is especially useful if this is a math expression, so that you know what the value represents.
label
- A human-readable label for this metric or expression. This is especially useful if this is a math
expression, so that you know what the value represents.public void setReturnData(Boolean returnData)
Indicates whether to return the timestamps and raw data values of this metric.
If you use any math expressions, specify true
for this value for only the final math expression that
the metric specification is based on. You must specify false
for ReturnData
for all the
other metrics and expressions used in the metric specification.
If you are only retrieving metrics and not performing any math expressions, do not specify anything for
ReturnData
. This sets it to its default (true
).
returnData
- Indicates whether to return the timestamps and raw data values of this metric.
If you use any math expressions, specify true
for this value for only the final math
expression that the metric specification is based on. You must specify false
for
ReturnData
for all the other metrics and expressions used in the metric specification.
If you are only retrieving metrics and not performing any math expressions, do not specify anything for
ReturnData
. This sets it to its default (true
).
public Boolean getReturnData()
Indicates whether to return the timestamps and raw data values of this metric.
If you use any math expressions, specify true
for this value for only the final math expression that
the metric specification is based on. You must specify false
for ReturnData
for all the
other metrics and expressions used in the metric specification.
If you are only retrieving metrics and not performing any math expressions, do not specify anything for
ReturnData
. This sets it to its default (true
).
If you use any math expressions, specify true
for this value for only the final math
expression that the metric specification is based on. You must specify false
for
ReturnData
for all the other metrics and expressions used in the metric specification.
If you are only retrieving metrics and not performing any math expressions, do not specify anything for
ReturnData
. This sets it to its default (true
).
public TargetTrackingMetricDataQuery withReturnData(Boolean returnData)
Indicates whether to return the timestamps and raw data values of this metric.
If you use any math expressions, specify true
for this value for only the final math expression that
the metric specification is based on. You must specify false
for ReturnData
for all the
other metrics and expressions used in the metric specification.
If you are only retrieving metrics and not performing any math expressions, do not specify anything for
ReturnData
. This sets it to its default (true
).
returnData
- Indicates whether to return the timestamps and raw data values of this metric.
If you use any math expressions, specify true
for this value for only the final math
expression that the metric specification is based on. You must specify false
for
ReturnData
for all the other metrics and expressions used in the metric specification.
If you are only retrieving metrics and not performing any math expressions, do not specify anything for
ReturnData
. This sets it to its default (true
).
public Boolean isReturnData()
Indicates whether to return the timestamps and raw data values of this metric.
If you use any math expressions, specify true
for this value for only the final math expression that
the metric specification is based on. You must specify false
for ReturnData
for all the
other metrics and expressions used in the metric specification.
If you are only retrieving metrics and not performing any math expressions, do not specify anything for
ReturnData
. This sets it to its default (true
).
If you use any math expressions, specify true
for this value for only the final math
expression that the metric specification is based on. You must specify false
for
ReturnData
for all the other metrics and expressions used in the metric specification.
If you are only retrieving metrics and not performing any math expressions, do not specify anything for
ReturnData
. This sets it to its default (true
).
public String toString()
toString
in class Object
Object.toString()
public TargetTrackingMetricDataQuery clone()