Class DescribeAlarmsForMetricRequest
- 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("software.amazon.awssdk:codegen") public final class DescribeAlarmsForMetricRequest extends CloudWatchRequest implements ToCopyableBuilder<DescribeAlarmsForMetricRequest.Builder,DescribeAlarmsForMetricRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
DescribeAlarmsForMetricRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method 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()
For responses, this returns true if the service returned a value for the Dimensions property.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 final String metricName()
The name of the metric.
- Returns:
- The name of the metric.
-
namespace
public final String namespace()
The namespace of the metric.
- Returns:
- The namespace of the metric.
-
statistic
public final 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 returnStatistic.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatisticAsString()
.- Returns:
- The statistic for the metric, other than percentiles. For percentile statistics, use
ExtendedStatistics
. - See Also:
Statistic
-
statisticAsString
public final 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 returnStatistic.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatisticAsString()
.- Returns:
- The statistic for the metric, other than percentiles. For percentile statistics, use
ExtendedStatistics
. - See Also:
Statistic
-
extendedStatistic
public final 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 final boolean hasDimensions()
For responses, this returns true if the service returned a value for the Dimensions property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
dimensions
public final 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.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasDimensions()
method.- 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 final 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 final 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 returnStandardUnit.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromunitAsString()
.- Returns:
- The unit for the metric.
- See Also:
StandardUnit
-
unitAsString
public final 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 returnStandardUnit.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromunitAsString()
.- Returns:
- The unit for the metric.
- See Also:
StandardUnit
-
toBuilder
public DescribeAlarmsForMetricRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<DescribeAlarmsForMetricRequest.Builder,DescribeAlarmsForMetricRequest>
- Specified by:
toBuilder
in classCloudWatchRequest
-
builder
public static DescribeAlarmsForMetricRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends DescribeAlarmsForMetricRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
toString
public final 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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkRequest
-
-