Package software.amazon.awssdk.services.lexmodelbuilding.model

Interface CreateBotVersionResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CopyableBuilder<CreateBotVersionResponse.Builder,CreateBotVersionResponse>, LexModelBuildingResponse.Builder, SdkBuilder<CreateBotVersionResponse.Builder,CreateBotVersionResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
CreateBotVersionResponse
public static interface CreateBotVersionResponse.Builder extends LexModelBuildingResponse.Builder, SdkPojo, CopyableBuilder<CreateBotVersionResponse.Builder,CreateBotVersionResponse>

  • Method Details

    • name

      CreateBotVersionResponse.Builder name(String name)

      The name of the bot.

      Parameters:
      name - The name of the bot.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      CreateBotVersionResponse.Builder description(String description)

      A description of the bot.

      Parameters:
      description - A description of the bot.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • intents

      CreateBotVersionResponse.Builder intents(Collection<Intent> intents)

      An array of Intent objects. For more information, see PutBot.

      Parameters:
      intents - An array of Intent objects. For more information, see PutBot.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • intents

      CreateBotVersionResponse.Builder intents(Intent... intents)

      An array of Intent objects. For more information, see PutBot.

      Parameters:
      intents - An array of Intent objects. For more information, see PutBot.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • intents

      CreateBotVersionResponse.Builder intents(Consumer<Intent.Builder>... intents)

      An array of Intent objects. For more information, see PutBot.

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

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

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

    • clarificationPrompt

      CreateBotVersionResponse.Builder clarificationPrompt(Prompt clarificationPrompt)

      The message that Amazon Lex uses when it doesn't understand the user's request. For more information, see PutBot.

      Parameters:
      clarificationPrompt - The message that Amazon Lex uses when it doesn't understand the user's request. For more information, see PutBot.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clarificationPrompt

      default CreateBotVersionResponse.Builder clarificationPrompt(Consumer<Prompt.Builder> clarificationPrompt)

      The message that Amazon Lex uses when it doesn't understand the user's request. For more information, see PutBot.

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

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

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

    • abortStatement

      CreateBotVersionResponse.Builder abortStatement(Statement abortStatement)

      The message that Amazon Lex uses to cancel a conversation. For more information, see PutBot.

      Parameters:
      abortStatement - The message that Amazon Lex uses to cancel a conversation. For more information, see PutBot.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • abortStatement

      default CreateBotVersionResponse.Builder abortStatement(Consumer<Statement.Builder> abortStatement)

      The message that Amazon Lex uses to cancel a conversation. For more information, see PutBot.

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

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

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

    • status

      CreateBotVersionResponse.Builder status(String status)

      When you send a request to create or update a bot, Amazon Lex sets the status response element to BUILDING. After Amazon Lex builds the bot, it sets status to READY. If Amazon Lex can't build the bot, it sets status to FAILED. Amazon Lex returns the reason for the failure in the failureReason response element.

      Parameters:
      status - When you send a request to create or update a bot, Amazon Lex sets the status response element to BUILDING. After Amazon Lex builds the bot, it sets status to READY. If Amazon Lex can't build the bot, it sets status to FAILED. Amazon Lex returns the reason for the failure in the failureReason response element.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      CreateBotVersionResponse.Builder status(Status status)

      When you send a request to create or update a bot, Amazon Lex sets the status response element to BUILDING. After Amazon Lex builds the bot, it sets status to READY. If Amazon Lex can't build the bot, it sets status to FAILED. Amazon Lex returns the reason for the failure in the failureReason response element.

      Parameters:
      status - When you send a request to create or update a bot, Amazon Lex sets the status response element to BUILDING. After Amazon Lex builds the bot, it sets status to READY. If Amazon Lex can't build the bot, it sets status to FAILED. Amazon Lex returns the reason for the failure in the failureReason response element.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • failureReason

      CreateBotVersionResponse.Builder failureReason(String failureReason)

      If status is FAILED, Amazon Lex provides the reason that it failed to build the bot.

      Parameters:
      failureReason - If status is FAILED, Amazon Lex provides the reason that it failed to build the bot.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lastUpdatedDate

      CreateBotVersionResponse.Builder lastUpdatedDate(Instant lastUpdatedDate)

      The date when the $LATEST version of this bot was updated.

      Parameters:
      lastUpdatedDate - The date when the $LATEST version of this bot was updated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • createdDate

      CreateBotVersionResponse.Builder createdDate(Instant createdDate)

      The date when the bot version was created.

      Parameters:
      createdDate - The date when the bot version was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • idleSessionTTLInSeconds

      CreateBotVersionResponse.Builder idleSessionTTLInSeconds(Integer idleSessionTTLInSeconds)

      The maximum time in seconds that Amazon Lex retains the data gathered in a conversation. For more information, see PutBot.

      Parameters:
      idleSessionTTLInSeconds - The maximum time in seconds that Amazon Lex retains the data gathered in a conversation. For more information, see PutBot.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • voiceId

      CreateBotVersionResponse.Builder voiceId(String voiceId)

      The Amazon Polly voice ID that Amazon Lex uses for voice interactions with the user.

      Parameters:
      voiceId - The Amazon Polly voice ID that Amazon Lex uses for voice interactions with the user.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • checksum

      CreateBotVersionResponse.Builder checksum(String checksum)

      Checksum identifying the version of the bot that was created.

      Parameters:
      checksum - Checksum identifying the version of the bot that was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • version

      CreateBotVersionResponse.Builder version(String version)

      The version of the bot.

      Parameters:
      version - The version of the bot.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • locale

      CreateBotVersionResponse.Builder locale(String locale)

      Specifies the target locale for the bot.

      Parameters:
      locale - Specifies the target locale for the bot.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • locale

      CreateBotVersionResponse.Builder locale(Locale locale)

      Specifies the target locale for the bot.

      Parameters:
      locale - Specifies the target locale for the bot.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • childDirected

      CreateBotVersionResponse.Builder childDirected(Boolean childDirected)

      For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying true or false in the childDirected field. By specifying true in the childDirected field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying false in the childDirected field, you confirm that your use of Amazon Lex is not related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the childDirected field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA.

      If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ.

      Parameters:
      childDirected - For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying true or false in the childDirected field. By specifying true in the childDirected field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying false in the childDirected field, you confirm that your use of Amazon Lex is not related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the childDirected field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA.

      If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ.

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

    • enableModelImprovements

      CreateBotVersionResponse.Builder enableModelImprovements(Boolean enableModelImprovements)

      Indicates whether the bot uses accuracy improvements. true indicates that the bot is using the improvements, otherwise, false.

      Parameters:
      enableModelImprovements - Indicates whether the bot uses accuracy improvements. true indicates that the bot is using the improvements, otherwise, false.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • detectSentiment

      CreateBotVersionResponse.Builder detectSentiment(Boolean detectSentiment)

      Indicates whether utterances entered by the user should be sent to Amazon Comprehend for sentiment analysis.

      Parameters:
      detectSentiment - Indicates whether utterances entered by the user should be sent to Amazon Comprehend for sentiment analysis.
      Returns:
      Returns a reference to this object so that method calls can be chained together.