Class GetAlarmMuteRuleResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.cloudwatch.model.CloudWatchResponse
software.amazon.awssdk.services.cloudwatch.model.GetAlarmMuteRuleResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetAlarmMuteRuleResponse.Builder,GetAlarmMuteRuleResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetAlarmMuteRuleResponse extends CloudWatchResponse implements ToCopyableBuilder<GetAlarmMuteRuleResponse.Builder,GetAlarmMuteRuleResponse>

  • Method Details

    • name

      public final String name()

      The name of the alarm mute rule.

      Returns:
      The name of the alarm mute rule.

    • alarmMuteRuleArn

      public final String alarmMuteRuleArn()

      The Amazon Resource Name (ARN) of the alarm mute rule.

      Returns:
      The Amazon Resource Name (ARN) of the alarm mute rule.

    • description

      public final String description()

      The description of the alarm mute rule.

      Returns:
      The description of the alarm mute rule.

    • rule

      public final Rule rule()

      The configuration that defines when and how long alarms are muted.

      Returns:
      The configuration that defines when and how long alarms are muted.

    • muteTargets

      public final MuteTargets muteTargets()

      Specifies which alarms this rule applies to.

      Returns:
      Specifies which alarms this rule applies to.

    • startDate

      public final Instant startDate()

      The date and time when the mute rule becomes active. If not set, the rule is active immediately.

      Returns:
      The date and time when the mute rule becomes active. If not set, the rule is active immediately.

    • expireDate

      public final Instant expireDate()

      The date and time when the mute rule expires and is no longer evaluated.

      Returns:
      The date and time when the mute rule expires and is no longer evaluated.

    • status

      public final AlarmMuteRuleStatus status()

      The current status of the alarm mute rule. Valid values are SCHEDULED, ACTIVE, or EXPIRED.

      If the service returns an enum value that is not available in the current SDK version, status will return AlarmMuteRuleStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The current status of the alarm mute rule. Valid values are SCHEDULED, ACTIVE, or EXPIRED.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the alarm mute rule. Valid values are SCHEDULED, ACTIVE, or EXPIRED.

      If the service returns an enum value that is not available in the current SDK version, status will return AlarmMuteRuleStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The current status of the alarm mute rule. Valid values are SCHEDULED, ACTIVE, or EXPIRED.
      See Also:

    • lastUpdatedTimestamp

      public final Instant lastUpdatedTimestamp()

      The date and time when the mute rule was last updated.

      Returns:
      The date and time when the mute rule was last updated.

    • muteType

      public final String muteType()

      Indicates whether the mute rule is one-time or recurring. Valid values are ONE_TIME or RECURRING.

      Returns:
      Indicates whether the mute rule is one-time or recurring. Valid values are ONE_TIME or RECURRING.

    • toBuilder

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

    • builder

      public static GetAlarmMuteRuleResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.