com.amazonaws.services.applicationdiscovery.model

Class DescribeAgentsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.applicationdiscovery.model.DescribeAgentsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeAgentsRequest()

Method Summary

Modifier and Type	Method and Description
DescribeAgentsRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
List<String>	getAgentIds() The agent or the collector IDs for which you want information.
List<Filter>	getFilters() You can filter the request using various logical operators and a key-value format.
Integer	getMaxResults() The total number of agents/collectors to return in a single page of output.
String	getNextToken() Token to retrieve the next set of results.
int	hashCode()
void	setAgentIds(Collection<String> agentIds) The agent or the collector IDs for which you want information.
void	setFilters(Collection<Filter> filters) You can filter the request using various logical operators and a key-value format.
void	setMaxResults(Integer maxResults) The total number of agents/collectors to return in a single page of output.
void	setNextToken(String nextToken) Token to retrieve the next set of results.
String	toString() Returns a string representation of this object.
DescribeAgentsRequest	withAgentIds(Collection<String> agentIds) The agent or the collector IDs for which you want information.
DescribeAgentsRequest	withAgentIds(String... agentIds) The agent or the collector IDs for which you want information.
DescribeAgentsRequest	withFilters(Collection<Filter> filters) You can filter the request using various logical operators and a key-value format.
DescribeAgentsRequest	withFilters(Filter... filters) You can filter the request using various logical operators and a key-value format.
DescribeAgentsRequest	withMaxResults(Integer maxResults) The total number of agents/collectors to return in a single page of output.
DescribeAgentsRequest	withNextToken(String nextToken) Token to retrieve the next set of results.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, 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

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeAgentsRequest

public DescribeAgentsRequest()

Method Detail

getAgentIds

public List<String> getAgentIds()

The agent or the collector IDs for which you want information. If you specify no IDs, the system returns information about all agents/collectors associated with your user.

Returns:

The agent or the collector IDs for which you want information. If you specify no IDs, the system returns information about all agents/collectors associated with your user.

setAgentIds

public void setAgentIds(Collection<String> agentIds)

The agent or the collector IDs for which you want information. If you specify no IDs, the system returns information about all agents/collectors associated with your user.

Parameters:

agentIds - The agent or the collector IDs for which you want information. If you specify no IDs, the system returns information about all agents/collectors associated with your user.

withAgentIds

public DescribeAgentsRequest withAgentIds(String... agentIds)

The agent or the collector IDs for which you want information. If you specify no IDs, the system returns information about all agents/collectors associated with your user.

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

Parameters:

agentIds - The agent or the collector IDs for which you want information. If you specify no IDs, the system returns information about all agents/collectors associated with your user.

Returns:

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

withAgentIds

public DescribeAgentsRequest withAgentIds(Collection<String> agentIds)

The agent or the collector IDs for which you want information. If you specify no IDs, the system returns information about all agents/collectors associated with your user.

Parameters:

agentIds - The agent or the collector IDs for which you want information. If you specify no IDs, the system returns information about all agents/collectors associated with your user.

Returns:

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

getFilters

public List<Filter> getFilters()

You can filter the request using various logical operators and a key-value format. For example:

{"key": "collectionStatus", "value": "STARTED"}

Returns:

You can filter the request using various logical operators and a key-value format. For example:

{"key": "collectionStatus", "value": "STARTED"}

setFilters

public void setFilters(Collection<Filter> filters)

You can filter the request using various logical operators and a key-value format. For example:

{"key": "collectionStatus", "value": "STARTED"}

Parameters:

filters - You can filter the request using various logical operators and a key-value format. For example:

{"key": "collectionStatus", "value": "STARTED"}

withFilters

public DescribeAgentsRequest withFilters(Filter... filters)

You can filter the request using various logical operators and a key-value format. For example:

{"key": "collectionStatus", "value": "STARTED"}

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

Parameters:

filters - You can filter the request using various logical operators and a key-value format. For example:

{"key": "collectionStatus", "value": "STARTED"}

Returns:

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

withFilters

public DescribeAgentsRequest withFilters(Collection<Filter> filters)

You can filter the request using various logical operators and a key-value format. For example:

{"key": "collectionStatus", "value": "STARTED"}

Parameters:

filters - You can filter the request using various logical operators and a key-value format. For example:

{"key": "collectionStatus", "value": "STARTED"}

Returns:

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

setMaxResults

public void setMaxResults(Integer maxResults)

The total number of agents/collectors to return in a single page of output. The maximum value is 100.

Parameters:

maxResults - The total number of agents/collectors to return in a single page of output. The maximum value is 100.

getMaxResults

public Integer getMaxResults()

The total number of agents/collectors to return in a single page of output. The maximum value is 100.

Returns:

The total number of agents/collectors to return in a single page of output. The maximum value is 100.

withMaxResults

public DescribeAgentsRequest withMaxResults(Integer maxResults)

The total number of agents/collectors to return in a single page of output. The maximum value is 100.

Parameters:

maxResults - The total number of agents/collectors to return in a single page of output. The maximum value is 100.

Returns:

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

setNextToken

public void setNextToken(String nextToken)

Token to retrieve the next set of results. For example, if you previously specified 100 IDs for DescribeAgentsRequest$agentIds but set DescribeAgentsRequest$maxResults to 10, you received a set of 10 results along with a token. Use that token in this query to get the next set of 10.

Parameters:

nextToken - Token to retrieve the next set of results. For example, if you previously specified 100 IDs for DescribeAgentsRequest$agentIds but set DescribeAgentsRequest$maxResults to 10, you received a set of 10 results along with a token. Use that token in this query to get the next set of 10.

getNextToken

public String getNextToken()

Token to retrieve the next set of results. For example, if you previously specified 100 IDs for DescribeAgentsRequest$agentIds but set DescribeAgentsRequest$maxResults to 10, you received a set of 10 results along with a token. Use that token in this query to get the next set of 10.

Returns:

Token to retrieve the next set of results. For example, if you previously specified 100 IDs for DescribeAgentsRequest$agentIds but set DescribeAgentsRequest$maxResults to 10, you received a set of 10 results along with a token. Use that token in this query to get the next set of 10.

withNextToken

public DescribeAgentsRequest withNextToken(String nextToken)

Token to retrieve the next set of results. For example, if you previously specified 100 IDs for DescribeAgentsRequest$agentIds but set DescribeAgentsRequest$maxResults to 10, you received a set of 10 results along with a token. Use that token in this query to get the next set of 10.

Parameters:

nextToken - Token to retrieve the next set of results. For example, if you previously specified 100 IDs for DescribeAgentsRequest$agentIds but set DescribeAgentsRequest$maxResults to 10, you received a set of 10 results along with a token. Use that token in this query to get the next set of 10.

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 DescribeAgentsRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()