software.amazon.awssdk.services.lexmodelsv2.model

Class DescribeBotResponse

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeBotResponse.Builder,DescribeBotResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeBotResponse.Builder

Method Summary

Modifier and Type	Method and Description
String	botId() The unique identifier of the bot.
String	botName() The name of the bot.
BotStatus	botStatus() The current status of the bot.
String	botStatusAsString() The current status of the bot.
static DescribeBotResponse.Builder	builder()
Instant	creationDateTime() A timestamp of the date and time that the bot was created.
DataPrivacy	dataPrivacy() Settings for managing data privacy of the bot and its conversations with users.
String	description() The description of the bot.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	idleSessionTTLInSeconds() The maximum time in seconds that Amazon Lex retains the data gathered in a conversation.
Instant	lastUpdatedDateTime() A timestamp of the date and time that the bot was last updated.
String	roleArn() The Amazon Resource Name (ARN) of an IAM role that has permission to access the bot.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeBotResponse.Builder>	serializableBuilderClass()
DescribeBotResponse.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 unique identifier of the bot.

Returns:

The unique identifier of the bot.

botName

public final String botName()

The name of the bot.

Returns:

The name of the bot.

description

public final String description()

The description of the bot.

Returns:

The description of the bot.

roleArn

public final String roleArn()

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

Returns:

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

dataPrivacy

public final DataPrivacy dataPrivacy()

Settings for managing data privacy of the bot and its conversations with users.

Returns:

Settings for managing data privacy of the bot and its conversations with users.

idleSessionTTLInSeconds

public final Integer idleSessionTTLInSeconds()

The maximum time in seconds that Amazon Lex retains the data gathered in a conversation.

Returns:

The maximum time in seconds that Amazon Lex retains the data gathered in a conversation.

botStatus

public final BotStatus botStatus()

The current status of the bot. When the status is Available the bot is ready to be used in conversations with users.

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 is ready to be used in conversations with users.

See Also:

BotStatus

botStatusAsString

public final String botStatusAsString()

The current status of the bot. When the status is Available the bot is ready to be used in conversations with users.

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 is ready to be used in conversations with users.

See Also:

BotStatus

creationDateTime

public final Instant creationDateTime()

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

Returns:

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

lastUpdatedDateTime

public final Instant lastUpdatedDateTime()

A timestamp of the date and time that the bot was last updated.

Returns:

A timestamp of the date and time that the bot was last updated.

toBuilder

public DescribeBotResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeBotResponse.Builder,DescribeBotResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static DescribeBotResponse.Builder builder()

serializableBuilderClass

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