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

Interface ConfigurationEvent.Builder

All Superinterfaces:
Buildable, CopyableBuilder<ConfigurationEvent.Builder,ConfigurationEvent>, SdkBuilder<ConfigurationEvent.Builder,ConfigurationEvent>, SdkPojo
All Known Subinterfaces:
DefaultConfigurationEvent.Builder
Enclosing class:
ConfigurationEvent
public static interface ConfigurationEvent.Builder extends SdkPojo, CopyableBuilder<ConfigurationEvent.Builder,ConfigurationEvent>

  • Method Details

    • requestAttributes

      ConfigurationEvent.Builder requestAttributes(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 for prefix x-amz-lex:.

      Parameters:
      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 for prefix x-amz-lex:.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • responseContentType

      ConfigurationEvent.Builder responseContentType(String responseContentType)

      The message that Amazon Lex V2 returns in the response can be either text or speech based on the responseContentType value.

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

      • If the value begins with audio/, Amazon Lex V2 returns speech in the response. Amazon Lex V2 uses Amazon Polly to generate the speech using the configuration that you specified in the requestContentType parameter. For example, if you specify audio/mpeg as the value, Amazon Lex V2 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

        • audio/* (defaults to mpeg)

        • text/plain; charset=utf-8

      Parameters:
      responseContentType - The message that Amazon Lex V2 returns in the response can be either text or speech based on the responseContentType value.

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

      • If the value begins with audio/, Amazon Lex V2 returns speech in the response. Amazon Lex V2 uses Amazon Polly to generate the speech using the configuration that you specified in the requestContentType parameter. For example, if you specify audio/mpeg as the value, Amazon Lex V2 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

        • audio/* (defaults to mpeg)

        • text/plain; charset=utf-8

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sessionState

      ConfigurationEvent.Builder sessionState(SessionState sessionState)
      Sets the value of the SessionState property for this object.
      Parameters:
      sessionState - The new value for the SessionState property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sessionState

      default ConfigurationEvent.Builder sessionState(Consumer<SessionState.Builder> sessionState)
      Sets the value of the SessionState property for this object. This is a convenience method that creates an instance of the SessionState.Builder avoiding the need to create one manually via SessionState.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sessionState(SessionState).

      Parameters:
      sessionState - a consumer that will call methods on SessionState.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • welcomeMessages

      ConfigurationEvent.Builder welcomeMessages(Collection<Message> welcomeMessages)

      A list of messages to send to the user.

      If you set the welcomeMessage field, you must also set the DialogAction structure's type field.

      Parameters:
      welcomeMessages - A list of messages to send to the user.

      If you set the welcomeMessage field, you must also set the DialogAction structure's type field.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • welcomeMessages

      ConfigurationEvent.Builder welcomeMessages(Message... welcomeMessages)

      A list of messages to send to the user.

      If you set the welcomeMessage field, you must also set the DialogAction structure's type field.

      Parameters:
      welcomeMessages - A list of messages to send to the user.

      If you set the welcomeMessage field, you must also set the DialogAction structure's type field.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • welcomeMessages

      ConfigurationEvent.Builder welcomeMessages(Consumer<Message.Builder>... welcomeMessages)

      A list of messages to send to the user.

      If you set the welcomeMessage field, you must also set the DialogAction structure's type field.

      This is a convenience method that creates an instance of the Message.Builder avoiding the need to create one manually via Message.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to welcomeMessages(List<Message>).

      Parameters:
      welcomeMessages - a consumer that will call methods on Message.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • disablePlayback

      ConfigurationEvent.Builder disablePlayback(Boolean disablePlayback)

      Determines whether Amazon Lex V2 should send audio responses to the client application.

      Set this field to false when the client is operating in a playback mode where audio responses are played to the user. If the client isn't operating in playback mode, such as a text chat application, set this to true so that Amazon Lex V2 doesn't wait for the prompt to finish playing on the client.

      Parameters:
      disablePlayback - Determines whether Amazon Lex V2 should send audio responses to the client application.

      Set this field to false when the client is operating in a playback mode where audio responses are played to the user. If the client isn't operating in playback mode, such as a text chat application, set this to true so that Amazon Lex V2 doesn't wait for the prompt to finish playing on the client.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • eventId

      ConfigurationEvent.Builder eventId(String eventId)

      A unique identifier that your application assigns to the event. You can use this to identify events in logs.

      Parameters:
      eventId - A unique identifier that your application assigns to the event. You can use this to identify events in logs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientTimestampMillis

      ConfigurationEvent.Builder clientTimestampMillis(Long clientTimestampMillis)

      A timestamp set by the client of the date and time that the event was sent to Amazon Lex V2.

      Parameters:
      clientTimestampMillis - A timestamp set by the client of the date and time that the event was sent to Amazon Lex V2.
      Returns:
      Returns a reference to this object so that method calls can be chained together.