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

Class ChatSyncResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.qbusiness.model.QBusinessResponse

software.amazon.awssdk.services.qbusiness.model.ChatSyncResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ChatSyncResponse.Builder,ChatSyncResponse>

@Generated("software.amazon.awssdk:codegen")
public final class ChatSyncResponse
extends QBusinessResponse
implements ToCopyableBuilder<ChatSyncResponse.Builder,ChatSyncResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ChatSyncResponse.Builder

Method Summary

Modifier and Type	Method	Description
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.
AuthChallengeRequest	authChallengeRequest()	An authentication verification event activated by an end user request to use a custom plugin.
static ChatSyncResponse.Builder	builder()
String	conversationId()	The identifier of the Amazon Q Business conversation.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<AttachmentOutput>	failedAttachments()	A list of files which failed to upload during chat.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFailedAttachments()	For responses, this returns true if the service returned a value for the FailedAttachments property.
int	hashCode()
boolean	hasSourceAttributions()	For responses, this returns true if the service returned a value for the SourceAttributions property.
List<SdkField<?>>	sdkFields()
static Class<? extends ChatSyncResponse.Builder>	serializableBuilderClass()
List<SourceAttribution>	sourceAttributions()	The source documents used to generate the conversation response.
String	systemMessage()	An AI-generated message in a conversation.
String	systemMessageId()	The identifier of an Amazon Q Business AI generated message within the conversation.
ChatSyncResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	userMessageId()	The identifier of an Amazon Q Business end user text input message within the conversation.

Methods inherited from class software.amazon.awssdk.services.qbusiness.model.QBusinessResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

conversationId

public final String conversationId()

The identifier of the Amazon Q Business conversation.

Returns:

The identifier of the Amazon Q Business conversation.

systemMessage

public final String systemMessage()

An AI-generated message in a conversation.

Returns:

An AI-generated message in a conversation.

systemMessageId

public final String systemMessageId()

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

Returns:

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

userMessageId

public final String userMessageId()

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

Returns:

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

actionReview

public final 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.

Returns:

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

authChallengeRequest

public final AuthChallengeRequest authChallengeRequest()

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

Returns:

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

hasSourceAttributions

public final boolean hasSourceAttributions()

For responses, this returns true if the service returned a value for the SourceAttributions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

sourceAttributions

public final List<SourceAttribution> sourceAttributions()

The source documents used to generate the conversation response.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSourceAttributions() method.

Returns:

The source documents used to generate the conversation response.

hasFailedAttachments

public final boolean hasFailedAttachments()

For responses, this returns true if the service returned a value for the FailedAttachments property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

failedAttachments

public final List<AttachmentOutput> failedAttachments()

A list of files which failed to upload during chat.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFailedAttachments() method.

Returns:

A list of files which failed to upload during chat.

toBuilder

public ChatSyncResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ChatSyncResponse.Builder,ChatSyncResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static ChatSyncResponse.Builder builder()

serializableBuilderClass

public static Class<? extends ChatSyncResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo