Package software.amazon.awssdk.services.cloudwatch.model

Interface DescribeAlarmsForMetricRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CloudWatchRequest.Builder, CopyableBuilder<DescribeAlarmsForMetricRequest.Builder,DescribeAlarmsForMetricRequest>, SdkBuilder<DescribeAlarmsForMetricRequest.Builder,DescribeAlarmsForMetricRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

DescribeAlarmsForMetricRequest

public static interface DescribeAlarmsForMetricRequest.Builder
extends CloudWatchRequest.Builder, SdkPojo, CopyableBuilder<DescribeAlarmsForMetricRequest.Builder,DescribeAlarmsForMetricRequest>

Method Summary

Modifier and Type	Method	Description
DescribeAlarmsForMetricRequest.Builder	dimensions(Collection<Dimension> dimensions)	The dimensions associated with the metric.
DescribeAlarmsForMetricRequest.Builder	dimensions(Consumer<Dimension.Builder>... dimensions)	The dimensions associated with the metric.
DescribeAlarmsForMetricRequest.Builder	dimensions(Dimension... dimensions)	The dimensions associated with the metric.
DescribeAlarmsForMetricRequest.Builder	extendedStatistic(String extendedStatistic)	The percentile statistic for the metric.
DescribeAlarmsForMetricRequest.Builder	metricName(String metricName)	The name of the metric.
DescribeAlarmsForMetricRequest.Builder	namespace(String namespace)	The namespace of the metric.
DescribeAlarmsForMetricRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
DescribeAlarmsForMetricRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
DescribeAlarmsForMetricRequest.Builder	period(Integer period)	The period, in seconds, over which the statistic is applied.
DescribeAlarmsForMetricRequest.Builder	statistic(String statistic)	The statistic for the metric, other than percentiles.
DescribeAlarmsForMetricRequest.Builder	statistic(Statistic statistic)	The statistic for the metric, other than percentiles.
DescribeAlarmsForMetricRequest.Builder	unit(String unit)	The unit for the metric.
DescribeAlarmsForMetricRequest.Builder	unit(StandardUnit unit)	The unit for the metric.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.services.cloudwatch.model.CloudWatchRequest.Builder

build

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Method Details

metricName

DescribeAlarmsForMetricRequest.Builder metricName(String metricName)

The name of the metric.

Parameters:

metricName - The name of the metric.

Returns:

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

namespace

DescribeAlarmsForMetricRequest.Builder namespace(String namespace)

The namespace of the metric.

Parameters:

namespace - The namespace of the metric.

Returns:

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

statistic

DescribeAlarmsForMetricRequest.Builder statistic(String statistic)

The statistic for the metric, other than percentiles. For percentile statistics, use ExtendedStatistics.

Parameters:

statistic - The statistic for the metric, other than percentiles. For percentile statistics, use ExtendedStatistics.

Returns:

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

See Also:

• Statistic
• Statistic

statistic

DescribeAlarmsForMetricRequest.Builder statistic(Statistic statistic)

The statistic for the metric, other than percentiles. For percentile statistics, use ExtendedStatistics.

Parameters:

statistic - The statistic for the metric, other than percentiles. For percentile statistics, use ExtendedStatistics.

Returns:

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

See Also:

• Statistic
• Statistic

extendedStatistic

DescribeAlarmsForMetricRequest.Builder extendedStatistic(String extendedStatistic)

The percentile statistic for the metric. Specify a value between p0.0 and p100.

Parameters:

extendedStatistic - The percentile statistic for the metric. Specify a value between p0.0 and p100.

Returns:

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

dimensions

DescribeAlarmsForMetricRequest.Builder dimensions(Collection<Dimension> dimensions)

The dimensions associated with the metric. If the metric has any associated dimensions, you must specify them in order for the call to succeed.

Parameters:

dimensions - The dimensions associated with the metric. If the metric has any associated dimensions, you must specify them in order for the call to succeed.

Returns:

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

dimensions

DescribeAlarmsForMetricRequest.Builder dimensions(Dimension... dimensions)

The dimensions associated with the metric. If the metric has any associated dimensions, you must specify them in order for the call to succeed.

Parameters:

dimensions - The dimensions associated with the metric. If the metric has any associated dimensions, you must specify them in order for the call to succeed.

Returns:

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

dimensions

DescribeAlarmsForMetricRequest.Builder dimensions(Consumer<Dimension.Builder>... dimensions)

The dimensions associated with the metric. If the metric has any associated dimensions, you must specify them in order for the call to succeed.

This is a convenience method that creates an instance of the Dimension.Builder avoiding the need to create one manually via Dimension.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to dimensions(List<Dimension>).

Parameters:

dimensions - a consumer that will call methods on Dimension.Builder

Returns:

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

See Also:

• dimensions(java.util.Collection<Dimension>)

period

DescribeAlarmsForMetricRequest.Builder period(Integer period)

The period, in seconds, over which the statistic is applied.

Parameters:

period - The period, in seconds, over which the statistic is applied.

Returns:

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

unit

DescribeAlarmsForMetricRequest.Builder unit(String unit)

The unit for the metric.

Parameters:

unit - The unit for the metric.

Returns:

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

See Also:

• StandardUnit
• StandardUnit

unit

DescribeAlarmsForMetricRequest.Builder unit(StandardUnit unit)

The unit for the metric.

Parameters:

unit - The unit for the metric.

Returns:

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

See Also:

• StandardUnit
• StandardUnit

overrideConfiguration

DescribeAlarmsForMetricRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

DescribeAlarmsForMetricRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.