Package software.amazon.awssdk.services.lexruntime.model

Class PostContentRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.lexruntime.model.LexRuntimeRequest
software.amazon.awssdk.services.lexruntime.model.PostContentRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<PostContentRequest.Builder,PostContentRequest>
@Generated("software.amazon.awssdk:codegen") public final class PostContentRequest extends LexRuntimeRequest implements ToCopyableBuilder<PostContentRequest.Builder,PostContentRequest>

  • Method Details

    • botName

      public final String botName()

      Name of the Amazon Lex bot.

      Returns:
      Name of the Amazon Lex bot.

    • botAlias

      public final String botAlias()

      Alias of the Amazon Lex bot.

      Returns:
      Alias of the Amazon Lex bot.

    • userId

      public final String userId()

      The ID of the client application user. Amazon Lex uses this to identify a user's conversation with your bot. At runtime, each request must contain the userID field.

      To decide the user ID to use for your application, consider the following factors.

      • The userID field must not contain any personally identifiable information of the user, for example, name, personal identification numbers, or other end user personal information.

      • If you want a user to start a conversation on one device and continue on another device, use a user-specific identifier.

      • If you want the same user to be able to have two independent conversations on two different devices, choose a device-specific identifier.

      • A user can't have two independent conversations with two different versions of the same bot. For example, a user can't have a conversation with the PROD and BETA versions of the same bot. If you anticipate that a user will need to have conversation with two different versions, for example, while testing, include the bot alias in the user ID to separate the two conversations.

      Returns:
      The ID of the client application user. Amazon Lex uses this to identify a user's conversation with your bot. At runtime, each request must contain the userID field.

      To decide the user ID to use for your application, consider the following factors.

      • The userID field must not contain any personally identifiable information of the user, for example, name, personal identification numbers, or other end user personal information.

      • If you want a user to start a conversation on one device and continue on another device, use a user-specific identifier.

      • If you want the same user to be able to have two independent conversations on two different devices, choose a device-specific identifier.

      • A user can't have two independent conversations with two different versions of the same bot. For example, a user can't have a conversation with the PROD and BETA versions of the same bot. If you anticipate that a user will need to have conversation with two different versions, for example, while testing, include the bot alias in the user ID to separate the two conversations.

    • sessionAttributes

      public final String sessionAttributes()

      You pass this value as the x-amz-lex-session-attributes HTTP header.

      Application-specific information passed between Amazon Lex and a client application. The value must be a JSON serialized and base64 encoded map with string keys and values. The total size of the sessionAttributes and requestAttributes headers is limited to 12 KB.

      For more information, see Setting Session Attributes.

      Returns:
      You pass this value as the x-amz-lex-session-attributes HTTP header.

      Application-specific information passed between Amazon Lex and a client application. The value must be a JSON serialized and base64 encoded map with string keys and values. The total size of the sessionAttributes and requestAttributes headers is limited to 12 KB.

      For more information, see Setting Session Attributes.

    • requestAttributes

      public final String requestAttributes()

      You pass this value as the x-amz-lex-request-attributes HTTP header.

      Request-specific information passed between Amazon Lex and a client application. The value must be a JSON serialized and base64 encoded map with string keys and values. The total size of the requestAttributes and sessionAttributes headers is limited to 12 KB.

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

      For more information, see Setting Request Attributes.

      Returns:
      You pass this value as the x-amz-lex-request-attributes HTTP header.

      Request-specific information passed between Amazon Lex and a client application. The value must be a JSON serialized and base64 encoded map with string keys and values. The total size of the requestAttributes and sessionAttributes headers is limited to 12 KB.

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

      For more information, see Setting Request Attributes.

    • contentType

      public final String contentType()

      You pass this value as the Content-Type HTTP header.

      Indicates the audio format or text. The header value must start with one of the following prefixes:

      • PCM format, audio data must be in little-endian byte order.

        • audio/l16; rate=16000; channels=1

        • audio/x-l16; sample-rate=16000; channel-count=1

        • audio/lpcm; sample-rate=8000; sample-size-bits=16; channel-count=1; is-big-endian=false

      • Opus format

        • audio/x-cbr-opus-with-preamble; preamble-size=0; bit-rate=256000; frame-size-milliseconds=4

      • Text format

        • text/plain; charset=utf-8

      Returns:
      You pass this value as the Content-Type HTTP header.

      Indicates the audio format or text. The header value must start with one of the following prefixes:

      • PCM format, audio data must be in little-endian byte order.

        • audio/l16; rate=16000; channels=1

        • audio/x-l16; sample-rate=16000; channel-count=1

        • audio/lpcm; sample-rate=8000; sample-size-bits=16; channel-count=1; is-big-endian=false

      • Opus format

        • audio/x-cbr-opus-with-preamble; preamble-size=0; bit-rate=256000; frame-size-milliseconds=4

      • Text format

        • text/plain; charset=utf-8

    • accept

      public final String accept()

      You pass this value as the Accept HTTP header.

      The message Amazon Lex returns in the response can be either text or speech based on the Accept HTTP header value in the request.

      • If the value is text/plain; charset=utf-8, Amazon Lex returns text in the response.

      • If the value begins with audio/, Amazon Lex returns speech in the response. Amazon Lex uses Amazon Polly to generate the speech (using the configuration you specified in the Accept header). For example, if you specify audio/mpeg as the value, Amazon Lex returns speech in the MPEG format.

      • If the value is audio/pcm, the speech returned is audio/pcm in 16-bit, little endian format.

      • The following are the accepted values:

        • audio/mpeg

        • audio/ogg

        • audio/pcm

        • text/plain; charset=utf-8

        • audio/* (defaults to mpeg)

      Returns:
      You pass this value as the Accept HTTP header.

      The message Amazon Lex returns in the response can be either text or speech based on the Accept HTTP header value in the request.

      • If the value is text/plain; charset=utf-8, Amazon Lex returns text in the response.

      • If the value begins with audio/, Amazon Lex returns speech in the response. Amazon Lex uses Amazon Polly to generate the speech (using the configuration you specified in the Accept header). For example, if you specify audio/mpeg as the value, Amazon Lex returns speech in the MPEG format.

      • If the value is audio/pcm, the speech returned is audio/pcm in 16-bit, little endian format.

      • The following are the accepted values:

        • audio/mpeg

        • audio/ogg

        • audio/pcm

        • text/plain; charset=utf-8

        • audio/* (defaults to mpeg)

    • activeContexts

      public final String activeContexts()

      A list of contexts active for the request. A context can be activated when a previous intent is fulfilled, or by including the context in the request,

      If you don't specify a list of contexts, Amazon Lex will use the current list of contexts for the session. If you specify an empty list, all contexts for the session are cleared.

      Returns:
      A list of contexts active for the request. A context can be activated when a previous intent is fulfilled, or by including the context in the request,

      If you don't specify a list of contexts, Amazon Lex will use the current list of contexts for the session. If you specify an empty list, all contexts for the session are cleared.

    • toBuilder

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

    • builder

      public static PostContentRequest.Builder builder()

    • serializableBuilderClass

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