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>

  • Method Details

    • 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 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:

    • 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 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:

    • 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 the isEmpty() 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 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:

    • 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 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:

    • toBuilder

      public DescribeAlarmsForMetricRequest.Builder 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 interface ToCopyableBuilder<DescribeAlarmsForMetricRequest.Builder,DescribeAlarmsForMetricRequest>
      Specified by:
      toBuilder in class CloudWatchRequest
      Returns:
      a builder for type T

    • builder

      public static DescribeAlarmsForMetricRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DescribeAlarmsForMetricRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.