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

Class ChatRequest

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.ChatRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ChatRequest.Builder,ChatRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ChatRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	applicationId()	The identifier of the Amazon Q Business application linked to a streaming Amazon Q Business conversation.
static ChatRequest.Builder	builder()
String	clientToken()	A token that you provide to identify the chat input.
String	conversationId()	The identifier of the Amazon Q Business conversation.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasUserGroups()	For responses, this returns true if the service returned a value for the UserGroups property.
String	parentMessageId()	The identifier used to associate a user message with a AI generated response.
List<SdkField<?>>	sdkFields()
static Class<? extends ChatRequest.Builder>	serializableBuilderClass()
ChatRequest.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.

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

applicationId

public final String applicationId()

The identifier of the Amazon Q Business application linked to a streaming Amazon Q Business conversation.

Returns:

The identifier of the Amazon Q Business application linked to a streaming Amazon Q Business conversation.

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.

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.

conversationId

public final String conversationId()

The identifier of the Amazon Q Business conversation.

Returns:

The identifier of the Amazon Q Business conversation.

parentMessageId

public final String parentMessageId()

The identifier used to associate a user message with a AI generated response.

Returns:

The identifier used to associate a user message with a AI generated response.

clientToken

public final String clientToken()

A token that you provide to identify the chat input.

Returns:

A token that you provide to identify the chat input.

toBuilder

public ChatRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ChatRequest.Builder,ChatRequest>

Specified by:

toBuilder in class QBusinessRequest

builder

public static ChatRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ChatRequest.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