ChatSyncResult (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<ResponseMetadata>
- - com.amazonaws.services.qbusiness.model.ChatSyncResult

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ChatSyncResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ChatSyncResult()

Constructors
Constructor and Description
`ChatSyncResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ChatSyncResult`	`clone()`
`boolean`	`equals(Object obj)`
`ActionReview`	`getActionReview()` A request from Amazon Q Business to the end user for information Amazon Q Business needs to successfully complete a requested plugin action.
`AuthChallengeRequest`	`getAuthChallengeRequest()` An authentication verification event activated by an end user request to use a custom plugin.
`String`	`getConversationId()` The identifier of the Amazon Q Business conversation.
`List<AttachmentOutput>`	`getFailedAttachments()` A list of files which failed to upload during chat.
`List<SourceAttribution>`	`getSourceAttributions()` The source documents used to generate the conversation response.
`String`	`getSystemMessage()` An AI-generated message in a conversation.
`String`	`getSystemMessageId()` The identifier of an Amazon Q Business AI generated message within the conversation.
`String`	`getUserMessageId()` The identifier of an Amazon Q Business end user text input message within the conversation.
`int`	`hashCode()`
`void`	`setActionReview(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.
`void`	`setAuthChallengeRequest(AuthChallengeRequest authChallengeRequest)` An authentication verification event activated by an end user request to use a custom plugin.
`void`	`setConversationId(String conversationId)` The identifier of the Amazon Q Business conversation.
`void`	`setFailedAttachments(Collection<AttachmentOutput> failedAttachments)` A list of files which failed to upload during chat.
`void`	`setSourceAttributions(Collection<SourceAttribution> sourceAttributions)` The source documents used to generate the conversation response.
`void`	`setSystemMessage(String systemMessage)` An AI-generated message in a conversation.
`void`	`setSystemMessageId(String systemMessageId)` The identifier of an Amazon Q Business AI generated message within the conversation.
`void`	`setUserMessageId(String userMessageId)` The identifier of an Amazon Q Business end user text input message within the conversation.
`String`	`toString()` Returns a string representation of this object.
`ChatSyncResult`	`withActionReview(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.
`ChatSyncResult`	`withAuthChallengeRequest(AuthChallengeRequest authChallengeRequest)` An authentication verification event activated by an end user request to use a custom plugin.
`ChatSyncResult`	`withConversationId(String conversationId)` The identifier of the Amazon Q Business conversation.
`ChatSyncResult`	`withFailedAttachments(AttachmentOutput... failedAttachments)` A list of files which failed to upload during chat.
`ChatSyncResult`	`withFailedAttachments(Collection<AttachmentOutput> failedAttachments)` A list of files which failed to upload during chat.
`ChatSyncResult`	`withSourceAttributions(Collection<SourceAttribution> sourceAttributions)` The source documents used to generate the conversation response.
`ChatSyncResult`	`withSourceAttributions(SourceAttribution... sourceAttributions)` The source documents used to generate the conversation response.
`ChatSyncResult`	`withSystemMessage(String systemMessage)` An AI-generated message in a conversation.
`ChatSyncResult`	`withSystemMessageId(String systemMessageId)` The identifier of an Amazon Q Business AI generated message within the conversation.
`ChatSyncResult`	`withUserMessageId(String userMessageId)` The identifier of an Amazon Q Business end user text input message within the conversation.

Methods inherited from class com.amazonaws.AmazonWebServiceResult
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ChatSyncResult
```
public ChatSyncResult()
```
- Method Detail
  - setConversationId
```
public void setConversationId(String conversationId)
```
    The identifier of the Amazon Q Business conversation.
    
    Parameters:
    
    conversationId - The identifier of the Amazon Q Business conversation.
  - getConversationId
```
public String getConversationId()
```
    The identifier of the Amazon Q Business conversation.
    
    Returns:
    
    The identifier of the Amazon Q Business conversation.
  - withConversationId
```
public ChatSyncResult withConversationId(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.
  - setSystemMessage
```
public void setSystemMessage(String systemMessage)
```
    An AI-generated message in a conversation.
    
    Parameters:
    
    systemMessage - An AI-generated message in a conversation.
  - getSystemMessage
```
public String getSystemMessage()
```
    An AI-generated message in a conversation.
    
    Returns:
    
    An AI-generated message in a conversation.
  - withSystemMessage
```
public ChatSyncResult withSystemMessage(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.
  - setSystemMessageId
```
public void setSystemMessageId(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.
  - getSystemMessageId
```
public String getSystemMessageId()
```
    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.
  - withSystemMessageId
```
public ChatSyncResult withSystemMessageId(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.
  - setUserMessageId
```
public void setUserMessageId(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.
  - getUserMessageId
```
public String getUserMessageId()
```
    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.
  - withUserMessageId
```
public ChatSyncResult withUserMessageId(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.
  - setActionReview
```
public void setActionReview(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.
  - getActionReview
```
public ActionReview getActionReview()
```
    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.
  - withActionReview
```
public ChatSyncResult withActionReview(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.
  - setAuthChallengeRequest
```
public void setAuthChallengeRequest(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.
  - getAuthChallengeRequest
```
public AuthChallengeRequest getAuthChallengeRequest()
```
    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.
  - withAuthChallengeRequest
```
public ChatSyncResult withAuthChallengeRequest(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.
  - getSourceAttributions
```
public List<SourceAttribution> getSourceAttributions()
```
    The source documents used to generate the conversation response.
    
    Returns:
    
    The source documents used to generate the conversation response.
  - setSourceAttributions
```
public void setSourceAttributions(Collection<SourceAttribution> sourceAttributions)
```
    The source documents used to generate the conversation response.
    
    Parameters:
    
    sourceAttributions - The source documents used to generate the conversation response.
  - withSourceAttributions
```
public ChatSyncResult withSourceAttributions(SourceAttribution... sourceAttributions)
```
    The source documents used to generate the conversation response.
    
    NOTE: This method appends the values to the existing list (if any). Use setSourceAttributions(java.util.Collection) or withSourceAttributions(java.util.Collection) if you want to override the existing values.
    
    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.
  - withSourceAttributions
```
public ChatSyncResult withSourceAttributions(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.
  - getFailedAttachments
```
public List<AttachmentOutput> getFailedAttachments()
```
    A list of files which failed to upload during chat.
    
    Returns:
    
    A list of files which failed to upload during chat.
  - setFailedAttachments
```
public void setFailedAttachments(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.
  - withFailedAttachments
```
public ChatSyncResult withFailedAttachments(AttachmentOutput... failedAttachments)
```
    A list of files which failed to upload during chat.
    
    NOTE: This method appends the values to the existing list (if any). Use setFailedAttachments(java.util.Collection) or withFailedAttachments(java.util.Collection) if you want to override the existing values.
    
    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.
  - withFailedAttachments
```
public ChatSyncResult withFailedAttachments(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.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public ChatSyncResult clone()
```
    Overrides:
    
    clone in class Object

AWS SDK for Java 1.x API Reference - 1.12.780

Class ChatSyncResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

ChatSyncResult

Method Detail

setConversationId

getConversationId

withConversationId

setSystemMessage

getSystemMessage

withSystemMessage

setSystemMessageId

getSystemMessageId

withSystemMessageId

setUserMessageId

getUserMessageId

withUserMessageId

setActionReview

getActionReview

withActionReview

setAuthChallengeRequest

getAuthChallengeRequest

withAuthChallengeRequest

getSourceAttributions

setSourceAttributions

withSourceAttributions

withSourceAttributions

getFailedAttachments

setFailedAttachments

withFailedAttachments

withFailedAttachments

toString

equals

hashCode

clone