Class DescribeAlarmsRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
Creates a shallow clone of this request.boolean
The action name prefix.The alarm name prefix.A list of alarm names to retrieve information for.The maximum number of alarm descriptions to retrieve.The token returned by a previous call to indicate that there is more data available.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.toString()
Returns a string representation of this object; useful for testing and debugging.withActionPrefix
(String actionPrefix) The action name prefix.withAlarmNamePrefix
(String alarmNamePrefix) The alarm name prefix.withAlarmNames
(String... alarmNames) A list of alarm names to retrieve information for.withAlarmNames
(Collection<String> alarmNames) A list of alarm names to retrieve information for.withMaxRecords
(Integer maxRecords) The maximum number of alarm descriptions to retrieve.withNextToken
(String nextToken) The token returned by a previous call to indicate that there is more data available.withStateValue
(StateValue stateValue) The state value to be used in matching alarms.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
-
Constructor Details
-
DescribeAlarmsRequest
public DescribeAlarmsRequest()
-
-
Method Details
-
getAlarmNames
A list of alarm names to retrieve information for.
- Returns:
- A list of alarm names to retrieve information for.
-
setAlarmNames
A list of alarm names to retrieve information for.
- Parameters:
alarmNames
- A list of alarm names to retrieve information for.
-
withAlarmNames
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
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
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
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
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
The state value to be used in matching alarms.
- Parameters:
stateValue
- The state value to be used in matching alarms.- See Also:
-
getStateValue
The state value to be used in matching alarms.
- Returns:
- The state value to be used in matching alarms.
- See Also:
-
withStateValue
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:
-
setStateValue
The state value to be used in matching alarms.
- Parameters:
stateValue
- The state value to be used in matching alarms.- See Also:
-
withStateValue
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:
-
setActionPrefix
The action name prefix.
- Parameters:
actionPrefix
- The action name prefix.
-
getActionPrefix
The action name prefix.
- Returns:
- The action name prefix.
-
withActionPrefix
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
The maximum number of alarm descriptions to retrieve.
- Parameters:
maxRecords
- The maximum number of alarm descriptions to retrieve.
-
getMaxRecords
The maximum number of alarm descriptions to retrieve.
- Returns:
- The maximum number of alarm descriptions to retrieve.
-
withMaxRecords
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
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
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
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
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
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:
-