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

Class RecognizeTextRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<RecognizeTextRequest.Builder,RecognizeTextRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RecognizeTextRequest.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 that processes the request.
static RecognizeTextRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasRequestAttributes()	For responses, this returns true if the service returned a value for the RequestAttributes property.
String	localeId()	The locale where the session is in use.
Map<String,String>	requestAttributes()	Request-specific information passed between the client application and Amazon Lex V2
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends RecognizeTextRequest.Builder>	serializableBuilderClass()
String	sessionId()	The identifier of the user session that is having the conversation.
SessionState	sessionState()	The current state of the dialog between the user and the bot.
String	text()	The text that the user entered.
RecognizeTextRequest.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 that processes the request.

Returns:

The identifier of the bot that processes 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.

text

public final String text()

The text that the user entered. Amazon Lex V2 interprets this text.

Returns:

The text that the user entered. Amazon Lex V2 interprets this text.

sessionState

public final SessionState sessionState()

The current state of the dialog between the user and the bot.

Returns:

The current state of the dialog between the user and the bot.

hasRequestAttributes

public final boolean hasRequestAttributes()

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

requestAttributes

public final Map<String,String> requestAttributes()

Request-specific information passed between the client application and Amazon Lex V2

The namespace x-amz-lex: is reserved for special attributes. Don't create any request attributes with the prefix x-amz-lex:.

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

Returns:

Request-specific information passed between the client application and Amazon Lex V2

The namespace x-amz-lex: is reserved for special attributes. Don't create any request attributes with the prefix x-amz-lex:.

toBuilder

public RecognizeTextRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RecognizeTextRequest.Builder,RecognizeTextRequest>

Specified by:

toBuilder in class LexRuntimeV2Request

builder

public static RecognizeTextRequest.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

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

Specified by:

sdkFieldNameToField in interface SdkPojo