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

Interface DescribeBotResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<DescribeBotResponse.Builder,DescribeBotResponse>, LexModelsV2Response.Builder, SdkBuilder<DescribeBotResponse.Builder,DescribeBotResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

DescribeBotResponse

public static interface DescribeBotResponse.Builder
extends LexModelsV2Response.Builder, SdkPojo, CopyableBuilder<DescribeBotResponse.Builder,DescribeBotResponse>

Method Summary

Modifier and Type	Method	Description
DescribeBotResponse.Builder	botId(String botId)	The unique identifier of the bot.
DescribeBotResponse.Builder	botMembers(Collection<BotMember> botMembers)	The list of bots in the network that was described.
DescribeBotResponse.Builder	botMembers(Consumer<BotMember.Builder>... botMembers)	The list of bots in the network that was described.
DescribeBotResponse.Builder	botMembers(BotMember... botMembers)	The list of bots in the network that was described.
DescribeBotResponse.Builder	botName(String botName)	The name of the bot.
DescribeBotResponse.Builder	botStatus(String botStatus)	The current status of the bot.
DescribeBotResponse.Builder	botStatus(BotStatus botStatus)	The current status of the bot.
DescribeBotResponse.Builder	botType(String botType)	The type of the bot that was described.
DescribeBotResponse.Builder	botType(BotType botType)	The type of the bot that was described.
DescribeBotResponse.Builder	creationDateTime(Instant creationDateTime)	A timestamp of the date and time that the bot was created.
default DescribeBotResponse.Builder	dataPrivacy(Consumer<DataPrivacy.Builder> dataPrivacy)	Settings for managing data privacy of the bot and its conversations with users.
DescribeBotResponse.Builder	dataPrivacy(DataPrivacy dataPrivacy)	Settings for managing data privacy of the bot and its conversations with users.
DescribeBotResponse.Builder	description(String description)	The description of the bot.
DescribeBotResponse.Builder	failureReasons(String... failureReasons)	If the botStatus is Failed, this contains a list of reasons that the bot couldn't be built.
DescribeBotResponse.Builder	failureReasons(Collection<String> failureReasons)	If the botStatus is Failed, this contains a list of reasons that the bot couldn't be built.
DescribeBotResponse.Builder	idleSessionTTLInSeconds(Integer idleSessionTTLInSeconds)	The maximum time in seconds that Amazon Lex retains the data gathered in a conversation.
DescribeBotResponse.Builder	lastUpdatedDateTime(Instant lastUpdatedDateTime)	A timestamp of the date and time that the bot was last updated.
DescribeBotResponse.Builder	roleArn(String roleArn)	The Amazon Resource Name (ARN) of an IAM role that has permission to access the bot.

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

copy

Methods inherited from interface software.amazon.awssdk.services.lexmodelsv2.model.LexModelsV2Response.Builder

build, responseMetadata, responseMetadata

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Method Detail

botId

DescribeBotResponse.Builder botId(String botId)

The unique identifier of the bot.

Parameters:

botId - The unique identifier of the bot.

Returns:

Returns a reference to this object so that method calls can be chained together.

botName

DescribeBotResponse.Builder botName(String botName)

The name of the bot.

Parameters:

botName - The name of the bot.

Returns:

Returns a reference to this object so that method calls can be chained together.

description

DescribeBotResponse.Builder description(String description)

The description of the bot.

Parameters:

description - The description of the bot.

Returns:

Returns a reference to this object so that method calls can be chained together.

roleArn

DescribeBotResponse.Builder roleArn(String roleArn)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

dataPrivacy

DescribeBotResponse.Builder dataPrivacy(DataPrivacy dataPrivacy)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

dataPrivacy

default DescribeBotResponse.Builder dataPrivacy(Consumer<DataPrivacy.Builder> dataPrivacy)

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

This is a convenience method that creates an instance of the DataPrivacy.Builder avoiding the need to create one manually via DataPrivacy.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to dataPrivacy(DataPrivacy).

Parameters:

dataPrivacy - a consumer that will call methods on DataPrivacy.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

dataPrivacy(DataPrivacy)

idleSessionTTLInSeconds

DescribeBotResponse.Builder idleSessionTTLInSeconds(Integer idleSessionTTLInSeconds)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

botStatus

DescribeBotResponse.Builder botStatus(String botStatus)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

BotStatus, BotStatus

botStatus

DescribeBotResponse.Builder botStatus(BotStatus botStatus)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

BotStatus, BotStatus

creationDateTime

DescribeBotResponse.Builder creationDateTime(Instant creationDateTime)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

lastUpdatedDateTime

DescribeBotResponse.Builder lastUpdatedDateTime(Instant lastUpdatedDateTime)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

botType

DescribeBotResponse.Builder botType(String botType)

The type of the bot that was described.

Parameters:

botType - The type of the bot that was described.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

BotType, BotType

botType

DescribeBotResponse.Builder botType(BotType botType)

The type of the bot that was described.

Parameters:

botType - The type of the bot that was described.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

BotType, BotType

botMembers

DescribeBotResponse.Builder botMembers(Collection<BotMember> botMembers)

The list of bots in the network that was described.

Parameters:

botMembers - The list of bots in the network that was described.

Returns:

Returns a reference to this object so that method calls can be chained together.

botMembers

DescribeBotResponse.Builder botMembers(BotMember... botMembers)

The list of bots in the network that was described.

Parameters:

botMembers - The list of bots in the network that was described.

Returns:

Returns a reference to this object so that method calls can be chained together.

botMembers

DescribeBotResponse.Builder botMembers(Consumer<BotMember.Builder>... botMembers)

The list of bots in the network that was described.

This is a convenience method that creates an instance of the BotMember.Builder avoiding the need to create one manually via BotMember.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #botMembers(List).

Parameters:

botMembers - a consumer that will call methods on BotMember.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#botMembers(java.util.Collection)

failureReasons

DescribeBotResponse.Builder failureReasons(Collection<String> failureReasons)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

failureReasons

DescribeBotResponse.Builder failureReasons(String... failureReasons)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.