@Generated(value="software.amazon.awssdk:codegen") public final class DescribeAlarmsRequest extends CloudWatchRequest implements ToCopyableBuilder<DescribeAlarmsRequest.Builder,DescribeAlarmsRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
DescribeAlarmsRequest.Builder |
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() |
overrideConfiguration
copy
public List<String> alarmNames()
The names of the alarms.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public String alarmNamePrefix()
The alarm name prefix. If this parameter is specified, you cannot specify AlarmNames
.
AlarmNames
.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()
.
StateValue
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()
.
StateValue
public String actionPrefix()
The action name prefix.
public Integer maxRecords()
The maximum number of alarm descriptions to retrieve.
public String nextToken()
The token returned by a previous call to indicate that there is more data available.
public DescribeAlarmsRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<DescribeAlarmsRequest.Builder,DescribeAlarmsRequest>
toBuilder
in class CloudWatchRequest
public static DescribeAlarmsRequest.Builder builder()
public static Class<? extends DescribeAlarmsRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
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.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.