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

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

Returns:

The names of the alarms to retrieve information about.

alarmNamePrefix

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

Returns:

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.

alarmTypes

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

Returns:

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.

hasAlarmTypes

public 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). For responses returned by the SDK, the sender is the AWS service.

alarmTypesAsStrings

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

Returns:

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.

childrenOfAlarmName

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

Returns:

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.

parentsOfAlarmName

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

Returns:

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.

stateValue

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

Returns:

Specify this parameter to receive information only about alarms that are currently in the state that you specify.

See Also:

StateValue

stateValueAsString

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

Returns:

Specify this parameter to receive information only about alarms that are currently in the state that you specify.

See Also:

StateValue

actionPrefix

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

Returns:

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.

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