Package software.amazon.awssdk.services.cloudwatch.model

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>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SetAlarmStateRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	alarmName()	The name of the alarm.
static SetAlarmStateRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends SetAlarmStateRequest.Builder>	serializableBuilderClass()
String	stateReason()	The reason that this alarm is set to this specific state, in text format.
String	stateReasonData()	The reason that this alarm is set to this specific state, in JSON format.
StateValue	stateValue()	The value of the state.
String	stateValueAsString()	The value of the state.
SetAlarmStateRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

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:

StateValue

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:

StateValue

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()

Specified by:

toBuilder in interface ToCopyableBuilder<SetAlarmStateRequest.Builder,SetAlarmStateRequest>

Specified by:

toBuilder in class CloudWatchRequest

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo