java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.qbusiness.model.QBusinessRequest
    - - software.amazon.awssdk.services.qbusiness.model.ChatSyncRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<ChatSyncRequest.Builder,ChatSyncRequest>

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

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface ChatSyncRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`ActionExecution`	`actionExecution()`	A request from an end user to perform an Amazon Q plugin action.
`String`	`applicationId()`	The identifier of the Amazon Q application linked to the Amazon Q conversation.
`List<AttachmentInput>`	`attachments()`	A list of files uploaded directly during chat.
`AttributeFilter`	`attributeFilter()`	Enables filtering of Amazon Q web experience responses based on document attributes or metadata fields.
`static ChatSyncRequest.Builder`	`builder()`
`String`	`clientToken()`	A token that you provide to identify a chat request.
`String`	`conversationId()`	The identifier of the Amazon Q conversation.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAttachments()`	For responses, this returns true if the service returned a value for the Attachments property.
`int`	`hashCode()`
`boolean`	`hasUserGroups()`	For responses, this returns true if the service returned a value for the UserGroups property.
`String`	`parentMessageId()`	The identifier of the previous end user text input message in a conversation.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ChatSyncRequest.Builder>`	`serializableBuilderClass()`
`ChatSyncRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`List<String>`	`userGroups()`	The groups that a user associated with the chat input belongs to.
`String`	`userId()`	The identifier of the user attached to the chat input.
`String`	`userMessage()`	A end user message in a conversation.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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
  - actionExecution
```
public final ActionExecution actionExecution()
```
    A request from an end user to perform an Amazon Q plugin action.
    
    Returns:
    
    A request from an end user to perform an Amazon Q plugin action.
  - applicationId
```
public final String applicationId()
```
    The identifier of the Amazon Q application linked to the Amazon Q conversation.
    
    Returns:
    
    The identifier of the Amazon Q application linked to the Amazon Q conversation.
  - hasAttachments
```
public final boolean hasAttachments()
```
    For responses, this returns true if the service returned a value for the Attachments 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.
  - attachments
```
public final List<AttachmentInput> attachments()
```
    A list of files uploaded directly during chat. You can upload a maximum of 5 files of upto 10 MB each.
    
    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 hasAttachments() method.
    
    Returns:
    
    A list of files uploaded directly during chat. You can upload a maximum of 5 files of upto 10 MB each.
  - attributeFilter
```
public final AttributeFilter attributeFilter()
```
    Enables filtering of Amazon Q web experience responses based on document attributes or metadata fields.
    
    Returns:
    
    Enables filtering of Amazon Q web experience responses based on document attributes or metadata fields.
  - clientToken
```
public final String clientToken()
```
    A token that you provide to identify a chat request.
    
    Returns:
    
    A token that you provide to identify a chat request.
  - conversationId
```
public final String conversationId()
```
    The identifier of the Amazon Q conversation.
    
    Returns:
    
    The identifier of the Amazon Q conversation.
  - parentMessageId
```
public final String parentMessageId()
```
    The identifier of the previous end user text input message in a conversation.
    
    Returns:
    
    The identifier of the previous end user text input message in a conversation.
  - hasUserGroups
```
public final boolean hasUserGroups()
```
    For responses, this returns true if the service returned a value for the UserGroups 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.
  - userGroups
```
public final List<String> userGroups()
```
    The groups that a user associated with the chat input belongs to.
    
    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 hasUserGroups() method.
    
    Returns:
    
    The groups that a user associated with the chat input belongs to.
  - userId
```
public final String userId()
```
    The identifier of the user attached to the chat input.
    
    Returns:
    
    The identifier of the user attached to the chat input.
  - userMessage
```
public final String userMessage()
```
    A end user message in a conversation.
    
    Returns:
    
    A end user message in a conversation.
  - toBuilder
```
public ChatSyncRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ChatSyncRequest.Builder,ChatSyncRequest>
    
    Specified by:
    
    toBuilder in class QBusinessRequest
  - builder
```
public static ChatSyncRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ChatSyncRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - 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 SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class ChatSyncRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

actionExecution

applicationId

hasAttachments

attachments

attributeFilter

clientToken

conversationId

parentMessageId

hasUserGroups

userGroups

userId

userMessage

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields