Class SetAlarmStateRequest

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.SetAlarmStateRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<SetAlarmStateRequest.Builder,SetAlarmStateRequest>
@Generated("software.amazon.awssdk:codegen") public final class SetAlarmStateRequest extends CloudWatchRequest implements ToCopyableBuilder<SetAlarmStateRequest.Builder,SetAlarmStateRequest>

  • Method Details

    • alarmName

      public final String alarmName()

      The name of the alarm.

      Returns:
      The name of the alarm.

    • stateValue

      public final StateValue stateValue()

      The value of the state.

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

      Returns:
      The value of the state.
      See Also:

    • stateValueAsString

      public final String stateValueAsString()

      The value of the state.

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

      Returns:
      The value of the state.
      See Also:

    • stateReason

      public final String stateReason()

      The reason that this alarm is set to this specific state, in text format.

      Returns:
      The reason that this alarm is set to this specific state, in text format.

    • stateReasonData

      public final String stateReasonData()

      The reason that this alarm is set to this specific state, in JSON format.

      For SNS or EC2 alarm actions, this is just informational. But for EC2 Auto Scaling or application Auto Scaling alarm actions, the Auto Scaling policy uses the information in this field to take the correct action.

      Returns:
      The reason that this alarm is set to this specific state, in JSON format.

      For SNS or EC2 alarm actions, this is just informational. But for EC2 Auto Scaling or application Auto Scaling alarm actions, the Auto Scaling policy uses the information in this field to take the correct action.

    • toBuilder

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

    • builder

      public static SetAlarmStateRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends SetAlarmStateRequest.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.