software.amazon.awssdk.services.lexmodelsv2.model

Class DescribeBotVersionResponse

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeBotVersionResponse.Builder,DescribeBotVersionResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeBotVersionResponse.Builder

Method Summary

Modifier and Type	Method and Description
String	botId() The identifier of the bot that contains the version.
String	botName() The name of the bot that contains the version.
BotStatus	botStatus() The current status of the bot.
String	botStatusAsString() The current status of the bot.
String	botVersion() The version of the bot to describe.
static DescribeBotVersionResponse.Builder	builder()
Instant	creationDateTime() A timestamp of the date and time that the bot version was created.
DataPrivacy	dataPrivacy() Data privacy settings for the bot version.
String	description() The description specified for the bot.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<String>	failureReasons() If the botStatus is Failed, this contains a list of reasons that the version couldn't be built.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFailureReasons() For responses, this returns true if the service returned a value for the FailureReasons property.
int	hashCode()
Integer	idleSessionTTLInSeconds() The number of seconds that a session with the bot remains active before it is discarded by Amazon Lex.
String	roleArn() The Amazon Resource Name (ARN) of an IAM role that has permission to access the bot version.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeBotVersionResponse.Builder>	serializableBuilderClass()
DescribeBotVersionResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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 identifier of the bot that contains the version.

Returns:

The identifier of the bot that contains the version.

botName

public final String botName()

The name of the bot that contains the version.

Returns:

The name of the bot that contains the version.

botVersion

public final String botVersion()

The version of the bot to describe.

Returns:

The version of the bot to describe.

description

public final String description()

The description specified for the bot.

Returns:

The description specified for the bot.

roleArn

public final String roleArn()

The Amazon Resource Name (ARN) of an IAM role that has permission to access the bot version.

Returns:

The Amazon Resource Name (ARN) of an IAM role that has permission to access the bot version.

dataPrivacy

public final DataPrivacy dataPrivacy()

Data privacy settings for the bot version.

Returns:

Data privacy settings for the bot version.

idleSessionTTLInSeconds

public final Integer idleSessionTTLInSeconds()

The number of seconds that a session with the bot remains active before it is discarded by Amazon Lex.

Returns:

The number of seconds that a session with the bot remains active before it is discarded by Amazon Lex.

botStatus

public final BotStatus botStatus()

The current status of the bot. When the status is Available, the bot version is ready for use.

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

Returns:

The current status of the bot. When the status is Available, the bot version is ready for use.

See Also:

BotStatus

botStatusAsString

public final String botStatusAsString()

The current status of the bot. When the status is Available, the bot version is ready for use.

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

Returns:

The current status of the bot. When the status is Available, the bot version is ready for use.

See Also:

BotStatus

hasFailureReasons

public final boolean hasFailureReasons()

For responses, this returns true if the service returned a value for the FailureReasons property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

failureReasons

public final List<String> failureReasons()

If the botStatus is Failed, this contains a list of reasons that the version couldn't be built.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFailureReasons() method.

Returns:

If the botStatus is Failed, this contains a list of reasons that the version couldn't be built.

creationDateTime

public final Instant creationDateTime()

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

Returns:

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

toBuilder

public DescribeBotVersionResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeBotVersionResponse.Builder,DescribeBotVersionResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static DescribeBotVersionResponse.Builder builder()

serializableBuilderClass

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