Interface SearchAgentsRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<SearchAgentsRequest.Builder,SearchAgentsRequest>, QuickSightRequest.Builder, SdkBuilder<SearchAgentsRequest.Builder,SearchAgentsRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

SearchAgentsRequest

@Mutable
@NotThreadSafe
public static interface SearchAgentsRequest.Builder
extends QuickSightRequest.Builder, SdkPojo, CopyableBuilder<SearchAgentsRequest.Builder,SearchAgentsRequest>

Method Summary

Modifier and Type	Method	Description
SearchAgentsRequest.Builder	awsAccountId(String awsAccountId)	The ID of the Amazon Web Services account that contains the agents.
SearchAgentsRequest.Builder	filters(Collection<AgentSearchFilter> filters)	The filters to apply when searching agents.
SearchAgentsRequest.Builder	filters(Consumer<AgentSearchFilter.Builder>... filters)	The filters to apply when searching agents.
SearchAgentsRequest.Builder	filters(AgentSearchFilter... filters)	The filters to apply when searching agents.
SearchAgentsRequest.Builder	maxResults(Integer maxResults)	The maximum number of results to return.
SearchAgentsRequest.Builder	nextToken(String nextToken)	The token for the next set of results, or null if there are no more results.
SearchAgentsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
SearchAgentsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.

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.services.quicksight.model.QuickSightRequest.Builder

build

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

awsAccountId

SearchAgentsRequest.Builder awsAccountId(String awsAccountId)

The ID of the Amazon Web Services account that contains the agents.

Parameters:

awsAccountId - The ID of the Amazon Web Services account that contains the agents.

Returns:

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

filters

SearchAgentsRequest.Builder filters(Collection<AgentSearchFilter> filters)

The filters to apply when searching agents.

Parameters:

filters - The filters to apply when searching agents.

Returns:

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

filters

SearchAgentsRequest.Builder filters(AgentSearchFilter... filters)

The filters to apply when searching agents.

Parameters:

filters - The filters to apply when searching agents.

Returns:

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

filters

SearchAgentsRequest.Builder filters(Consumer<AgentSearchFilter.Builder>... filters)

The filters to apply when searching agents.

This is a convenience method that creates an instance of the AgentSearchFilter.Builder avoiding the need to create one manually via AgentSearchFilter.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to filters(List<AgentSearchFilter>).

Parameters:

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

Returns:

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

See Also:

• filters(java.util.Collection<AgentSearchFilter>)

maxResults

SearchAgentsRequest.Builder maxResults(Integer maxResults)

The maximum number of results to return.

Parameters:

maxResults - The maximum number of results to return.

Returns:

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

nextToken

SearchAgentsRequest.Builder nextToken(String nextToken)

The token for the next set of results, or null if there are no more results.

Parameters:

nextToken - The token for the next set of results, or null if there are no more results.

Returns:

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

overrideConfiguration

SearchAgentsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

SearchAgentsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

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

Returns:

This object for method chaining.