Interface ListMessagesRequest.Builder
- All Superinterfaces:
AwsRequest.Builder,Buildable,CopyableBuilder<ListMessagesRequest.Builder,,ListMessagesRequest> QBusinessRequest.Builder,SdkBuilder<ListMessagesRequest.Builder,,ListMessagesRequest> SdkPojo,SdkRequest.Builder
- Enclosing class:
ListMessagesRequest
public static interface ListMessagesRequest.Builder
extends QBusinessRequest.Builder, SdkPojo, CopyableBuilder<ListMessagesRequest.Builder,ListMessagesRequest>
-
Method Summary
Modifier and TypeMethodDescriptionapplicationId(String applicationId) The identifier for the Amazon Q Business application.conversationId(String conversationId) The identifier of the Amazon Q Business web experience conversation.maxResults(Integer maxResults) The maximum number of messages to return.If the number of retrievers returned exceedsmaxResults, Amazon Q Business returns a next token as a pagination token to retrieve the next set of messages.overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.The identifier of the user involved in the Amazon Q Business web experience conversation.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.qbusiness.model.QBusinessRequest.Builder
buildMethods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, buildMethods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
conversationId
The identifier of the Amazon Q Business web experience conversation.
- Parameters:
conversationId- The identifier of the Amazon Q Business web experience conversation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
applicationId
The identifier for the Amazon Q Business application.
- Parameters:
applicationId- The identifier for the Amazon Q Business application.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
userId
The identifier of the user involved in the Amazon Q Business web experience conversation.
- Parameters:
userId- The identifier of the user involved in the Amazon Q Business web experience conversation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
nextToken
If the number of retrievers returned exceeds
maxResults, Amazon Q Business returns a next token as a pagination token to retrieve the next set of messages.- Parameters:
nextToken- If the number of retrievers returned exceedsmaxResults, Amazon Q Business returns a next token as a pagination token to retrieve the next set of messages.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
maxResults
The maximum number of messages to return.
- Parameters:
maxResults- The maximum number of messages to return.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
ListMessagesRequest.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
ListMessagesRequest.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.
-