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>

  • Method Details

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<RecognizeTextRequest.Builder,RecognizeTextRequest>
      Specified by:
      toBuilder in class LexRuntimeV2Request
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.