@Generated(value="software.amazon.awssdk:codegen") public class GetBotResponse extends LexModelBuildingResponse implements ToCopyableBuilder<GetBotResponse.Builder,GetBotResponse>
Modifier and Type | Class and Description |
---|---|
static interface |
GetBotResponse.Builder |
Modifier and Type | Method and Description |
---|---|
Statement |
abortStatement()
The message that Amazon Lex returns when the user elects to end the conversation without completing it.
|
static GetBotResponse.Builder |
builder() |
String |
checksum()
Checksum of the bot used to identify a specific revision of the bot's
$LATEST version. |
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. |
Prompt |
clarificationPrompt()
The message Amazon Lex uses when it doesn't understand the user's request.
|
Instant |
createdDate()
The date that the bot was created.
|
String |
description()
A description of the bot.
|
boolean |
equals(Object obj) |
String |
failureReason()
If
status is FAILED , Amazon Lex explains why it failed to build the bot. |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkResponse . |
int |
hashCode() |
Integer |
idleSessionTTLInSeconds()
The maximum time in seconds that Amazon Lex retains the data gathered in a conversation.
|
List<Intent> |
intents()
An array of
intent objects. |
Instant |
lastUpdatedDate()
The date that the bot was updated.
|
Locale |
locale()
The target locale for the bot.
|
String |
localeString()
The target locale for the bot.
|
String |
name()
The name of the bot.
|
static Class<? extends GetBotResponse.Builder> |
serializableBuilderClass() |
Status |
status()
The status of the bot.
|
String |
statusString()
The status of the bot.
|
GetBotResponse.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
String |
version()
The version of the bot.
|
String |
voiceId()
The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user.
|
copy
public String name()
The name of the bot.
public String description()
A description of the bot.
public List<Intent> intents()
An array of intent
objects. For more information, see PutBot.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
intent
objects. For more information, see PutBot.public Prompt clarificationPrompt()
The message Amazon Lex uses when it doesn't understand the user's request. For more information, see PutBot.
public Statement abortStatement()
The message that Amazon Lex returns when the user elects to end the conversation without completing it. For more information, see PutBot.
public 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
.
If the service returns an enum value that is not available in the current SDK version, status
will
return Status.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
statusString()
.
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
public String statusString()
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
.
If the service returns an enum value that is not available in the current SDK version, status
will
return Status.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
statusString()
.
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
public String failureReason()
If status
is FAILED
, Amazon Lex explains why it failed to build the bot.
status
is FAILED
, Amazon Lex explains why it failed to build the bot.public Instant lastUpdatedDate()
The date that the bot was updated. When you create a resource, the creation date and last updated date are the same.
public Instant createdDate()
The date that the bot was created.
public Integer idleSessionTTLInSeconds()
The maximum time in seconds that Amazon Lex retains the data gathered in a conversation. For more information, see PutBot.
public String voiceId()
The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user. For more information, see PutBot.
public String checksum()
Checksum of the bot used to identify a specific revision of the bot's $LATEST
version.
$LATEST
version.public String version()
The version of the bot. For a new bot, the version is always $LATEST
.
$LATEST
.public Locale locale()
The target locale for the bot.
If the service returns an enum value that is not available in the current SDK version, locale
will
return Locale.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
localeString()
.
Locale
public String localeString()
The target locale for the bot.
If the service returns an enum value that is not available in the current SDK version, locale
will
return Locale.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
localeString()
.
Locale
public 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.
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.
public GetBotResponse.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<GetBotResponse.Builder,GetBotResponse>
toBuilder
in class AwsResponse
public static GetBotResponse.Builder builder()
public static Class<? extends GetBotResponse.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkResponse
SdkResponse
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkResponse
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.