Package software.amazon.awssdk.services.qbusiness.model

Interface ChatSyncRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<ChatSyncRequest.Builder,ChatSyncRequest>, QBusinessRequest.Builder, SdkBuilder<ChatSyncRequest.Builder,ChatSyncRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

ChatSyncRequest

public static interface ChatSyncRequest.Builder
extends QBusinessRequest.Builder, SdkPojo, CopyableBuilder<ChatSyncRequest.Builder,ChatSyncRequest>

Method Summary

Modifier and Type	Method	Description
default ChatSyncRequest.Builder	actionExecution(Consumer<ActionExecution.Builder> actionExecution)	A request from an end user to perform an Amazon Q plugin action.
ChatSyncRequest.Builder	actionExecution(ActionExecution actionExecution)	A request from an end user to perform an Amazon Q plugin action.
ChatSyncRequest.Builder	applicationId(String applicationId)	The identifier of the Amazon Q application linked to the Amazon Q conversation.
ChatSyncRequest.Builder	attachments(Collection<AttachmentInput> attachments)	A list of files uploaded directly during chat.
ChatSyncRequest.Builder	attachments(Consumer<AttachmentInput.Builder>... attachments)	A list of files uploaded directly during chat.
ChatSyncRequest.Builder	attachments(AttachmentInput... attachments)	A list of files uploaded directly during chat.
default ChatSyncRequest.Builder	attributeFilter(Consumer<AttributeFilter.Builder> attributeFilter)	Enables filtering of Amazon Q web experience responses based on document attributes or metadata fields.
ChatSyncRequest.Builder	attributeFilter(AttributeFilter attributeFilter)	Enables filtering of Amazon Q web experience responses based on document attributes or metadata fields.
ChatSyncRequest.Builder	clientToken(String clientToken)	A token that you provide to identify a chat request.
ChatSyncRequest.Builder	conversationId(String conversationId)	The identifier of the Amazon Q conversation.
ChatSyncRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
ChatSyncRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
ChatSyncRequest.Builder	parentMessageId(String parentMessageId)	The identifier of the previous end user text input message in a conversation.
ChatSyncRequest.Builder	userGroups(String... userGroups)	The groups that a user associated with the chat input belongs to.
ChatSyncRequest.Builder	userGroups(Collection<String> userGroups)	The groups that a user associated with the chat input belongs to.
ChatSyncRequest.Builder	userId(String userId)	The identifier of the user attached to the chat input.
ChatSyncRequest.Builder	userMessage(String userMessage)	A end user message in a conversation.

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.qbusiness.model.QBusinessRequest.Builder

build

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

applyMutation, build

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

equalsBySdkFields, sdkFields

Method Detail

actionExecution

ChatSyncRequest.Builder actionExecution(ActionExecution actionExecution)

A request from an end user to perform an Amazon Q plugin action.

Parameters:

actionExecution - A request from an end user to perform an Amazon Q plugin action.

Returns:

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

actionExecution

default ChatSyncRequest.Builder actionExecution(Consumer<ActionExecution.Builder> actionExecution)

A request from an end user to perform an Amazon Q plugin action.

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

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

Parameters:

actionExecution - a consumer that will call methods on ActionExecution.Builder

Returns:

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

See Also:

actionExecution(ActionExecution)

applicationId

ChatSyncRequest.Builder applicationId(String applicationId)

The identifier of the Amazon Q application linked to the Amazon Q conversation.

Parameters:

applicationId - The identifier of the Amazon Q application linked to the Amazon Q conversation.

Returns:

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

attachments

ChatSyncRequest.Builder attachments(Collection<AttachmentInput> attachments)

A list of files uploaded directly during chat. You can upload a maximum of 5 files of upto 10 MB each.

Parameters:

attachments - A list of files uploaded directly during chat. You can upload a maximum of 5 files of upto 10 MB each.

Returns:

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

attachments

ChatSyncRequest.Builder attachments(AttachmentInput... attachments)

A list of files uploaded directly during chat. You can upload a maximum of 5 files of upto 10 MB each.

Parameters:

attachments - A list of files uploaded directly during chat. You can upload a maximum of 5 files of upto 10 MB each.

Returns:

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

attachments

ChatSyncRequest.Builder attachments(Consumer<AttachmentInput.Builder>... attachments)

A list of files uploaded directly during chat. You can upload a maximum of 5 files of upto 10 MB each.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #attachments(List).

Parameters:

attachments - a consumer that will call methods on AttachmentInput.Builder

Returns:

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

See Also:

#attachments(java.util.Collection)

attributeFilter

ChatSyncRequest.Builder attributeFilter(AttributeFilter attributeFilter)

Enables filtering of Amazon Q web experience responses based on document attributes or metadata fields.

Parameters:

attributeFilter - Enables filtering of Amazon Q web experience responses based on document attributes or metadata fields.

Returns:

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

attributeFilter

default ChatSyncRequest.Builder attributeFilter(Consumer<AttributeFilter.Builder> attributeFilter)

Enables filtering of Amazon Q web experience responses based on document attributes or metadata fields.

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

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

Parameters:

attributeFilter - a consumer that will call methods on AttributeFilter.Builder

Returns:

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

See Also:

attributeFilter(AttributeFilter)

clientToken

ChatSyncRequest.Builder clientToken(String clientToken)

A token that you provide to identify a chat request.

Parameters:

clientToken - A token that you provide to identify a chat request.

Returns:

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

conversationId

ChatSyncRequest.Builder conversationId(String conversationId)

The identifier of the Amazon Q conversation.

Parameters:

conversationId - The identifier of the Amazon Q conversation.

Returns:

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

parentMessageId

ChatSyncRequest.Builder parentMessageId(String parentMessageId)

The identifier of the previous end user text input message in a conversation.

Parameters:

parentMessageId - The identifier of the previous end user text input message in a conversation.

Returns:

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

userGroups

ChatSyncRequest.Builder userGroups(Collection<String> userGroups)

The groups that a user associated with the chat input belongs to.

Parameters:

userGroups - The groups that a user associated with the chat input belongs to.

Returns:

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

userGroups

ChatSyncRequest.Builder userGroups(String... userGroups)

The groups that a user associated with the chat input belongs to.

Parameters:

userGroups - The groups that a user associated with the chat input belongs to.

Returns:

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

userId

ChatSyncRequest.Builder userId(String userId)

The identifier of the user attached to the chat input.

Parameters:

userId - The identifier of the user attached to the chat input.

Returns:

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

userMessage

ChatSyncRequest.Builder userMessage(String userMessage)

A end user message in a conversation.

Parameters:

userMessage - A end user message in a conversation.

Returns:

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

overrideConfiguration

ChatSyncRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder