Class DescribeAlarmsForMetricRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeAlarmsForMetricRequest.Builder,
DescribeAlarmsForMetricRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
The dimensions associated with the metric.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
The percentile statistic for the metric.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the Dimensions property.final int
hashCode()
final String
The name of the metric.final String
The namespace of the metric.final Integer
period()
The period, in seconds, over which the statistic is applied.static Class
<? extends DescribeAlarmsForMetricRequest.Builder> final Statistic
The statistic for the metric, other than percentiles.final String
The statistic for the metric, other than percentiles.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final StandardUnit
unit()
The unit for the metric.final String
The unit for the metric.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
metricName
The name of the metric.
- Returns:
- The name of the metric.
-
namespace
The namespace of the metric.
- Returns:
- The namespace of the metric.
-
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:
-
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:
-
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
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
The period, in seconds, over which the statistic is applied.
- Returns:
- The period, in seconds, over which the statistic is applied.
-
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:
-
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:
-
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 interfaceToCopyableBuilder<DescribeAlarmsForMetricRequest.Builder,
DescribeAlarmsForMetricRequest> - Specified by:
toBuilder
in classCloudWatchRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-