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>

  • Method Details

    • 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:

    • 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:

    • toBuilder

      public StartConversationRequest.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<StartConversationRequest.Builder,StartConversationRequest>
      Specified by:
      toBuilder in class LexRuntimeV2Request
      Returns:
      a builder for type T

    • 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)
      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.