software.amazon.awssdk.services.cloudwatch.model

Interface MetricDataQuery.Builder

All Superinterfaces:

CopyableBuilder<MetricDataQuery.Builder,MetricDataQuery>, SdkBuilder<MetricDataQuery.Builder,MetricDataQuery>

Enclosing class:

MetricDataQuery

public static interface MetricDataQuery.Builder
extends CopyableBuilder<MetricDataQuery.Builder,MetricDataQuery>

Method Summary

Modifier and Type	Method and Description
MetricDataQuery.Builder	expression(String expression) The math expression to be performed on the returned data, if this structure is performing a math expression.
MetricDataQuery.Builder	id(String id) A short name used to tie this structure to the results in the response.
MetricDataQuery.Builder	label(String label) A human-readable label for this metric or expression.
default MetricDataQuery.Builder	metricStat(Consumer<MetricStat.Builder> metricStat) The metric to be returned, along with statistics, period, and units.
MetricDataQuery.Builder	metricStat(MetricStat metricStat) The metric to be returned, along with statistics, period, and units.
MetricDataQuery.Builder	returnData(Boolean returnData) Indicates whether to return the time stamps and raw data values of this metric.

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

copy

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

applyMutation, build

Method Detail

id

MetricDataQuery.Builder id(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

metricStat

MetricDataQuery.Builder metricStat(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

metricStat

default MetricDataQuery.Builder metricStat(Consumer<MetricStat.Builder> 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.

This is a convenience that creates an instance of the MetricStat.Builder avoiding the need to create one manually via MetricStat.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to metricStat(MetricStat).

Parameters:

metricStat - a consumer that will call methods on MetricStat.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

metricStat(MetricStat)

expression

MetricDataQuery.Builder expression(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

label

MetricDataQuery.Builder label(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.

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

returnData

MetricDataQuery.Builder returnData(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.