Class DescribeAlarmsRequest
- java.lang.Object
-
- com.amazonaws.AmazonWebServiceRequest
-
- com.amazonaws.services.cloudwatch.model.DescribeAlarmsRequest
-
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
public class DescribeAlarmsRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
-
Constructor Summary
Constructors Constructor Description DescribeAlarmsRequest()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DescribeAlarmsRequest
clone()
Creates a shallow clone of this request.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(String... alarmNames)
A list of alarm names to retrieve information for.DescribeAlarmsRequest
withAlarmNames(Collection<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, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
-
-
-
Method Detail
-
getAlarmNames
public List<String> getAlarmNames()
A list of alarm names to retrieve information for.
- 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.
- 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.
NOTE: This method appends the values to the existing list (if any). Use
setAlarmNames(java.util.Collection)
orwithAlarmNames(java.util.Collection)
if you want to override the existing values.- Parameters:
alarmNames
- A list of alarm names to retrieve information for.- Returns:
- Returns a reference to this 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.
- Parameters:
alarmNames
- A list of alarm names to retrieve information for.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setAlarmNamePrefix
public void setAlarmNamePrefix(String alarmNamePrefix)
The alarm name prefix.
AlarmNames
cannot be specified if this parameter is specified.- Parameters:
alarmNamePrefix
- The alarm name prefix.AlarmNames
cannot be specified if this parameter is specified.
-
getAlarmNamePrefix
public String getAlarmNamePrefix()
The alarm name prefix.
AlarmNames
cannot be specified if this parameter is specified.- Returns:
- 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.- Parameters:
alarmNamePrefix
- The alarm name prefix.AlarmNames
cannot be specified if this parameter is specified.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setStateValue
public void setStateValue(String stateValue)
The state value to be used in matching alarms.
- Parameters:
stateValue
- The state value to be used in matching alarms.- See Also:
StateValue
-
getStateValue
public String getStateValue()
The state value to be used in matching alarms.
- Returns:
- 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.
- Parameters:
stateValue
- The state value to be used in matching alarms.- Returns:
- Returns a reference to this 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.
- 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.
- Parameters:
stateValue
- The state value to be used in matching alarms.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
StateValue
-
setActionPrefix
public void setActionPrefix(String actionPrefix)
The action name prefix.
- Parameters:
actionPrefix
- The action name prefix.
-
getActionPrefix
public String getActionPrefix()
The action name prefix.
- Returns:
- The action name prefix.
-
withActionPrefix
public DescribeAlarmsRequest withActionPrefix(String actionPrefix)
The action name prefix.
- Parameters:
actionPrefix
- The action name prefix.- 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; useful for testing and debugging.- Overrides:
toString
in classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public DescribeAlarmsRequest clone()
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
Object.clone()
-
-