software.amazon.awssdk.services.lightsail.model

Class TestAlarmRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.lightsail.model.LightsailRequest

software.amazon.awssdk.services.lightsail.model.TestAlarmRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<TestAlarmRequest.Builder,TestAlarmRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class TestAlarmRequest
extends LightsailRequest
implements ToCopyableBuilder<TestAlarmRequest.Builder,TestAlarmRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TestAlarmRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	alarmName() The name of the alarm to test.
static TestAlarmRequest.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 TestAlarmRequest.Builder>	serializableBuilderClass()
AlarmState	state() The alarm state to test.
String	stateAsString() The alarm state to test.
TestAlarmRequest.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 to test.

Returns:

The name of the alarm to test.

state

public final AlarmState state()

The alarm state to test.

An alarm has the following possible states that can be tested:

• ALARM - The metric is outside of the defined threshold.

• INSUFFICIENT_DATA - The alarm has just started, the metric is not available, or not enough data is available for the metric to determine the alarm state.

• OK - The metric is within the defined threshold.

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

Returns:

The alarm state to test.

An alarm has the following possible states that can be tested:

• ALARM - The metric is outside of the defined threshold.

• INSUFFICIENT_DATA - The alarm has just started, the metric is not available, or not enough data is available for the metric to determine the alarm state.

• OK - The metric is within the defined threshold.

See Also:

AlarmState

stateAsString

public final String stateAsString()

The alarm state to test.

An alarm has the following possible states that can be tested:

• ALARM - The metric is outside of the defined threshold.

• INSUFFICIENT_DATA - The alarm has just started, the metric is not available, or not enough data is available for the metric to determine the alarm state.

• OK - The metric is within the defined threshold.

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

Returns:

The alarm state to test.

An alarm has the following possible states that can be tested:

• ALARM - The metric is outside of the defined threshold.

• INSUFFICIENT_DATA - The alarm has just started, the metric is not available, or not enough data is available for the metric to determine the alarm state.

• OK - The metric is within the defined threshold.

See Also:

AlarmState

toBuilder

public TestAlarmRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<TestAlarmRequest.Builder,TestAlarmRequest>

Specified by:

toBuilder in class LightsailRequest

builder

public static TestAlarmRequest.Builder builder()

serializableBuilderClass

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