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:

ToCopyableBuilder<DescribeAlarmsRequest.Builder,DescribeAlarmsRequest>

@Generated(value="software.amazon.awssdk:codegen")
public 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)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
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.
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() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

requestOverrideConfig

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

alarmNames

public List<String> alarmNames()

The names of the alarms.

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

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

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

Specified by:

toBuilder in class CloudWatchRequest

Returns:

a builder for type T

builder

public static DescribeAlarmsRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <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