Interface SearchKnowledgeBasesRequest.Builder

All Superinterfaces:

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

Enclosing class:

SearchKnowledgeBasesRequest

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

Method Summary

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

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

SearchKnowledgeBasesRequest.Builder awsAccountId(String awsAccountId)

The ID of the Amazon Web Services account that contains the knowledge base.

Parameters:

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

Returns:

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

nextToken

SearchKnowledgeBasesRequest.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.

maxResults

SearchKnowledgeBasesRequest.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.

filters

SearchKnowledgeBasesRequest.Builder filters(Collection<KnowledgeBaseSearchFilter> filters)

The filters to apply when searching knowledge bases.

Parameters:

filters - The filters to apply when searching knowledge bases.

Returns:

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

filters

SearchKnowledgeBasesRequest.Builder filters(KnowledgeBaseSearchFilter... filters)

The filters to apply when searching knowledge bases.

Parameters:

filters - The filters to apply when searching knowledge bases.

Returns:

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

filters

SearchKnowledgeBasesRequest.Builder filters(Consumer<KnowledgeBaseSearchFilter.Builder>... filters)

The filters to apply when searching knowledge bases.

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

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

Parameters:

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

Returns:

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

See Also:

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

sortBy

SearchKnowledgeBasesRequest.Builder sortBy(KnowledgeBaseSortBy sortBy)

The sort configuration for the search results.

Parameters:

sortBy - The sort configuration for the search results.

Returns:

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

sortBy

default SearchKnowledgeBasesRequest.Builder sortBy(Consumer<KnowledgeBaseSortBy.Builder> sortBy)

The sort configuration for the search results.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sortBy(KnowledgeBaseSortBy).

Parameters:

sortBy - a consumer that will call methods on KnowledgeBaseSortBy.Builder

Returns:

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

See Also:

• sortBy(KnowledgeBaseSortBy)

overrideConfiguration

SearchKnowledgeBasesRequest.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

SearchKnowledgeBasesRequest.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.