Package software.amazon.awssdk.services.lexmodelsv2.model

Class StartBotRecommendationResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.lexmodelsv2.model.LexModelsV2Response

software.amazon.awssdk.services.lexmodelsv2.model.StartBotRecommendationResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<StartBotRecommendationResponse.Builder,StartBotRecommendationResponse>

@Generated("software.amazon.awssdk:codegen")
public final class StartBotRecommendationResponse
extends LexModelsV2Response
implements ToCopyableBuilder<StartBotRecommendationResponse.Builder,StartBotRecommendationResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StartBotRecommendationResponse.Builder

Method Summary

Modifier and Type	Method	Description
String	botId()	The unique identifier of the bot containing the bot recommendation.
String	botRecommendationId()	The identifier of the bot recommendation that you have created.
BotRecommendationStatus	botRecommendationStatus()	The status of the bot recommendation.
String	botRecommendationStatusAsString()	The status of the bot recommendation.
String	botVersion()	The version of the bot containing the bot recommendation.
static StartBotRecommendationResponse.Builder	builder()
Instant	creationDateTime()	A timestamp of the date and time that the bot recommendation was created.
EncryptionSetting	encryptionSetting()	The object representing the passwords that were used to encrypt the data related to the bot recommendation results, as well as the KMS key ARN used to encrypt the associated metadata.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	localeId()	The identifier of the language and locale of the bot recommendation to start.
List<SdkField<?>>	sdkFields()
static Class<? extends StartBotRecommendationResponse.Builder>	serializableBuilderClass()
StartBotRecommendationResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
TranscriptSourceSetting	transcriptSourceSetting()	The object representing the Amazon S3 bucket containing the transcript, as well as the associated metadata.

Methods inherited from class software.amazon.awssdk.services.lexmodelsv2.model.LexModelsV2Response

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

botId

public final String botId()

The unique identifier of the bot containing the bot recommendation.

Returns:

The unique identifier of the bot containing the bot recommendation.

botVersion

public final String botVersion()

The version of the bot containing the bot recommendation.

Returns:

The version of the bot containing the bot recommendation.

localeId

public final String localeId()

The identifier of the language and locale of the bot recommendation to start. The string must match one of the supported locales. For more information, see Supported languages

Returns:

The identifier of the language and locale of the bot recommendation to start. The string must match one of the supported locales. For more information, see Supported languages

botRecommendationStatus

public final BotRecommendationStatus botRecommendationStatus()

The status of the bot recommendation.

If the status is Failed, then the reasons for the failure are listed in the failureReasons field.

If the service returns an enum value that is not available in the current SDK version, botRecommendationStatus will return BotRecommendationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from botRecommendationStatusAsString().

Returns:

The status of the bot recommendation.

If the status is Failed, then the reasons for the failure are listed in the failureReasons field.

See Also:

BotRecommendationStatus

botRecommendationStatusAsString

public final String botRecommendationStatusAsString()

The status of the bot recommendation.

If the status is Failed, then the reasons for the failure are listed in the failureReasons field.

If the service returns an enum value that is not available in the current SDK version, botRecommendationStatus will return BotRecommendationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from botRecommendationStatusAsString().

Returns:

The status of the bot recommendation.

If the status is Failed, then the reasons for the failure are listed in the failureReasons field.

See Also:

BotRecommendationStatus

botRecommendationId

public final String botRecommendationId()

The identifier of the bot recommendation that you have created.

Returns:

The identifier of the bot recommendation that you have created.

creationDateTime

public final Instant creationDateTime()

A timestamp of the date and time that the bot recommendation was created.

Returns:

A timestamp of the date and time that the bot recommendation was created.

transcriptSourceSetting

public final TranscriptSourceSetting transcriptSourceSetting()

The object representing the Amazon S3 bucket containing the transcript, as well as the associated metadata.

Returns:

The object representing the Amazon S3 bucket containing the transcript, as well as the associated metadata.

encryptionSetting

public final EncryptionSetting encryptionSetting()

The object representing the passwords that were used to encrypt the data related to the bot recommendation results, as well as the KMS key ARN used to encrypt the associated metadata.

Returns:

The object representing the passwords that were used to encrypt the data related to the bot recommendation results, as well as the KMS key ARN used to encrypt the associated metadata.

toBuilder

public StartBotRecommendationResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StartBotRecommendationResponse.Builder,StartBotRecommendationResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static StartBotRecommendationResponse.Builder builder()

serializableBuilderClass

public static Class<? extends StartBotRecommendationResponse.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