software.amazon.awssdk.services.lexmodelbuilding.model

Class CreateBotVersionResponse

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.CreateBotVersionResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateBotVersionResponse.Builder,CreateBotVersionResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateBotVersionResponse.Builder

Method Summary

Modifier and Type	Method and Description
Statement	abortStatement() The message that Amazon Lex uses to cancel a conversation.
static CreateBotVersionResponse.Builder	builder()
String	checksum() Checksum identifying the version of the bot that was created.
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 that Amazon Lex uses when it doesn't understand the user's request.
Instant	createdDate() The date when the bot version was created.
String	description() A description of the bot.
Boolean	detectSentiment() Indicates whether utterances entered by the user should be sent to Amazon Comprehend for sentiment analysis.
Boolean	enableModelImprovements() Indicates whether the bot uses accuracy improvements.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	failureReason() If status is FAILED, Amazon Lex provides the reason that it failed to build the bot.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasIntents() Returns true if the Intents property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
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 when the $LATEST version of this bot was updated.
Locale	locale() Specifies the target locale for the bot.
String	localeAsString() Specifies the target locale for the bot.
String	name() The name of the bot.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateBotVersionResponse.Builder>	serializableBuilderClass()
Status	status() When you send a request to create or update a bot, Amazon Lex sets the status response element to BUILDING.
String	statusAsString() When you send a request to create or update a bot, Amazon Lex sets the status response element to BUILDING.
CreateBotVersionResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	version() The version of the bot.
String	voiceId() The Amazon Polly voice ID that Amazon Lex uses for voice interactions with the user.

Methods inherited from class software.amazon.awssdk.services.lexmodelbuilding.model.LexModelBuildingResponse

responseMetadata

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

sdkHttpResponse

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

name

public final String name()

The name of the bot.

Returns:

The name of the bot.

description

public final String description()

A description of the bot.

Returns:

A description of the bot.

hasIntents

public final boolean hasIntents()

Returns true if the Intents property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

intents

public final 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.

You can use hasIntents() to see if a value was sent in this field.

Returns:

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

clarificationPrompt

public final Prompt clarificationPrompt()

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

Returns:

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

abortStatement

public final Statement abortStatement()

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

Returns:

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

status

public final 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.

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:

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.

See Also:

Status

statusAsString

public final String statusAsString()

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.

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:

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.

See Also:

Status

failureReason

public final String failureReason()

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

Returns:

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

lastUpdatedDate

public final Instant lastUpdatedDate()

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

Returns:

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

createdDate

public final Instant createdDate()

The date when the bot version was created.

Returns:

The date when the bot version was created.

idleSessionTTLInSeconds

public final 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 final String voiceId()

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

Returns:

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

checksum

public final String checksum()

Checksum identifying the version of the bot that was created.

Returns:

Checksum identifying the version of the bot that was created.

version

public final String version()

The version of the bot.

Returns:

The version of the bot.

locale

public final Locale locale()

Specifies 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:

Specifies the target locale for the bot.

See Also:

Locale

localeAsString

public final String localeAsString()

Specifies 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:

Specifies the target locale for the bot.

See Also:

Locale

childDirected

public final 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.

enableModelImprovements

public final Boolean enableModelImprovements()

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

Returns:

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

detectSentiment

public final Boolean detectSentiment()

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

Returns:

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

toBuilder

public CreateBotVersionResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateBotVersionResponse.Builder,CreateBotVersionResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static CreateBotVersionResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

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

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo