Package software.amazon.awssdk.services.lexruntimev2.model

Class StartConversationRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.lexruntimev2.model.LexRuntimeV2Request

software.amazon.awssdk.services.lexruntimev2.model.StartConversationRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<StartConversationRequest.Builder,StartConversationRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StartConversationRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	botAliasId()	The alias identifier in use for the bot that processes the request.
String	botId()	The identifier of the bot to process the request.
static StartConversationRequest.Builder	builder()
ConversationMode	conversationMode()	The conversation type that you are using the Amazon Lex V2.
String	conversationModeAsString()	The conversation type that you are using the Amazon Lex V2.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	localeId()	The locale where the session is in use.
List<SdkField<?>>	sdkFields()
static Class<? extends StartConversationRequest.Builder>	serializableBuilderClass()
String	sessionId()	The identifier of the user session that is having the conversation.
StartConversationRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

botId

public final String botId()

The identifier of the bot to process the request.

Returns:

The identifier of the bot to process the request.

botAliasId

public final String botAliasId()

The alias identifier in use for the bot that processes the request.

Returns:

The alias identifier in use for the bot that processes the request.

localeId

public final String localeId()

The locale where the session is in use.

Returns:

The locale where the session is in use.

sessionId

public final String sessionId()

The identifier of the user session that is having the conversation.

Returns:

The identifier of the user session that is having the conversation.

conversationMode

public final ConversationMode conversationMode()

The conversation type that you are using the Amazon Lex V2. If the conversation mode is AUDIO you can send both audio and DTMF information. If the mode is TEXT you can only send text.

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

Returns:

The conversation type that you are using the Amazon Lex V2. If the conversation mode is AUDIO you can send both audio and DTMF information. If the mode is TEXT you can only send text.

See Also:

ConversationMode

conversationModeAsString

public final String conversationModeAsString()

The conversation type that you are using the Amazon Lex V2. If the conversation mode is AUDIO you can send both audio and DTMF information. If the mode is TEXT you can only send text.

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

Returns:

The conversation type that you are using the Amazon Lex V2. If the conversation mode is AUDIO you can send both audio and DTMF information. If the mode is TEXT you can only send text.

See Also:

ConversationMode

toBuilder

public StartConversationRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StartConversationRequest.Builder,StartConversationRequest>

Specified by:

toBuilder in class LexRuntimeV2Request

builder

public static StartConversationRequest.Builder builder()

serializableBuilderClass

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