MetricDataQuery (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class MetricDataQuery
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Use this structure to define a metric or metric math expression that you want to use as for a service level objective.

Each MetricDataQuery in the MetricDataQueries array specifies either a metric to retrieve, or a metric math expression to be performed on retrieved metrics. A single MetricDataQueries array can include as many as 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, exactly one must have true as the value for ReturnData. The result of this expression used for the SLO.

For more information about metric math expressions, see CloudWatchUse metric math.

Within each MetricDataQuery object, you must specify either Expression or MetricStat but not both.

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`	`getAccountId()` The ID of the account where this metric is located.
`String`	`getExpression()` This field can contain a metric math expression to be performed on the other metrics that you are retrieving within this `MetricDataQueries` structure.
`String`	`getId()` A short name used to tie this object to the results in the response.
`String`	`getLabel()` A human-readable label for this metric or expression.
`MetricStat`	`getMetricStat()` A metric to be used directly for the SLO, or to be used in the math expression that will be used for the SLO.
`Integer`	`getPeriod()` The granularity, in seconds, of the returned data points for this metric.
`Boolean`	`getReturnData()` Use this only if you are using a metric math expression for the SLO.
`int`	`hashCode()`
`Boolean`	`isReturnData()` Use this only if you are using a metric math expression for the SLO.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAccountId(String accountId)` The ID of the account where this metric is located.
`void`	`setExpression(String expression)` This field can contain a metric math expression to be performed on the other metrics that you are retrieving within this `MetricDataQueries` structure.
`void`	`setId(String id)` A short name used to tie this object to the results in the response.
`void`	`setLabel(String label)` A human-readable label for this metric or expression.
`void`	`setMetricStat(MetricStat metricStat)` A metric to be used directly for the SLO, or to be used in the math expression that will be used for the SLO.
`void`	`setPeriod(Integer period)` The granularity, in seconds, of the returned data points for this metric.
`void`	`setReturnData(Boolean returnData)` Use this only if you are using a metric math expression for the SLO.
`String`	`toString()` Returns a string representation of this object.
`MetricDataQuery`	`withAccountId(String accountId)` The ID of the account where this metric is located.
`MetricDataQuery`	`withExpression(String expression)` This field can contain a metric math expression to be performed on the other metrics that you are retrieving within this `MetricDataQueries` structure.
`MetricDataQuery`	`withId(String id)` A short name used to tie this object to the results in the response.
`MetricDataQuery`	`withLabel(String label)` A human-readable label for this metric or expression.
`MetricDataQuery`	`withMetricStat(MetricStat metricStat)` A metric to be used directly for the SLO, or to be used in the math expression that will be used for the SLO.
`MetricDataQuery`	`withPeriod(Integer period)` The granularity, in seconds, of the returned data points for this metric.
`MetricDataQuery`	`withReturnData(Boolean returnData)` Use this only if you are using a metric math expression for the SLO.

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 used to tie this object to the results in the response. This Id must be unique within a MetricDataQueries array. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the metric math expression. The valid characters are letters, numbers, and underscore. The first character must be a lowercase letter.
    
    Parameters:
    
    id - A short name used to tie this object to the results in the response. This Id must be unique within a MetricDataQueries array. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the metric math expression. The valid characters are letters, numbers, and underscore. The first character must be a lowercase letter.
  - getId
```
public String getId()
```
    A short name used to tie this object to the results in the response. This Id must be unique within a MetricDataQueries array. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the metric math 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 Id must be unique within a MetricDataQueries array. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the metric math expression. The valid characters are letters, numbers, and underscore. The first character must be a lowercase letter.
  - withId
```
public MetricDataQuery withId(String id)
```
    A short name used to tie this object to the results in the response. This Id must be unique within a MetricDataQueries array. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the metric math expression. The valid characters are letters, numbers, and underscore. The first character must be a lowercase letter.
    
    Parameters:
    
    id - A short name used to tie this object to the results in the response. This Id must be unique within a MetricDataQueries array. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the metric math expression. The valid characters are letters, numbers, and underscore. The first character must be a lowercase letter.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMetricStat
```
public void setMetricStat(MetricStat metricStat)
```
    A metric to be used directly for the SLO, or to be used in the math expression that will be used for the SLO.
    
    Within one MetricDataQuery object, you must specify either Expression or MetricStat but not both.
    
    Parameters:
    
    metricStat - A metric to be used directly for the SLO, or to be used in the math expression that will be used for the SLO.
    
    Within one MetricDataQuery object, you must specify either Expression or MetricStat but not both.
  - getMetricStat
```
public MetricStat getMetricStat()
```
    A metric to be used directly for the SLO, or to be used in the math expression that will be used for the SLO.
    
    Within one MetricDataQuery object, you must specify either Expression or MetricStat but not both.
    
    Returns:
    
    A metric to be used directly for the SLO, or to be used in the math expression that will be used for the SLO.
    
    Within one MetricDataQuery object, you must specify either Expression or MetricStat but not both.
  - withMetricStat
```
public MetricDataQuery withMetricStat(MetricStat metricStat)
```
    A metric to be used directly for the SLO, or to be used in the math expression that will be used for the SLO.
    
    Within one MetricDataQuery object, you must specify either Expression or MetricStat but not both.
    
    Parameters:
    
    metricStat - A metric to be used directly for the SLO, or to be used in the math expression that will be used for the SLO.
    
    Within one 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.
  - setExpression
```
public void setExpression(String expression)
```
    This field can contain a metric math expression to be performed on the other metrics that you are retrieving within this MetricDataQueries structure.
    
    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.
    
    Parameters:
    
    expression - This field can contain a metric math expression to be performed on the other metrics that you are retrieving within this MetricDataQueries structure.
    
    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.
  - getExpression
```
public String getExpression()
```
    This field can contain a metric math expression to be performed on the other metrics that you are retrieving within this MetricDataQueries structure.
    
    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.
    
    Returns:
    
    This field can contain a metric math expression to be performed on the other metrics that you are retrieving within this MetricDataQueries structure.
    
    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.
  - withExpression
```
public MetricDataQuery withExpression(String expression)
```
    This field can contain a metric math expression to be performed on the other metrics that you are retrieving within this MetricDataQueries structure.
    
    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.
    
    Parameters:
    
    expression - This field can contain a metric math expression to be performed on the other metrics that you are retrieving within this MetricDataQueries structure.
    
    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.
    
    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 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.
    
    Parameters:
    
    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.
  - getLabel
```
public String getLabel()
```
    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.
  - withLabel
```
public MetricDataQuery withLabel(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setReturnData
```
public void setReturnData(Boolean returnData)
```
    Use this only if you are using a metric math expression for the SLO. Specify true for ReturnData for only the one expression result to use as the alarm. For all other metrics and expressions in the same CreateServiceLevelObjective operation, specify ReturnData as false.
    
    Parameters:
    
    returnData - Use this only if you are using a metric math expression for the SLO. Specify true for ReturnData for only the one expression result to use as the alarm. For all other metrics and expressions in the same CreateServiceLevelObjective operation, specify ReturnData as false.
  - getReturnData
```
public Boolean getReturnData()
```
    Use this only if you are using a metric math expression for the SLO. Specify true for ReturnData for only the one expression result to use as the alarm. For all other metrics and expressions in the same CreateServiceLevelObjective operation, specify ReturnData as false.
    
    Returns:
    
    Use this only if you are using a metric math expression for the SLO. Specify true for ReturnData for only the one expression result to use as the alarm. For all other metrics and expressions in the same CreateServiceLevelObjective operation, specify ReturnData as false.
  - withReturnData
```
public MetricDataQuery withReturnData(Boolean returnData)
```
    Use this only if you are using a metric math expression for the SLO. Specify true for ReturnData for only the one expression result to use as the alarm. For all other metrics and expressions in the same CreateServiceLevelObjective operation, specify ReturnData as false.
    
    Parameters:
    
    returnData - Use this only if you are using a metric math expression for the SLO. Specify true for ReturnData for only the one expression result to use as the alarm. For all other metrics and expressions in the same CreateServiceLevelObjective operation, specify ReturnData as false.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isReturnData
```
public Boolean isReturnData()
```
    Use this only if you are using a metric math expression for the SLO. Specify true for ReturnData for only the one expression result to use as the alarm. For all other metrics and expressions in the same CreateServiceLevelObjective operation, specify ReturnData as false.
    
    Returns:
    
    Use this only if you are using a metric math expression for the SLO. Specify true for ReturnData for only the one expression result to use as the alarm. For all other metrics and expressions in the same CreateServiceLevelObjective operation, specify ReturnData as false.
  - setPeriod
```
public void setPeriod(Integer period)
```
    The granularity, in seconds, of the returned data points for this metric. 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 call that includes a StorageResolution of 1 second.
    
    If the StartTime parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned:
    - Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).
    - Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).
    - Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).
    Parameters:
    period - The granularity, in seconds, of the returned data points for this metric. 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 call that includes a StorageResolution of 1 second.
    
    If the StartTime parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned:
    
    Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).
    
    Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).
    
    Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).
  - getPeriod
```
public Integer getPeriod()
```
    The granularity, in seconds, of the returned data points for this metric. 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 call that includes a StorageResolution of 1 second.
    
    If the StartTime parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned:
    - Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).
    - Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).
    - Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).
    Returns:
    The granularity, in seconds, of the returned data points for this metric. 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 call that includes a StorageResolution of 1 second.
    
    If the StartTime parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned:
    
    Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).
    
    Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).
    
    Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).
  - withPeriod
```
public MetricDataQuery withPeriod(Integer period)
```
    The granularity, in seconds, of the returned data points for this metric. 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 call that includes a StorageResolution of 1 second.
    
    If the StartTime parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned:
    - Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).
    - Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).
    - Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).
    Parameters:
    period - The granularity, in seconds, of the returned data points for this metric. 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 call that includes a StorageResolution of 1 second.
    
    If the StartTime parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned:
    
    Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).
    
    Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).
    
    Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAccountId
```
public void setAccountId(String accountId)
```
    The ID of the account where this metric is located. If you are performing this operatiion in a monitoring account, use this to specify which source account to retrieve this metric from.
    
    Parameters:
    
    accountId - The ID of the account where this metric is located. If you are performing this operatiion in a monitoring account, use this to specify which source account to retrieve this metric from.
  - getAccountId
```
public String getAccountId()
```
    The ID of the account where this metric is located. If you are performing this operatiion in a monitoring account, use this to specify which source account to retrieve this metric from.
    
    Returns:
    
    The ID of the account where this metric is located. If you are performing this operatiion in a monitoring account, use this to specify which source account to retrieve this metric from.
  - withAccountId
```
public MetricDataQuery withAccountId(String accountId)
```
    The ID of the account where this metric is located. If you are performing this operatiion in a monitoring account, use this to specify which source account to retrieve this metric from.
    
    Parameters:
    
    accountId - The ID of the account where this metric is located. If you are performing this operatiion in a monitoring account, use this to specify which source account to retrieve this metric from.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.793

Class MetricDataQuery

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MetricDataQuery

Method Detail

setId

getId

withId

setMetricStat

getMetricStat

withMetricStat

setExpression

getExpression

withExpression

setLabel

getLabel

withLabel

setReturnData

getReturnData

withReturnData

isReturnData

setPeriod

getPeriod

withPeriod

setAccountId

getAccountId

withAccountId

toString

equals

hashCode

clone

marshall