Interface PromptSpecification.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<PromptSpecification.Builder,
,PromptSpecification> SdkBuilder<PromptSpecification.Builder,
,PromptSpecification> SdkPojo
- Enclosing class:
PromptSpecification
-
Method Summary
Modifier and TypeMethodDescriptionallowInterrupt
(Boolean allowInterrupt) Indicates whether the user can interrupt a speech prompt from the bot.maxRetries
(Integer maxRetries) The maximum number of times the bot tries to elicit a response from the user using this prompt.messageGroups
(Collection<MessageGroup> messageGroups) A collection of messages that Amazon Lex can send to the user.messageGroups
(Consumer<MessageGroup.Builder>... messageGroups) A collection of messages that Amazon Lex can send to the user.messageGroups
(MessageGroup... messageGroups) A collection of messages that Amazon Lex can send to the user.messageSelectionStrategy
(String messageSelectionStrategy) Indicates how a message is selected from a message group among retries.messageSelectionStrategy
(MessageSelectionStrategy messageSelectionStrategy) Indicates how a message is selected from a message group among retries.promptAttemptsSpecification
(Map<PromptAttempt, PromptAttemptSpecification> promptAttemptsSpecification) Specifies the advanced settings on each attempt of the prompt.promptAttemptsSpecificationWithStrings
(Map<String, PromptAttemptSpecification> promptAttemptsSpecification) Specifies the advanced settings on each attempt of the prompt.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
messageGroups
A collection of messages that Amazon Lex can send to the user. Amazon Lex chooses the actual message to send at runtime.
- Parameters:
messageGroups
- A collection of messages that Amazon Lex can send to the user. Amazon Lex chooses the actual message to send at runtime.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
messageGroups
A collection of messages that Amazon Lex can send to the user. Amazon Lex chooses the actual message to send at runtime.
- Parameters:
messageGroups
- A collection of messages that Amazon Lex can send to the user. Amazon Lex chooses the actual message to send at runtime.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
messageGroups
A collection of messages that Amazon Lex can send to the user. Amazon Lex chooses the actual message to send at runtime.
This is a convenience method that creates an instance of theMessageGroup.Builder
avoiding the need to create one manually viaMessageGroup.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tomessageGroups(List<MessageGroup>)
.- Parameters:
messageGroups
- a consumer that will call methods onMessageGroup.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
maxRetries
The maximum number of times the bot tries to elicit a response from the user using this prompt.
- Parameters:
maxRetries
- The maximum number of times the bot tries to elicit a response from the user using this prompt.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
allowInterrupt
Indicates whether the user can interrupt a speech prompt from the bot.
- Parameters:
allowInterrupt
- Indicates whether the user can interrupt a speech prompt from the bot.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
messageSelectionStrategy
Indicates how a message is selected from a message group among retries.
- Parameters:
messageSelectionStrategy
- Indicates how a message is selected from a message group among retries.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
messageSelectionStrategy
PromptSpecification.Builder messageSelectionStrategy(MessageSelectionStrategy messageSelectionStrategy) Indicates how a message is selected from a message group among retries.
- Parameters:
messageSelectionStrategy
- Indicates how a message is selected from a message group among retries.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
promptAttemptsSpecificationWithStrings
PromptSpecification.Builder promptAttemptsSpecificationWithStrings(Map<String, PromptAttemptSpecification> promptAttemptsSpecification) Specifies the advanced settings on each attempt of the prompt.
- Parameters:
promptAttemptsSpecification
- Specifies the advanced settings on each attempt of the prompt.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
promptAttemptsSpecification
PromptSpecification.Builder promptAttemptsSpecification(Map<PromptAttempt, PromptAttemptSpecification> promptAttemptsSpecification) Specifies the advanced settings on each attempt of the prompt.
- Parameters:
promptAttemptsSpecification
- Specifies the advanced settings on each attempt of the prompt.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-