Package software.amazon.awssdk.services.applicationdiscovery.model

Interface DescribeAgentsRequest.Builder

All Superinterfaces:

CopyableBuilder<DescribeAgentsRequest.Builder,DescribeAgentsRequest>, SdkBuilder<DescribeAgentsRequest.Builder,DescribeAgentsRequest>

Enclosing class:

DescribeAgentsRequest

public static interface DescribeAgentsRequest.Builder
extends CopyableBuilder<DescribeAgentsRequest.Builder,DescribeAgentsRequest>

Method Summary

Modifier and Type	Method	Description
DescribeAgentsRequest.Builder	agentIds(String... agentIds)	The agent or the Connector IDs for which you want information.
DescribeAgentsRequest.Builder	agentIds(Collection<String> agentIds)	The agent or the Connector IDs for which you want information.
DescribeAgentsRequest.Builder	filters(Collection<Filter> filters)	You can filter the request using various logical operators and a key-value format.
DescribeAgentsRequest.Builder	filters(Filter... filters)	You can filter the request using various logical operators and a key-value format.
DescribeAgentsRequest.Builder	maxResults(Integer maxResults)	The total number of agents/Connectors to return in a single page of output.
DescribeAgentsRequest.Builder	nextToken(String nextToken)	Token to retrieve the next set of results.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

apply, build

Method Detail

agentIds

DescribeAgentsRequest.Builder agentIds(Collection<String> agentIds)

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

Parameters:

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

Returns:

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

agentIds

DescribeAgentsRequest.Builder agentIds(String... agentIds)

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

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 Connector IDs for which you want information. If you specify no IDs, the system returns information about all agents/Connectors associated with your AWS user account.

Returns:

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

filters

DescribeAgentsRequest.Builder filters(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.

filters

DescribeAgentsRequest.Builder filters(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.

maxResults

DescribeAgentsRequest.Builder maxResults(Integer maxResults)

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

Parameters:

maxResults - The total number of agents/Connectors 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.

nextToken

DescribeAgentsRequest.Builder nextToken(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.