public static interface GetBotResponse.Builder extends LexModelBuildingResponse.Builder, CopyableBuilder<GetBotResponse.Builder,GetBotResponse>
Modifier and Type | Method and Description |
---|---|
default GetBotResponse.Builder |
abortStatement(Consumer<Statement.Builder> abortStatement)
The message that Amazon Lex returns when the user elects to end the conversation without completing it.
|
GetBotResponse.Builder |
abortStatement(Statement abortStatement)
The message that Amazon Lex returns when the user elects to end the conversation without completing it.
|
GetBotResponse.Builder |
checksum(String checksum)
Checksum of the bot used to identify a specific revision of the bot's
$LATEST version. |
GetBotResponse.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. |
default GetBotResponse.Builder |
clarificationPrompt(Consumer<Prompt.Builder> clarificationPrompt)
The message Amazon Lex uses when it doesn't understand the user's request.
|
GetBotResponse.Builder |
clarificationPrompt(Prompt clarificationPrompt)
The message Amazon Lex uses when it doesn't understand the user's request.
|
GetBotResponse.Builder |
createdDate(Instant createdDate)
The date that the bot was created.
|
GetBotResponse.Builder |
description(String description)
A description of the bot.
|
GetBotResponse.Builder |
failureReason(String failureReason)
If
status is FAILED , Amazon Lex explains why it failed to build the bot. |
GetBotResponse.Builder |
idleSessionTTLInSeconds(Integer idleSessionTTLInSeconds)
The maximum time in seconds that Amazon Lex retains the data gathered in a conversation.
|
GetBotResponse.Builder |
intents(Collection<Intent> intents)
An array of
intent objects. |
GetBotResponse.Builder |
intents(Consumer<Intent.Builder>... intents)
An array of
intent objects. |
GetBotResponse.Builder |
intents(Intent... intents)
An array of
intent objects. |
GetBotResponse.Builder |
lastUpdatedDate(Instant lastUpdatedDate)
The date that the bot was updated.
|
GetBotResponse.Builder |
locale(Locale locale)
The target locale for the bot.
|
GetBotResponse.Builder |
locale(String locale)
The target locale for the bot.
|
GetBotResponse.Builder |
name(String name)
The name of the bot.
|
GetBotResponse.Builder |
status(Status status)
The status of the bot.
|
GetBotResponse.Builder |
status(String status)
The status of the bot.
|
GetBotResponse.Builder |
version(String version)
The version of the bot.
|
GetBotResponse.Builder |
voiceId(String voiceId)
The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user.
|
build
sdkHttpResponse, sdkHttpResponse
copy
applyMutation, build
GetBotResponse.Builder name(String name)
The name of the bot.
name
- The name of the bot.GetBotResponse.Builder description(String description)
A description of the bot.
description
- A description of the bot.GetBotResponse.Builder intents(Collection<Intent> intents)
An array of intent
objects. For more information, see PutBot.
intents
- An array of intent
objects. For more information, see PutBot.GetBotResponse.Builder intents(Intent... intents)
An array of intent
objects. For more information, see PutBot.
intents
- An array of intent
objects. For more information, see PutBot.GetBotResponse.Builder intents(Consumer<Intent.Builder>... intents)
An array of intent
objects. For more information, see PutBot.
List.Builder
avoiding the need to
create one manually via List#builder()
.
When the Consumer
completes, List.Builder#build()
is called immediately and its
result is passed to #intents(List)
.intents
- a consumer that will call methods on List.Builder
#intents(List)
GetBotResponse.Builder clarificationPrompt(Prompt clarificationPrompt)
The message Amazon Lex uses when it doesn't understand the user's request. For more information, see PutBot.
clarificationPrompt
- The message Amazon Lex uses when it doesn't understand the user's request. For more information, see
PutBot.default GetBotResponse.Builder clarificationPrompt(Consumer<Prompt.Builder> clarificationPrompt)
The message Amazon Lex uses when it doesn't understand the user's request. For more information, see PutBot.
This is a convenience that creates an instance of thePrompt.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)
.clarificationPrompt
- a consumer that will call methods on Prompt.Builder
clarificationPrompt(Prompt)
GetBotResponse.Builder abortStatement(Statement abortStatement)
The message that Amazon Lex returns when the user elects to end the conversation without completing it. For more information, see PutBot.
abortStatement
- The message that Amazon Lex returns when the user elects to end the conversation without completing
it. For more information, see PutBot.default GetBotResponse.Builder abortStatement(Consumer<Statement.Builder> abortStatement)
The message that Amazon Lex returns when the user elects to end the conversation without completing it. For more information, see PutBot.
This is a convenience that creates an instance of theStatement.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)
.abortStatement
- a consumer that will call methods on Statement.Builder
abortStatement(Statement)
GetBotResponse.Builder status(String status)
The status of the bot. If the bot is ready to run, the status is READY
. If there was a problem
with building the bot, the status is FAILED
and the failureReason
explains why the
bot did not build. If the bot was saved but not built, the status is NOT BUILT
.
status
- The status of the bot. If the bot is ready to run, the status is READY
. If there was a
problem with building the bot, the status is FAILED
and the failureReason
explains why the bot did not build. If the bot was saved but not built, the status is
NOT BUILT
.Status
,
Status
GetBotResponse.Builder status(Status status)
The status of the bot. If the bot is ready to run, the status is READY
. If there was a problem
with building the bot, the status is FAILED
and the failureReason
explains why the
bot did not build. If the bot was saved but not built, the status is NOT BUILT
.
status
- The status of the bot. If the bot is ready to run, the status is READY
. If there was a
problem with building the bot, the status is FAILED
and the failureReason
explains why the bot did not build. If the bot was saved but not built, the status is
NOT BUILT
.Status
,
Status
GetBotResponse.Builder failureReason(String failureReason)
If status
is FAILED
, Amazon Lex explains why it failed to build the bot.
failureReason
- If status
is FAILED
, Amazon Lex explains why it failed to build the bot.GetBotResponse.Builder lastUpdatedDate(Instant lastUpdatedDate)
The date that the bot was updated. When you create a resource, the creation date and last updated date are the same.
lastUpdatedDate
- The date that the bot was updated. When you create a resource, the creation date and last updated date
are the same.GetBotResponse.Builder createdDate(Instant createdDate)
The date that the bot was created.
createdDate
- The date that the bot was created.GetBotResponse.Builder idleSessionTTLInSeconds(Integer idleSessionTTLInSeconds)
The maximum time in seconds that Amazon Lex retains the data gathered in a conversation. For more information, see PutBot.
idleSessionTTLInSeconds
- The maximum time in seconds that Amazon Lex retains the data gathered in a conversation. For more
information, see PutBot.GetBotResponse.Builder voiceId(String voiceId)
The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user. For more information, see PutBot.
voiceId
- The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user. For more
information, see PutBot.GetBotResponse.Builder checksum(String checksum)
Checksum of the bot used to identify a specific revision of the bot's $LATEST
version.
checksum
- Checksum of the bot used to identify a specific revision of the bot's $LATEST
version.GetBotResponse.Builder version(String version)
The version of the bot. For a new bot, the version is always $LATEST
.
version
- The version of the bot. For a new bot, the version is always $LATEST
.GetBotResponse.Builder locale(String locale)
The target locale for the bot.
GetBotResponse.Builder locale(Locale locale)
The target locale for the bot.
GetBotResponse.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.
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.
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.