MetricDataQuery (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.autoscaling.model.MetricDataQuery

All Implemented Interfaces:

Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class MetricDataQuery
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.

For more information and examples, see Advanced predictive scaling policy configurations using custom metrics in the Amazon EC2 Auto Scaling User Guide.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

MetricDataQuery()

Constructors
Constructor and Description
`MetricDataQuery()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MetricDataQuery`	`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.
`MetricStat`	`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(MetricStat 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.
`MetricDataQuery`	`withExpression(String expression)` The math expression to perform on the returned data, if this object is performing a math expression.
`MetricDataQuery`	`withId(String id)` A short name that identifies the object's results in the response.
`MetricDataQuery`	`withLabel(String label)` A human-readable label for this metric or expression.
`MetricDataQuery`	`withMetricStat(MetricStat metricStat)` Information about the metric data to return.
`MetricDataQuery`	`withReturnData(Boolean returnData)` Indicates whether to return the timestamps and raw data values of this metric.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - MetricDataQuery
```
public MetricDataQuery()
```
- Method Detail
  - setId
```
public void setId(String id)
```
    A short name that identifies the object's results in the response. This name must be unique among all MetricDataQuery 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.
    
    Parameters:
    
    id - A short name that identifies the object's results in the response. This name must be unique among all MetricDataQuery 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.
  - getId
```
public String getId()
```
    A short name that identifies the object's results in the response. This name must be unique among all MetricDataQuery 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.
    
    Returns:
    
    A short name that identifies the object's results in the response. This name must be unique among all MetricDataQuery 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.
  - withId
```
public MetricDataQuery withId(String id)
```
    A short name that identifies the object's results in the response. This name must be unique among all MetricDataQuery 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.
    
    Parameters:
    
    id - A short name that identifies the object's results in the response. This name must be unique among all MetricDataQuery 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setExpression
```
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 MetricDataQuery object, you must specify either Expression or MetricStat, but not both.
    
    Parameters:
    
    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 MetricDataQuery object, you must specify either Expression or MetricStat, but not both.
  - getExpression
```
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 MetricDataQuery object, you must specify either Expression or MetricStat, but not both.
    
    Returns:
    
    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 MetricDataQuery object, you must specify either Expression or MetricStat, but not both.
  - withExpression
```
public MetricDataQuery 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 MetricDataQuery object, you must specify either Expression or MetricStat, but not both.
    
    Parameters:
    
    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 MetricDataQuery object, you must specify either Expression or MetricStat, but not both.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMetricStat
```
public void setMetricStat(MetricStat metricStat)
```
    Information about the metric data to return.
    
    Conditional: Within each MetricDataQuery object, you must specify either Expression or MetricStat, but not both.
    
    Parameters:
    
    metricStat - Information about the metric data to return.
    
    Conditional: Within each MetricDataQuery object, you must specify either Expression or MetricStat, but not both.
  - getMetricStat
```
public MetricStat getMetricStat()
```
    Information about the metric data to return.
    
    Conditional: Within each MetricDataQuery object, you must specify either Expression or MetricStat, but not both.
    
    Returns:
    
    Information about the metric data to return.
    
    Conditional: Within each MetricDataQuery object, you must specify either Expression or MetricStat, but not both.
  - withMetricStat
```
public MetricDataQuery withMetricStat(MetricStat metricStat)
```
    Information about the metric data to return.
    
    Conditional: Within each MetricDataQuery object, you must specify either Expression or MetricStat, but not both.
    
    Parameters:
    
    metricStat - Information about the metric data to return.
    
    Conditional: Within each MetricDataQuery object, you must specify either Expression or MetricStat, but not both.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLabel
```
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.
    
    Parameters:
    
    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.
  - getLabel
```
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.
    
    Returns:
    
    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.
  - withLabel
```
public MetricDataQuery 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setReturnData
```
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).
    
    Parameters:
    
    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).
  - getReturnData
```
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).
    
    Returns:
    
    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).
  - withReturnData
```
public MetricDataQuery 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).
    
    Parameters:
    
    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).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isReturnData
```
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).
    
    Returns:
    
    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).
  - toString
```
public 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.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public MetricDataQuery clone()
```
    Overrides:
    
    clone in class Object

AWS SDK for Java 1.x API Reference - 1.12.779

Class MetricDataQuery

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MetricDataQuery

Method Detail

setId

getId

withId

setExpression

getExpression

withExpression

setMetricStat

getMetricStat

withMetricStat

setLabel

getLabel

withLabel

setReturnData

getReturnData

withReturnData

isReturnData

toString

equals

hashCode

clone