software.amazon.awssdk.services.applicationdiscovery.model

Interface DescribeAgentsRequest.Builder

All Superinterfaces:

ApplicationDiscoveryRequest.Builder, AwsRequest.Builder, CopyableBuilder<DescribeAgentsRequest.Builder,DescribeAgentsRequest>, SdkBuilder<DescribeAgentsRequest.Builder,DescribeAgentsRequest>, SdkRequest.Builder

Enclosing class:

DescribeAgentsRequest

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

Method Summary

Modifier and Type	Method and Description
DescribeAgentsRequest.Builder	agentIds(Collection<String> agentIds) The agent or the Connector IDs for which you want information.
DescribeAgentsRequest.Builder	agentIds(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(Consumer<Filter.Builder>... 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.
DescribeAgentsRequest.Builder	requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig) Add an optional request override configuration.
DescribeAgentsRequest.Builder	requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer) Add an optional request override configuration.

Methods inherited from interface software.amazon.awssdk.services.applicationdiscovery.model.ApplicationDiscoveryRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

requestOverrideConfig

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.

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"}

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(Consumer<Filter.Builder>... filters)

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

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

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #filters(List).

Parameters:

filters - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#filters(List)

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.

requestOverrideConfig

DescribeAgentsRequest.Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

awsRequestOverrideConfig - The override configuration.

Returns:

This object for method chaining.

requestOverrideConfig

DescribeAgentsRequest.Builder requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfig.Builder will be given.

Returns:

This object for method chaining.