DescribeAlarmsRequest (AWS Java SDK for Amazon CloudWatch 1.9.5 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.cloudwatch.model.DescribeAlarmsRequest

All Implemented Interfaces:

Serializable
```
public class DescribeAlarmsRequest
extends AmazonWebServiceRequest
implements Serializable
```
Container for the parameters to the DescribeAlarms operation.
Retrieves alarms with the specified names. If no name is specified, all alarms for the user are returned. Alarms can be retrieved by using only a prefix for the alarm name, the alarm state, or a prefix for any action.

See Also:
AmazonCloudWatch.describeAlarms(DescribeAlarmsRequest), Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

DescribeAlarmsRequest()

Constructors
Constructor and Description
`DescribeAlarmsRequest()`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`String`	`getActionPrefix()` The action name prefix.
`String`	`getAlarmNamePrefix()` The alarm name prefix.
`List<String>`	`getAlarmNames()` A list of alarm names to retrieve information for.
`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`	`getStateValue()` The state value to be used in matching alarms.
`int`	`hashCode()`
`void`	`setActionPrefix(String actionPrefix)` The action name prefix.
`void`	`setAlarmNamePrefix(String alarmNamePrefix)` The alarm name prefix.
`void`	`setAlarmNames(Collection<String> alarmNames)` A list of alarm names to retrieve information for.
`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`	`setStateValue(StateValue stateValue)` The state value to be used in matching alarms.
`void`	`setStateValue(String stateValue)` The state value to be used in matching alarms.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`DescribeAlarmsRequest`	`withActionPrefix(String actionPrefix)` The action name prefix.
`DescribeAlarmsRequest`	`withAlarmNamePrefix(String alarmNamePrefix)` The alarm name prefix.
`DescribeAlarmsRequest`	`withAlarmNames(Collection<String> alarmNames)` A list of alarm names to retrieve information for.
`DescribeAlarmsRequest`	`withAlarmNames(String... alarmNames)` A list of alarm names to retrieve information for.
`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`	`withStateValue(StateValue stateValue)` The state value to be used in matching alarms.
`DescribeAlarmsRequest`	`withStateValue(String stateValue)` The state value to be used in matching alarms.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, copyPrivateRequestParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DescribeAlarmsRequest
```
public DescribeAlarmsRequest()
```
- Method Detail
  - getAlarmNames
```
public List<String> getAlarmNames()
```
    A list of alarm names to retrieve information for.
    Constraints:
    Length: 0 - 100
    
    Returns:
    A list of alarm names to retrieve information for.
  - setAlarmNames
```
public void setAlarmNames(Collection<String> alarmNames)
```
    A list of alarm names to retrieve information for.
    Constraints:
    Length: 0 - 100
    
    Parameters:
    alarmNames - A list of alarm names to retrieve information for.
  - withAlarmNames
```
public DescribeAlarmsRequest withAlarmNames(String... alarmNames)
```
    A list of alarm names to retrieve information for.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 0 - 100
    
    Parameters:
    alarmNames - A list of alarm names to retrieve information for.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - withAlarmNames
```
public DescribeAlarmsRequest withAlarmNames(Collection<String> alarmNames)
```
    A list of alarm names to retrieve information for.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 0 - 100
    
    Parameters:
    alarmNames - A list of alarm names to retrieve information for.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getAlarmNamePrefix
```
public String getAlarmNamePrefix()
```
    The alarm name prefix. AlarmNames cannot be specified if this parameter is specified.
    Constraints:
    Length: 1 - 255
    
    Returns:
    The alarm name prefix. AlarmNames cannot be specified if this parameter is specified.
  - setAlarmNamePrefix
```
public void setAlarmNamePrefix(String alarmNamePrefix)
```
    The alarm name prefix. AlarmNames cannot be specified if this parameter is specified.
    Constraints:
    Length: 1 - 255
    
    Parameters:
    alarmNamePrefix - The alarm name prefix. AlarmNames cannot be specified if this parameter is specified.
  - withAlarmNamePrefix
```
public DescribeAlarmsRequest withAlarmNamePrefix(String alarmNamePrefix)
```
    The alarm name prefix. AlarmNames cannot be specified if this parameter is specified.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 255
    
    Parameters:
    alarmNamePrefix - The alarm name prefix. AlarmNames cannot be specified if this parameter is specified.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getStateValue
```
public String getStateValue()
```
    The state value to be used in matching alarms.
    Constraints:
    Allowed Values: OK, ALARM, INSUFFICIENT_DATA
    
    Returns:
    The state value to be used in matching alarms.
    See Also:
    StateValue
  - setStateValue
```
public void setStateValue(String stateValue)
```
    The state value to be used in matching alarms.
    Constraints:
    Allowed Values: OK, ALARM, INSUFFICIENT_DATA
    
    Parameters:
    stateValue - The state value to be used in matching alarms.
    See Also:
    StateValue
  - withStateValue
```
public DescribeAlarmsRequest withStateValue(String stateValue)
```
    The state value to be used in matching alarms.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: OK, ALARM, INSUFFICIENT_DATA
    
    Parameters:
    stateValue - The state value to be used in matching alarms.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
    See Also:
    StateValue
  - setStateValue
```
public void setStateValue(StateValue stateValue)
```
    The state value to be used in matching alarms.
    Constraints:
    Allowed Values: OK, ALARM, INSUFFICIENT_DATA
    
    Parameters:
    stateValue - The state value to be used in matching alarms.
    See Also:
    StateValue
  - withStateValue
```
public DescribeAlarmsRequest withStateValue(StateValue stateValue)
```
    The state value to be used in matching alarms.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: OK, ALARM, INSUFFICIENT_DATA
    
    Parameters:
    stateValue - The state value to be used in matching alarms.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
    See Also:
    StateValue
  - getActionPrefix
```
public String getActionPrefix()
```
    The action name prefix.
    Constraints:
    Length: 1 - 1024
    
    Returns:
    The action name prefix.
  - setActionPrefix
```
public void setActionPrefix(String actionPrefix)
```
    The action name prefix.
    Constraints:
    Length: 1 - 1024
    
    Parameters:
    actionPrefix - The action name prefix.
  - withActionPrefix
```
public DescribeAlarmsRequest withActionPrefix(String actionPrefix)
```
    The action name prefix.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 1024
    
    Parameters:
    actionPrefix - The action name prefix.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getMaxRecords
```
public Integer getMaxRecords()
```
    The maximum number of alarm descriptions to retrieve.
    Constraints:
    Range: 1 - 100
    
    Returns:
    The maximum number of alarm descriptions to retrieve.
  - setMaxRecords
```
public void setMaxRecords(Integer maxRecords)
```
    The maximum number of alarm descriptions to retrieve.
    Constraints:
    Range: 1 - 100
    
    Parameters:
    maxRecords - The maximum number of alarm descriptions to retrieve.
  - withMaxRecords
```
public DescribeAlarmsRequest withMaxRecords(Integer maxRecords)
```
    The maximum number of alarm descriptions to retrieve.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Range: 1 - 100
    
    Parameters:
    maxRecords - The maximum number of alarm descriptions to retrieve.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - 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.
  - 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.
  - withNextToken
```
public DescribeAlarmsRequest withNextToken(String nextToken)
```
    The token returned by a previous call to indicate that there is more data available.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    nextToken - The token returned by a previous call to indicate that there is more data available.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    A string representation of this object.
    See Also:
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Class DescribeAlarmsRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

DescribeAlarmsRequest

Method Detail

getAlarmNames

setAlarmNames

withAlarmNames

withAlarmNames

getAlarmNamePrefix

setAlarmNamePrefix

withAlarmNamePrefix

getStateValue

setStateValue

withStateValue

setStateValue

withStateValue

getActionPrefix

setActionPrefix

withActionPrefix

getMaxRecords

setMaxRecords

withMaxRecords

getNextToken

setNextToken

withNextToken

toString

hashCode

equals