Class DescribeAgentsRequest
- 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 agent IDs for which you want information.The total number of agents to return.A token to start the list.int
hashCode()
void
setAgentIds
(Collection<String> agentIds) The agent IDs for which you want information.void
setMaxResults
(Integer maxResults) The total number of agents to return.void
setNextToken
(String nextToken) A token to start the list.toString()
Returns a string representation of this object; useful for testing and debugging.withAgentIds
(String... agentIds) The agent IDs for which you want information.withAgentIds
(Collection<String> agentIds) The agent IDs for which you want information.withMaxResults
(Integer maxResults) The total number of agents to return.withNextToken
(String nextToken) A token to start the list.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
-
DescribeAgentsRequest
public DescribeAgentsRequest()
-
-
Method Details
-
getAgentIds
The agent IDs for which you want information. If you specify no IDs, the system returns information about all agents associated with your AWS user account.
- Returns:
- The agent IDs for which you want information. If you specify no IDs, the system returns information about all agents associated with your AWS user account.
-
setAgentIds
The agent IDs for which you want information. If you specify no IDs, the system returns information about all agents associated with your AWS user account.
- Parameters:
agentIds
- The agent IDs for which you want information. If you specify no IDs, the system returns information about all agents associated with your AWS user account.
-
withAgentIds
The agent IDs for which you want information. If you specify no IDs, the system returns information about all agents associated with your AWS user account.
NOTE: This method appends the values to the existing list (if any). Use
setAgentIds(java.util.Collection)
orwithAgentIds(java.util.Collection)
if you want to override the existing values.- Parameters:
agentIds
- The agent IDs for which you want information. If you specify no IDs, the system returns information about all agents associated with your AWS user account.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withAgentIds
The agent IDs for which you want information. If you specify no IDs, the system returns information about all agents associated with your AWS user account.
- Parameters:
agentIds
- The agent IDs for which you want information. If you specify no IDs, the system returns information about all agents associated with your AWS user account.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setMaxResults
The total number of agents to return. The maximum value is 100.
- Parameters:
maxResults
- The total number of agents to return. The maximum value is 100.
-
getMaxResults
The total number of agents to return. The maximum value is 100.
- Returns:
- The total number of agents to return. The maximum value is 100.
-
withMaxResults
The total number of agents to return. The maximum value is 100.
- Parameters:
maxResults
- The total number of agents to return. The maximum value is 100.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setNextToken
A token to start the list. Use this token to get the next set of results.
- Parameters:
nextToken
- A token to start the list. Use this token to get the next set of results.
-
getNextToken
A token to start the list. Use this token to get the next set of results.
- Returns:
- A token to start the list. Use this token to get the next set of results.
-
withNextToken
A token to start the list. Use this token to get the next set of results.
- Parameters:
nextToken
- A token to start the list. Use this token to get the next set of results.- 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:
-