com.amazonaws.services.cloudwatch.model

Class DescribeAlarmsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cloudwatch.model.DescribeAlarmsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribeAlarmsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeAlarmsRequest()

Method Summary

Modifier and Type	Method and Description
DescribeAlarmsRequest	clone()
boolean	equals(Object obj)
String	getActionPrefix() Use this parameter to filter the results of the operation to only those alarms that use a certain alarm action.
String	getAlarmNamePrefix() An alarm name prefix.
List<String>	getAlarmNames() The names of the alarms to retrieve information about.
List<String>	getAlarmTypes() Use this parameter to specify whether you want the operation to return metric alarms or composite alarms.
String	getChildrenOfAlarmName() 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.
Integer	getMaxRecords() The maximum number of alarm descriptions to retrieve.
String	getNextToken() The token returned by a previous call to indicate that there is more data available.
String	getParentsOfAlarmName() 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.
String	getStateValue() Specify this parameter to receive information only about alarms that are currently in the state that you specify.
int	hashCode()
void	setActionPrefix(String actionPrefix) Use this parameter to filter the results of the operation to only those alarms that use a certain alarm action.
void	setAlarmNamePrefix(String alarmNamePrefix) An alarm name prefix.
void	setAlarmNames(Collection<String> alarmNames) The names of the alarms to retrieve information about.
void	setAlarmTypes(Collection<String> alarmTypes) Use this parameter to specify whether you want the operation to return metric alarms or composite alarms.
void	setChildrenOfAlarmName(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.
void	setMaxRecords(Integer maxRecords) The maximum number of alarm descriptions to retrieve.
void	setNextToken(String nextToken) The token returned by a previous call to indicate that there is more data available.
void	setParentsOfAlarmName(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.
void	setStateValue(StateValue stateValue) Specify this parameter to receive information only about alarms that are currently in the state that you specify.
void	setStateValue(String stateValue) Specify this parameter to receive information only about alarms that are currently in the state that you specify.
String	toString() Returns a string representation of this object.
DescribeAlarmsRequest	withActionPrefix(String actionPrefix) Use this parameter to filter the results of the operation to only those alarms that use a certain alarm action.
DescribeAlarmsRequest	withAlarmNamePrefix(String alarmNamePrefix) An alarm name prefix.
DescribeAlarmsRequest	withAlarmNames(Collection<String> alarmNames) The names of the alarms to retrieve information about.
DescribeAlarmsRequest	withAlarmNames(String... alarmNames) The names of the alarms to retrieve information about.
DescribeAlarmsRequest	withAlarmTypes(AlarmType... alarmTypes) Use this parameter to specify whether you want the operation to return metric alarms or composite alarms.
DescribeAlarmsRequest	withAlarmTypes(Collection<String> alarmTypes) Use this parameter to specify whether you want the operation to return metric alarms or composite alarms.
DescribeAlarmsRequest	withAlarmTypes(String... alarmTypes) Use this parameter to specify whether you want the operation to return metric alarms or composite alarms.
DescribeAlarmsRequest	withChildrenOfAlarmName(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.
DescribeAlarmsRequest	withMaxRecords(Integer maxRecords) The maximum number of alarm descriptions to retrieve.
DescribeAlarmsRequest	withNextToken(String nextToken) The token returned by a previous call to indicate that there is more data available.
DescribeAlarmsRequest	withParentsOfAlarmName(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.
DescribeAlarmsRequest	withStateValue(StateValue stateValue) Specify this parameter to receive information only about alarms that are currently in the state that you specify.
DescribeAlarmsRequest	withStateValue(String stateValue) Specify this parameter to receive information only about alarms that are currently in the state that you specify.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeAlarmsRequest

public DescribeAlarmsRequest()

Method Detail

getAlarmNames

public List<String> getAlarmNames()

The names of the alarms to retrieve information about.

Returns:

The names of the alarms to retrieve information about.

setAlarmNames

public void setAlarmNames(Collection<String> alarmNames)

The names of the alarms to retrieve information about.

Parameters:

alarmNames - The names of the alarms to retrieve information about.

withAlarmNames

public DescribeAlarmsRequest withAlarmNames(String... alarmNames)

The names of the alarms to retrieve information about.

NOTE: This method appends the values to the existing list (if any). Use setAlarmNames(java.util.Collection) or withAlarmNames(java.util.Collection) if you want to override the existing values.

Parameters:

alarmNames - The names of the alarms to retrieve information about.

Returns:

Returns a reference to this object so that method calls can be chained together.

withAlarmNames

public DescribeAlarmsRequest withAlarmNames(Collection<String> alarmNames)

The names of the alarms to retrieve information about.

Parameters:

alarmNames - The names of the alarms to retrieve information about.

Returns:

Returns a reference to this object so that method calls can be chained together.

setAlarmNamePrefix

public void setAlarmNamePrefix(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.

Parameters:

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.

getAlarmNamePrefix

public String getAlarmNamePrefix()

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.

withAlarmNamePrefix

public DescribeAlarmsRequest withAlarmNamePrefix(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

getAlarmTypes

public List<String> getAlarmTypes()

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.

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.

See Also:

AlarmType

setAlarmTypes

public void setAlarmTypes(Collection<String> 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.

Parameters:

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.

See Also:

AlarmType

withAlarmTypes

public DescribeAlarmsRequest withAlarmTypes(String... 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.

NOTE: This method appends the values to the existing list (if any). Use setAlarmTypes(java.util.Collection) or withAlarmTypes(java.util.Collection) if you want to override the existing values.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AlarmType

withAlarmTypes

public DescribeAlarmsRequest withAlarmTypes(Collection<String> 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AlarmType

withAlarmTypes

public DescribeAlarmsRequest withAlarmTypes(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AlarmType

setChildrenOfAlarmName

public void setChildrenOfAlarmName(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 will 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.

Parameters:

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

getChildrenOfAlarmName

public String getChildrenOfAlarmName()

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

withChildrenOfAlarmName

public DescribeAlarmsRequest withChildrenOfAlarmName(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 will 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.

Parameters:

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 will 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:

Returns a reference to this object so that method calls can be chained together.

setParentsOfAlarmName

public void setParentsOfAlarmName(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 will 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.

Parameters:

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

getParentsOfAlarmName

public String getParentsOfAlarmName()

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

withParentsOfAlarmName

public DescribeAlarmsRequest withParentsOfAlarmName(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 will 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.

Parameters:

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 will 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:

Returns a reference to this object so that method calls can be chained together.

setStateValue

public void setStateValue(String stateValue)

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

Parameters:

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

See Also:

StateValue

getStateValue

public String getStateValue()

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

Returns:

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

See Also:

StateValue

withStateValue

public DescribeAlarmsRequest withStateValue(String stateValue)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

StateValue

setStateValue

public void setStateValue(StateValue stateValue)

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

Parameters:

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

See Also:

StateValue

withStateValue

public DescribeAlarmsRequest withStateValue(StateValue stateValue)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

StateValue

setActionPrefix

public void setActionPrefix(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.

Parameters:

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.

getActionPrefix

public String getActionPrefix()

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.

withActionPrefix

public DescribeAlarmsRequest withActionPrefix(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setMaxRecords

public void setMaxRecords(Integer maxRecords)

The maximum number of alarm descriptions to retrieve.

Parameters:

maxRecords - The maximum number of alarm descriptions to retrieve.

getMaxRecords

public Integer getMaxRecords()

The maximum number of alarm descriptions to retrieve.

Returns:

The maximum number of alarm descriptions to retrieve.

withMaxRecords

public DescribeAlarmsRequest withMaxRecords(Integer maxRecords)

The maximum number of alarm descriptions to retrieve.

Parameters:

maxRecords - The maximum number of alarm descriptions to retrieve.

Returns:

Returns a reference to this object so that method calls can be chained together.

setNextToken

public void setNextToken(String nextToken)

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

Parameters:

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

getNextToken

public String getNextToken()

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.

withNextToken

public DescribeAlarmsRequest withNextToken(String nextToken)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public DescribeAlarmsRequest clone()

Overrides:

clone in class AmazonWebServiceRequest