DescribeAlarmsForMetricRequest (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.cloudwatch.model.CloudWatchRequest
    - - software.amazon.awssdk.services.cloudwatch.model.DescribeAlarmsForMetricRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<DescribeAlarmsForMetricRequest.Builder,DescribeAlarmsForMetricRequest>

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DescribeAlarmsForMetricRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`DescribeAlarmsForMetricRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static DescribeAlarmsForMetricRequest.Builder`	`builder()`
`List<Dimension>`	`dimensions()` The dimensions associated with the metric.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`extendedStatistic()` The percentile statistic for the metric.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasDimensions()` Returns true if the Dimensions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`String`	`metricName()` The name of the metric.
`String`	`namespace()` The namespace of the metric.
`Integer`	`period()` The period, in seconds, over which the statistic is applied.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DescribeAlarmsForMetricRequest.Builder>`	`serializableBuilderClass()`
`Statistic`	`statistic()` The statistic for the metric, other than percentiles.
`String`	`statisticAsString()` The statistic for the metric, other than percentiles.
`DescribeAlarmsForMetricRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`StandardUnit`	`unit()` The unit for the metric.
`String`	`unitAsString()` The unit for the metric.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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

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

- Method Detail
  - metricName
```
public String metricName()
```
    The name of the metric.
    
    Returns:
    
    The name of the metric.
  - namespace
```
public String namespace()
```
    The namespace of the metric.
    
    Returns:
    
    The namespace of the metric.
  - statistic
```
public Statistic statistic()
```
    The statistic for the metric, other than percentiles. For percentile statistics, use ExtendedStatistics.
    
    If the service returns an enum value that is not available in the current SDK version, statistic will return Statistic.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statisticAsString().
    
    Returns:
    
    The statistic for the metric, other than percentiles. For percentile statistics, use ExtendedStatistics.
    
    See Also:
    
    Statistic
  - statisticAsString
```
public String statisticAsString()
```
    The statistic for the metric, other than percentiles. For percentile statistics, use ExtendedStatistics.
    
    If the service returns an enum value that is not available in the current SDK version, statistic will return Statistic.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statisticAsString().
    
    Returns:
    
    The statistic for the metric, other than percentiles. For percentile statistics, use ExtendedStatistics.
    
    See Also:
    
    Statistic
  - extendedStatistic
```
public String extendedStatistic()
```
    The percentile statistic for the metric. Specify a value between p0.0 and p100.
    
    Returns:
    
    The percentile statistic for the metric. Specify a value between p0.0 and p100.
  - hasDimensions
```
public boolean hasDimensions()
```
    Returns true if the Dimensions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - dimensions
```
public List<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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasDimensions() to see if a value was sent in this field.
    
    Returns:
    
    The dimensions associated with the metric. If the metric has any associated dimensions, you must specify them in order for the call to succeed.
  - period
```
public Integer period()
```
    The period, in seconds, over which the statistic is applied.
    
    Returns:
    
    The period, in seconds, over which the statistic is applied.
  - unit
```
public StandardUnit unit()
```
    The unit for the metric.
    
    If the service returns an enum value that is not available in the current SDK version, unit will return StandardUnit.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from unitAsString().
    
    Returns:
    
    The unit for the metric.
    
    See Also:
    
    StandardUnit
  - unitAsString
```
public String unitAsString()
```
    The unit for the metric.
    
    If the service returns an enum value that is not available in the current SDK version, unit will return StandardUnit.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from unitAsString().
    
    Returns:
    
    The unit for the metric.
    
    See Also:
    
    StandardUnit
  - toBuilder
```
public DescribeAlarmsForMetricRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribeAlarmsForMetricRequest.Builder,DescribeAlarmsForMetricRequest>
    
    Specified by:
    
    toBuilder in class CloudWatchRequest
  - builder
```
public static DescribeAlarmsForMetricRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DescribeAlarmsForMetricRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class DescribeAlarmsForMetricRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

metricName

namespace

statistic

statisticAsString

extendedStatistic

hasDimensions

dimensions

period

unit

unitAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields