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

Interface PutSessionRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<PutSessionRequest.Builder,PutSessionRequest>, LexRuntimeV2Request.Builder, SdkBuilder<PutSessionRequest.Builder,PutSessionRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
PutSessionRequest
public static interface PutSessionRequest.Builder extends LexRuntimeV2Request.Builder, SdkPojo, CopyableBuilder<PutSessionRequest.Builder,PutSessionRequest>

  • Method Details

    • botId

      PutSessionRequest.Builder botId(String botId)

      The identifier of the bot that receives the session data.

      Parameters:
      botId - The identifier of the bot that receives the session data.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • botAliasId

      PutSessionRequest.Builder botAliasId(String botAliasId)

      The alias identifier of the bot that receives the session data.

      Parameters:
      botAliasId - The alias identifier of the bot that receives the session data.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • localeId

      PutSessionRequest.Builder localeId(String localeId)

      The locale where the session is in use.

      Parameters:
      localeId - The locale where the session is in use.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sessionId

      PutSessionRequest.Builder sessionId(String sessionId)

      The identifier of the session that receives the session data.

      Parameters:
      sessionId - The identifier of the session that receives the session data.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • messages

      PutSessionRequest.Builder messages(Collection<Message> messages)

      A list of messages to send to the user. Messages are sent in the order that they are defined in the list.

      Parameters:
      messages - A list of messages to send to the user. Messages are sent in the order that they are defined in the list.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • messages

      PutSessionRequest.Builder messages(Message... messages)

      A list of messages to send to the user. Messages are sent in the order that they are defined in the list.

      Parameters:
      messages - A list of messages to send to the user. Messages are sent in the order that they are defined in the list.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • messages

      PutSessionRequest.Builder messages(Consumer<Message.Builder>... messages)

      A list of messages to send to the user. Messages are sent in the order that they are defined in the list.

      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 messages(List<Message>).

      Parameters:
      messages - 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:

    • sessionState

      PutSessionRequest.Builder sessionState(SessionState sessionState)

      Sets the state of the session with the user. You can use this to set the current intent, attributes, context, and dialog action. Use the dialog action to determine the next step that Amazon Lex V2 should use in the conversation with the user.

      Parameters:
      sessionState - Sets the state of the session with the user. You can use this to set the current intent, attributes, context, and dialog action. Use the dialog action to determine the next step that Amazon Lex V2 should use in the conversation with the user.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sessionState

      default PutSessionRequest.Builder sessionState(Consumer<SessionState.Builder> sessionState)

      Sets the state of the session with the user. You can use this to set the current intent, attributes, context, and dialog action. Use the dialog action to determine the next step that Amazon Lex V2 should use in the conversation with the user.

      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:

    • requestAttributes

      PutSessionRequest.Builder requestAttributes(Map<String,String> requestAttributes)

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

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

      Parameters:
      requestAttributes - Request-specific information passed between Amazon Lex V2 and the client application.

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

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

    • responseContentType

      PutSessionRequest.Builder responseContentType(String responseContentType)

      The message that Amazon Lex V2 returns in the response can be either text or speech depending on the value of this parameter.

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

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

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

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

    • overrideConfiguration

      PutSessionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      PutSessionRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.