software.amazon.awssdk.services.lexmodelbuilding.model

Class GetBotResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.lexmodelbuilding.model.LexModelBuildingResponse

software.amazon.awssdk.services.lexmodelbuilding.model.GetBotResponse

All Implemented Interfaces:

ToCopyableBuilder<GetBotResponse.Builder,GetBotResponse>

@Generated(value="software.amazon.awssdk:codegen")
public class GetBotResponse
extends LexModelBuildingResponse
implements ToCopyableBuilder<GetBotResponse.Builder,GetBotResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetBotResponse.Builder

Method Summary

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	localeAsString() 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	statusAsString() 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.

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

name

public String name()

The name of the bot.

Returns:

The name of the bot.

description

public String description()

A description of the bot.

Returns:

A description of the bot.

intents

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.

Returns:

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

clarificationPrompt

public Prompt clarificationPrompt()

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

Returns:

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

abortStatement

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.

Returns:

The message that Amazon Lex returns when the user elects to end the conversation without completing it. For more information, see PutBot.

status

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 statusAsString().

Returns:

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.

See Also:

Status

statusAsString

public String statusAsString()

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 statusAsString().

Returns:

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.

See Also:

Status

failureReason

public String failureReason()

If status is FAILED, Amazon Lex explains why it failed to build the bot.

Returns:

If status is FAILED, Amazon Lex explains why it failed to build the bot.

lastUpdatedDate

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.

Returns:

The date that the bot was updated. When you create a resource, the creation date and last updated date are the same.

createdDate

public Instant createdDate()

The date that the bot was created.

Returns:

The date that the bot was created.

idleSessionTTLInSeconds

public Integer idleSessionTTLInSeconds()

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

Returns:

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

voiceId

public String voiceId()

The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user. For more information, see PutBot.

Returns:

The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user. For more information, see PutBot.

checksum

public String checksum()

Checksum of the bot used to identify a specific revision of the bot's $LATEST version.

Returns:

Checksum of the bot used to identify a specific revision of the bot's $LATEST version.

version

public String version()

The version of the bot. For a new bot, the version is always $LATEST.

Returns:

The version of the bot. For a new bot, the version is always $LATEST.

locale

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 localeAsString().

Returns:

The target locale for the bot.

See Also:

Locale

localeAsString

public String localeAsString()

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 localeAsString().

Returns:

The target locale for the bot.

See Also:

Locale

childDirected

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.

Returns:

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.

toBuilder

public GetBotResponse.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<GetBotResponse.Builder,GetBotResponse>

Specified by:

toBuilder in class AwsResponse

Returns:

a builder for type T

builder

public static GetBotResponse.Builder builder()

serializableBuilderClass

public static Class<? extends GetBotResponse.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkResponse

Used to retrieve the value of a field from any class that extends 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.

Overrides:

getValueForField in class SdkResponse

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value