Interface SearchMessageTemplatesRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<SearchMessageTemplatesRequest.Builder,
,SearchMessageTemplatesRequest> QConnectRequest.Builder
,SdkBuilder<SearchMessageTemplatesRequest.Builder,
,SearchMessageTemplatesRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
SearchMessageTemplatesRequest
@Mutable
@NotThreadSafe
public static interface SearchMessageTemplatesRequest.Builder
extends QConnectRequest.Builder, SdkPojo, CopyableBuilder<SearchMessageTemplatesRequest.Builder,SearchMessageTemplatesRequest>
-
Method Summary
Modifier and TypeMethodDescriptionknowledgeBaseId
(String knowledgeBaseId) The identifier of the knowledge base.maxResults
(Integer maxResults) The maximum number of results to return per page.The token for 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.searchExpression
(Consumer<MessageTemplateSearchExpression.Builder> searchExpression) The search expression for querying the message template.searchExpression
(MessageTemplateSearchExpression searchExpression) The search expression for querying the message template.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.qconnect.model.QConnectRequest.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
-
knowledgeBaseId
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
- Parameters:
knowledgeBaseId
- The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
searchExpression
SearchMessageTemplatesRequest.Builder searchExpression(MessageTemplateSearchExpression searchExpression) The search expression for querying the message template.
- Parameters:
searchExpression
- The search expression for querying the message template.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
searchExpression
default SearchMessageTemplatesRequest.Builder searchExpression(Consumer<MessageTemplateSearchExpression.Builder> searchExpression) The search expression for querying the message template.
This is a convenience method that creates an instance of theMessageTemplateSearchExpression.Builder
avoiding the need to create one manually viaMessageTemplateSearchExpression.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosearchExpression(MessageTemplateSearchExpression)
.- Parameters:
searchExpression
- a consumer that will call methods onMessageTemplateSearchExpression.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
nextToken
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
- Parameters:
nextToken
- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
maxResults
The maximum number of results to return per page.
- Parameters:
maxResults
- The maximum number of results to return per page.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
SearchMessageTemplatesRequest.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
SearchMessageTemplatesRequest.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.
-