software.amazon.awssdk.services.cloudwatch.model

Class DescribeAlarmsRequest

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.DescribeAlarmsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeAlarmsRequest.Builder,DescribeAlarmsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeAlarmsRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	actionPrefix() The action name prefix.
String	alarmNamePrefix() The alarm name prefix.
List<String>	alarmNames() The names of the alarms.
static DescribeAlarmsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAlarmNames() Returns true if the AlarmNames property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
Integer	maxRecords() The maximum number of alarm descriptions to retrieve.
String	nextToken() The token returned by a previous call to indicate that there is more data available.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeAlarmsRequest.Builder>	serializableBuilderClass()
StateValue	stateValue() The state value to be used in matching alarms.
String	stateValueAsString() The state value to be used in matching alarms.
DescribeAlarmsRequest.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

hasAlarmNames

public boolean hasAlarmNames()

Returns true if the AlarmNames property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

alarmNames

public List<String> alarmNames()

The names of the alarms.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasAlarmNames() to see if a value was sent in this field.

Returns:

The names of the alarms.

alarmNamePrefix

public String alarmNamePrefix()

The alarm name prefix. If this parameter is specified, you cannot specify AlarmNames.

Returns:

The alarm name prefix. If this parameter is specified, you cannot specify AlarmNames.

stateValue

public StateValue stateValue()

The state value to be used in matching alarms.

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 state value to be used in matching alarms.

See Also:

StateValue

stateValueAsString

public String stateValueAsString()

The state value to be used in matching alarms.

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 state value to be used in matching alarms.

See Also:

StateValue

actionPrefix

public String actionPrefix()

The action name prefix.

Returns:

The action name prefix.

maxRecords

public Integer maxRecords()

The maximum number of alarm descriptions to retrieve.

Returns:

The maximum number of alarm descriptions to retrieve.

nextToken

public String nextToken()

The token returned by a previous call to indicate that there is more data available.

Returns:

The token returned by a previous call to indicate that there is more data available.

toBuilder

public DescribeAlarmsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeAlarmsRequest.Builder,DescribeAlarmsRequest>

Specified by:

toBuilder in class CloudWatchRequest

builder

public static DescribeAlarmsRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo