@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()
Use this parameter to filter the results of the operation to only those alarms that use a certain alarm action.
|
String |
alarmNamePrefix()
An alarm name prefix.
|
List<String> |
alarmNames()
The names of the alarms to retrieve information about.
|
List<AlarmType> |
alarmTypes()
Use this parameter to specify whether you want the operation to return metric alarms or composite alarms.
|
List<String> |
alarmTypesAsStrings()
Use this parameter to specify whether you want the operation to return metric alarms or composite alarms.
|
static DescribeAlarmsRequest.Builder |
builder() |
String |
childrenOfAlarmName()
If you use this parameter and specify the name of a composite alarm, the operation returns information about the
"children" alarms of the alarm you specify.
|
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).
|
boolean |
hasAlarmTypes()
Returns true if the AlarmTypes 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.
|
String |
parentsOfAlarmName()
If you use this parameter and specify the name of a metric or composite alarm, the operation returns information
about the "parent" alarms of the alarm you specify.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends DescribeAlarmsRequest.Builder> |
serializableBuilderClass() |
StateValue |
stateValue()
Specify this parameter to receive information only about alarms that are currently in the state that you specify.
|
String |
stateValueAsString()
Specify this parameter to receive information only about alarms that are currently in the state that you specify.
|
DescribeAlarmsRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
overrideConfiguration
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public final boolean hasAlarmNames()
public final List<String> alarmNames()
The names of the alarms to retrieve information about.
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.
public final String alarmNamePrefix()
An alarm name prefix. If you specify this parameter, you receive information about all alarms that have names that start with this prefix.
If this parameter is specified, you cannot specify AlarmNames
.
If this parameter is specified, you cannot specify AlarmNames
.
public final List<AlarmType> alarmTypes()
Use this parameter to specify whether you want the operation to return metric alarms or composite alarms. If you omit this parameter, only metric alarms are returned.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasAlarmTypes()
to see if a value was sent in this field.
public final boolean hasAlarmTypes()
public final List<String> alarmTypesAsStrings()
Use this parameter to specify whether you want the operation to return metric alarms or composite alarms. If you omit this parameter, only metric alarms are returned.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasAlarmTypes()
to see if a value was sent in this field.
public final String childrenOfAlarmName()
If you use this parameter and specify the name of a composite alarm, the operation returns information about the
"children" alarms of the alarm you specify. These are the metric alarms and composite alarms referenced in the
AlarmRule
field of the composite alarm that you specify in ChildrenOfAlarmName
.
Information about the composite alarm that you name in ChildrenOfAlarmName
is not returned.
If you specify ChildrenOfAlarmName
, you cannot specify any other parameters in the request except
for MaxRecords
and NextToken
. If you do so, you receive a validation error.
Only the Alarm Name
, ARN
, StateValue
(OK/ALARM/INSUFFICIENT_DATA), and
StateUpdatedTimestamp
information are returned by this operation when you use this parameter. To get
complete information about these alarms, perform another DescribeAlarms
operation and specify the
parent alarm names in the AlarmNames
parameter.
AlarmRule
field of the composite alarm that you specify in
ChildrenOfAlarmName
. Information about the composite alarm that you name in
ChildrenOfAlarmName
is not returned.
If you specify ChildrenOfAlarmName
, you cannot specify any other parameters in the request
except for MaxRecords
and NextToken
. If you do so, you receive a validation
error.
Only the Alarm Name
, ARN
, StateValue
(OK/ALARM/INSUFFICIENT_DATA),
and StateUpdatedTimestamp
information are returned by this operation when you use this
parameter. To get complete information about these alarms, perform another DescribeAlarms
operation and specify the parent alarm names in the AlarmNames
parameter.
public final String parentsOfAlarmName()
If you use this parameter and specify the name of a metric or composite alarm, the operation returns information
about the "parent" alarms of the alarm you specify. These are the composite alarms that have
AlarmRule
parameters that reference the alarm named in ParentsOfAlarmName
. Information
about the alarm that you specify in ParentsOfAlarmName
is not returned.
If you specify ParentsOfAlarmName
, you cannot specify any other parameters in the request except for
MaxRecords
and NextToken
. If you do so, you receive a validation error.
Only the Alarm Name and ARN are returned by this operation when you use this parameter. To get complete
information about these alarms, perform another DescribeAlarms
operation and specify the parent
alarm names in the AlarmNames
parameter.
AlarmRule
parameters that reference the alarm named in ParentsOfAlarmName
.
Information about the alarm that you specify in ParentsOfAlarmName
is not returned.
If you specify ParentsOfAlarmName
, you cannot specify any other parameters in the request
except for MaxRecords
and NextToken
. If you do so, you receive a validation
error.
Only the Alarm Name and ARN are returned by this operation when you use this parameter. To get complete
information about these alarms, perform another DescribeAlarms
operation and specify the
parent alarm names in the AlarmNames
parameter.
public final StateValue stateValue()
Specify this parameter to receive information only about alarms that are currently in the state that you specify.
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 final String stateValueAsString()
Specify this parameter to receive information only about alarms that are currently in the state that you specify.
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 final String actionPrefix()
Use this parameter to filter the results of the operation to only those alarms that use a certain alarm action. For example, you could specify the ARN of an SNS topic to find all alarms that send notifications to that topic.
public final Integer maxRecords()
The maximum number of alarm descriptions to retrieve.
public final String nextToken()
The token returned by a previous call to indicate that there is more data available.
public DescribeAlarmsRequest.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<DescribeAlarmsRequest.Builder,DescribeAlarmsRequest>
toBuilder
in class CloudWatchRequest
public static DescribeAlarmsRequest.Builder builder()
public static Class<? extends DescribeAlarmsRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField
in class SdkRequest
Copyright © 2021. All rights reserved.