software.amazon.awssdk.services.cloudwatch.model

Class MetricDataQuery

java.lang.Object

software.amazon.awssdk.services.cloudwatch.model.MetricDataQuery

All Implemented Interfaces:

ToCopyableBuilder<MetricDataQuery.Builder,MetricDataQuery>

@Generated(value="software.amazon.awssdk:codegen")
public final class MetricDataQuery
extends Object
implements ToCopyableBuilder<MetricDataQuery.Builder,MetricDataQuery>

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MetricDataQuery.Builder

Method Summary

Modifier and Type	Method and Description
static MetricDataQuery.Builder	builder()
boolean	equals(Object obj)
String	expression() The math expression to be performed on the returned data, if this structure is performing a math expression.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	id() A short name used to tie this structure to the results in the response.
String	label() A human-readable label for this metric or expression.
MetricStat	metricStat() The metric to be returned, along with statistics, period, and units.
Boolean	returnData() Indicates whether to return the time stamps and raw data values of this metric.
static Class<? extends MetricDataQuery.Builder>	serializableBuilderClass()
MetricDataQuery.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

id

public 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.

Returns:

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.

metricStat

public 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.

Returns:

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.

expression

public 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.

Returns:

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.

label

public 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.

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.

returnData

public 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.

Returns:

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.

toBuilder

public MetricDataQuery.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<MetricDataQuery.Builder,MetricDataQuery>

Returns:

a builder for type T

builder

public static MetricDataQuery.Builder builder()

serializableBuilderClass

public static Class<? extends MetricDataQuery.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)