Package software.amazon.awssdk.services.qconnect.model

Class GetNextMessageResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.qconnect.model.QConnectResponse

software.amazon.awssdk.services.qconnect.model.GetNextMessageResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetNextMessageResponse.Builder,GetNextMessageResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetNextMessageResponse.Builder

Method Summary

Modifier and Type	Method	Description
static GetNextMessageResponse.Builder	builder()
List<RuntimeSessionData>	conversationSessionData()	The conversation data stored on an Amazon Q in Connect Session.
ConversationState	conversationState()	The state of current conversation.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasConversationSessionData()	For responses, this returns true if the service returned a value for the ConversationSessionData property.
int	hashCode()
String	nextMessageToken()	The token for the next message.
String	requestMessageId()	The identifier of the submitted message.
MessageOutput	response()	The message response to the requested message.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends GetNextMessageResponse.Builder>	serializableBuilderClass()
GetNextMessageResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
MessageType	type()	The type of message response.
String	typeAsString()	The type of message response.

Methods inherited from class software.amazon.awssdk.services.qconnect.model.QConnectResponse

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

hasConversationSessionData

public final boolean hasConversationSessionData()

For responses, this returns true if the service returned a value for the ConversationSessionData 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.

conversationSessionData

public final List<RuntimeSessionData> conversationSessionData()

The conversation data stored on an Amazon Q in Connect Session.

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 hasConversationSessionData() method.

Returns:

The conversation data stored on an Amazon Q in Connect Session.

conversationState

public final ConversationState conversationState()

The state of current conversation.

Returns:

The state of current conversation.

nextMessageToken

public final String nextMessageToken()

The token for the next message.

Returns:

The token for the next message.

requestMessageId

public final String requestMessageId()

The identifier of the submitted message.

Returns:

The identifier of the submitted message.

response

public final MessageOutput response()

The message response to the requested message.

Returns:

The message response to the requested message.

type

public final MessageType type()

The type of message response.

If the service returns an enum value that is not available in the current SDK version, type will return MessageType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The type of message response.

See Also:

MessageType

typeAsString

public final String typeAsString()

The type of message response.

If the service returns an enum value that is not available in the current SDK version, type will return MessageType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The type of message response.

See Also:

MessageType

toBuilder

public GetNextMessageResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetNextMessageResponse.Builder,GetNextMessageResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static GetNextMessageResponse.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo