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 TypeMethodDescriptionawsAccountId(String awsAccountId) The ID of the Amazon Web Services account that contains the knowledge base.filters(Collection<KnowledgeBaseSearchFilter> filters) The filters to apply when searching knowledge bases.filters(Consumer<KnowledgeBaseSearchFilter.Builder>... filters) The filters to apply when searching knowledge bases.filters(KnowledgeBaseSearchFilter... filters) The filters to apply when searching knowledge bases.maxResults(Integer maxResults) The maximum number of results to return.The token for the next set of results, or null if there are no more results.overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.sortBy(Consumer<KnowledgeBaseSortBy.Builder> sortBy) The sort configuration for the search results.sortBy(KnowledgeBaseSortBy sortBy) The sort configuration for the search results.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfigurationMethods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copyMethods inherited from interface software.amazon.awssdk.services.quicksight.model.QuickSightRequest.Builder
buildMethods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, buildMethods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
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
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
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
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
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
The filters to apply when searching knowledge bases.
This is a convenience method that creates an instance of theKnowledgeBaseSearchFilter.Builderavoiding the need to create one manually viaKnowledgeBaseSearchFilter.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tofilters(List<KnowledgeBaseSearchFilter>).- Parameters:
filters- a consumer that will call methods onKnowledgeBaseSearchFilter.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
The sort configuration for the search results.
This is a convenience method that creates an instance of theKnowledgeBaseSortBy.Builderavoiding the need to create one manually viaKnowledgeBaseSortBy.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tosortBy(KnowledgeBaseSortBy).- Parameters:
sortBy- a consumer that will call methods onKnowledgeBaseSortBy.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
SearchKnowledgeBasesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.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.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder- Parameters:
builderConsumer- AConsumerto which an emptyAwsRequestOverrideConfiguration.Builderwill be given.- Returns:
- This object for method chaining.
-