Interface ChatSyncResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<ChatSyncResponse.Builder,ChatSyncResponse>, QBusinessResponse.Builder, SdkBuilder<ChatSyncResponse.Builder,ChatSyncResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

ChatSyncResponse

@Mutable
@NotThreadSafe
public static interface ChatSyncResponse.Builder
extends QBusinessResponse.Builder, SdkPojo, CopyableBuilder<ChatSyncResponse.Builder,ChatSyncResponse>

Method Summary

Modifier and Type	Method	Description
default ChatSyncResponse.Builder	actionReview(Consumer<ActionReview.Builder> actionReview)	A request from Amazon Q Business to the end user for information Amazon Q Business needs to successfully complete a requested plugin action.
ChatSyncResponse.Builder	actionReview(ActionReview actionReview)	A request from Amazon Q Business to the end user for information Amazon Q Business needs to successfully complete a requested plugin action.
default ChatSyncResponse.Builder	authChallengeRequest(Consumer<AuthChallengeRequest.Builder> authChallengeRequest)	An authentication verification event activated by an end user request to use a custom plugin.
ChatSyncResponse.Builder	authChallengeRequest(AuthChallengeRequest authChallengeRequest)	An authentication verification event activated by an end user request to use a custom plugin.
ChatSyncResponse.Builder	conversationId(String conversationId)	The identifier of the Amazon Q Business conversation.
ChatSyncResponse.Builder	failedAttachments(Collection<AttachmentOutput> failedAttachments)	A list of files which failed to upload during chat.
ChatSyncResponse.Builder	failedAttachments(Consumer<AttachmentOutput.Builder>... failedAttachments)	A list of files which failed to upload during chat.
ChatSyncResponse.Builder	failedAttachments(AttachmentOutput... failedAttachments)	A list of files which failed to upload during chat.
ChatSyncResponse.Builder	sourceAttributions(Collection<SourceAttribution> sourceAttributions)	The source documents used to generate the conversation response.
ChatSyncResponse.Builder	sourceAttributions(Consumer<SourceAttribution.Builder>... sourceAttributions)	The source documents used to generate the conversation response.
ChatSyncResponse.Builder	sourceAttributions(SourceAttribution... sourceAttributions)	The source documents used to generate the conversation response.
ChatSyncResponse.Builder	systemMessage(String systemMessage)	An AI-generated message in a conversation.
ChatSyncResponse.Builder	systemMessageId(String systemMessageId)	The identifier of an Amazon Q Business AI generated message within the conversation.
ChatSyncResponse.Builder	userMessageId(String userMessageId)	The identifier of an Amazon Q Business end user text input message within the conversation.

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

copy

Methods inherited from interface software.amazon.awssdk.services.qbusiness.model.QBusinessResponse.Builder

build, responseMetadata, responseMetadata

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

applyMutation, build

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

equalsBySdkFields, sdkFieldNameToField, sdkFields

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Method Details

conversationId

ChatSyncResponse.Builder conversationId(String conversationId)

The identifier of the Amazon Q Business conversation.

Parameters:

conversationId - The identifier of the Amazon Q Business conversation.

Returns:

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

systemMessage

ChatSyncResponse.Builder systemMessage(String systemMessage)

An AI-generated message in a conversation.

Parameters:

systemMessage - An AI-generated message in a conversation.

Returns:

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

systemMessageId

ChatSyncResponse.Builder systemMessageId(String systemMessageId)

The identifier of an Amazon Q Business AI generated message within the conversation.

Parameters:

systemMessageId - The identifier of an Amazon Q Business AI generated message within the conversation.

Returns:

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

userMessageId

ChatSyncResponse.Builder userMessageId(String userMessageId)

The identifier of an Amazon Q Business end user text input message within the conversation.

Parameters:

userMessageId - The identifier of an Amazon Q Business end user text input message within the conversation.

Returns:

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

actionReview

ChatSyncResponse.Builder actionReview(ActionReview actionReview)

A request from Amazon Q Business to the end user for information Amazon Q Business needs to successfully complete a requested plugin action.

Parameters:

actionReview - A request from Amazon Q Business to the end user for information Amazon Q Business needs to successfully complete a requested plugin action.

Returns:

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

actionReview

default ChatSyncResponse.Builder actionReview(Consumer<ActionReview.Builder> actionReview)

A request from Amazon Q Business to the end user for information Amazon Q Business needs to successfully complete a requested plugin action.

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

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

Parameters:

actionReview - a consumer that will call methods on ActionReview.Builder

Returns:

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

See Also:

• actionReview(ActionReview)

authChallengeRequest

ChatSyncResponse.Builder authChallengeRequest(AuthChallengeRequest authChallengeRequest)

An authentication verification event activated by an end user request to use a custom plugin.

Parameters:

authChallengeRequest - An authentication verification event activated by an end user request to use a custom plugin.

Returns:

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

authChallengeRequest

default ChatSyncResponse.Builder authChallengeRequest(Consumer<AuthChallengeRequest.Builder> authChallengeRequest)

An authentication verification event activated by an end user request to use a custom plugin.

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

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

Parameters:

authChallengeRequest - a consumer that will call methods on AuthChallengeRequest.Builder

Returns:

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

See Also:

• authChallengeRequest(AuthChallengeRequest)

sourceAttributions

ChatSyncResponse.Builder sourceAttributions(Collection<SourceAttribution> sourceAttributions)

The source documents used to generate the conversation response.

Parameters:

sourceAttributions - The source documents used to generate the conversation response.

Returns:

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

sourceAttributions

ChatSyncResponse.Builder sourceAttributions(SourceAttribution... sourceAttributions)

The source documents used to generate the conversation response.

Parameters:

sourceAttributions - The source documents used to generate the conversation response.

Returns:

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

sourceAttributions

ChatSyncResponse.Builder sourceAttributions(Consumer<SourceAttribution.Builder>... sourceAttributions)

The source documents used to generate the conversation response.

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

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

Parameters:

sourceAttributions - a consumer that will call methods on SourceAttribution.Builder

Returns:

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

See Also:

• sourceAttributions(java.util.Collection<SourceAttribution>)

failedAttachments

ChatSyncResponse.Builder failedAttachments(Collection<AttachmentOutput> failedAttachments)

A list of files which failed to upload during chat.

Parameters:

failedAttachments - A list of files which failed to upload during chat.

Returns:

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

failedAttachments

ChatSyncResponse.Builder failedAttachments(AttachmentOutput... failedAttachments)

A list of files which failed to upload during chat.

Parameters:

failedAttachments - A list of files which failed to upload during chat.

Returns:

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

failedAttachments

ChatSyncResponse.Builder failedAttachments(Consumer<AttachmentOutput.Builder>... failedAttachments)

A list of files which failed to upload during chat.

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

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

Parameters:

failedAttachments - a consumer that will call methods on AttachmentOutput.Builder

Returns:

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

See Also:

• failedAttachments(java.util.Collection<AttachmentOutput>)