Interface DescribeAgentsRequest.Builder
- All Superinterfaces:
ApplicationDiscoveryRequest.Builder
,AwsRequest.Builder
,Buildable
,CopyableBuilder<DescribeAgentsRequest.Builder,
,DescribeAgentsRequest> SdkBuilder<DescribeAgentsRequest.Builder,
,DescribeAgentsRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
DescribeAgentsRequest
-
Method Summary
Modifier and TypeMethodDescriptionThe agent or the collector IDs for which you want information.agentIds
(Collection<String> agentIds) The agent or the collector IDs for which you want information.filters
(Collection<Filter> filters) You can filter the request using various logical operators and a key-value format.filters
(Consumer<Filter.Builder>... filters) You can filter the request using various logical operators and a key-value format.You can filter the request using various logical operators and a key-value format.maxResults
(Integer maxResults) The total number of agents/collectors to return in a single page of output.Token to retrieve the next set of results.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) 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
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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.
-
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.
-
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
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
You can filter the request using various logical operators and a key-value format. For example:
{"key": "collectionStatus", "value": "STARTED"}
Filter.Builder
avoiding the need to create one manually viaFilter.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tofilters(List<Filter>)
.- Parameters:
filters
- a consumer that will call methods onFilter.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
-
nextToken
Token to retrieve the next set of results. For example, if you previously specified 100 IDs for
DescribeAgentsRequest$agentIds
but setDescribeAgentsRequest$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 forDescribeAgentsRequest$agentIds
but setDescribeAgentsRequest$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.
-
overrideConfiguration
DescribeAgentsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
DescribeAgentsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-