com.amazonaws.services.lexmodelsv2.model

Class CreateBotRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.lexmodelsv2.model.CreateBotRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateBotRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateBotRequest()

Method Summary

Modifier and Type	Method and Description
CreateBotRequest	addBotTagsEntry(String key, String value) Add a single BotTags entry
CreateBotRequest	addTestBotAliasTagsEntry(String key, String value) Add a single TestBotAliasTags entry
CreateBotRequest	clearBotTagsEntries() Removes all the entries added into BotTags.
CreateBotRequest	clearTestBotAliasTagsEntries() Removes all the entries added into TestBotAliasTags.
CreateBotRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
List<BotMember>	getBotMembers() The list of bot members in a network to be created.
String	getBotName() The name of the bot.
Map<String,String>	getBotTags() A list of tags to add to the bot.
String	getBotType() The type of a bot to create.
DataPrivacy	getDataPrivacy() Provides information on additional privacy protections Amazon Lex should use with the bot's data.
String	getDescription() A description of the bot.
Integer	getIdleSessionTTLInSeconds() The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot.
String	getRoleArn() The Amazon Resource Name (ARN) of an IAM role that has permission to access the bot.
Map<String,String>	getTestBotAliasTags() A list of tags to add to the test alias for a bot.
int	hashCode()
void	setBotMembers(Collection<BotMember> botMembers) The list of bot members in a network to be created.
void	setBotName(String botName) The name of the bot.
void	setBotTags(Map<String,String> botTags) A list of tags to add to the bot.
void	setBotType(String botType) The type of a bot to create.
void	setDataPrivacy(DataPrivacy dataPrivacy) Provides information on additional privacy protections Amazon Lex should use with the bot's data.
void	setDescription(String description) A description of the bot.
void	setIdleSessionTTLInSeconds(Integer idleSessionTTLInSeconds) The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot.
void	setRoleArn(String roleArn) The Amazon Resource Name (ARN) of an IAM role that has permission to access the bot.
void	setTestBotAliasTags(Map<String,String> testBotAliasTags) A list of tags to add to the test alias for a bot.
String	toString() Returns a string representation of this object.
CreateBotRequest	withBotMembers(BotMember... botMembers) The list of bot members in a network to be created.
CreateBotRequest	withBotMembers(Collection<BotMember> botMembers) The list of bot members in a network to be created.
CreateBotRequest	withBotName(String botName) The name of the bot.
CreateBotRequest	withBotTags(Map<String,String> botTags) A list of tags to add to the bot.
CreateBotRequest	withBotType(BotType botType) The type of a bot to create.
CreateBotRequest	withBotType(String botType) The type of a bot to create.
CreateBotRequest	withDataPrivacy(DataPrivacy dataPrivacy) Provides information on additional privacy protections Amazon Lex should use with the bot's data.
CreateBotRequest	withDescription(String description) A description of the bot.
CreateBotRequest	withIdleSessionTTLInSeconds(Integer idleSessionTTLInSeconds) The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot.
CreateBotRequest	withRoleArn(String roleArn) The Amazon Resource Name (ARN) of an IAM role that has permission to access the bot.
CreateBotRequest	withTestBotAliasTags(Map<String,String> testBotAliasTags) A list of tags to add to the test alias for a bot.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateBotRequest

public CreateBotRequest()

Method Detail

setBotName

public void setBotName(String botName)

The name of the bot. The bot name must be unique in the account that creates the bot.

Parameters:

botName - The name of the bot. The bot name must be unique in the account that creates the bot.

getBotName

public String getBotName()

The name of the bot. The bot name must be unique in the account that creates the bot.

Returns:

The name of the bot. The bot name must be unique in the account that creates the bot.

withBotName

public CreateBotRequest withBotName(String botName)

The name of the bot. The bot name must be unique in the account that creates the bot.

Parameters:

botName - The name of the bot. The bot name must be unique in the account that creates the bot.

Returns:

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

setDescription

public void setDescription(String description)

A description of the bot. It appears in lists to help you identify a particular bot.

Parameters:

description - A description of the bot. It appears in lists to help you identify a particular bot.

getDescription

public String getDescription()

A description of the bot. It appears in lists to help you identify a particular bot.

Returns:

A description of the bot. It appears in lists to help you identify a particular bot.

withDescription

public CreateBotRequest withDescription(String description)

A description of the bot. It appears in lists to help you identify a particular bot.

Parameters:

description - A description of the bot. It appears in lists to help you identify a particular bot.

Returns:

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

setRoleArn

public void setRoleArn(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.

getRoleArn

public String getRoleArn()

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.

withRoleArn

public CreateBotRequest withRoleArn(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.

setDataPrivacy

public void setDataPrivacy(DataPrivacy dataPrivacy)

Provides information on additional privacy protections Amazon Lex should use with the bot's data.

Parameters:

dataPrivacy - Provides information on additional privacy protections Amazon Lex should use with the bot's data.

getDataPrivacy

public DataPrivacy getDataPrivacy()

Provides information on additional privacy protections Amazon Lex should use with the bot's data.

Returns:

Provides information on additional privacy protections Amazon Lex should use with the bot's data.

withDataPrivacy

public CreateBotRequest withDataPrivacy(DataPrivacy dataPrivacy)

Provides information on additional privacy protections Amazon Lex should use with the bot's data.

Parameters:

dataPrivacy - Provides information on additional privacy protections Amazon Lex should use with the bot's data.

Returns:

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

setIdleSessionTTLInSeconds

public void setIdleSessionTTLInSeconds(Integer idleSessionTTLInSeconds)

The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot.

A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Lex deletes any data provided before the timeout.

You can specify between 60 (1 minute) and 86,400 (24 hours) seconds.

Parameters:

idleSessionTTLInSeconds - The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot.

A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Lex deletes any data provided before the timeout.

You can specify between 60 (1 minute) and 86,400 (24 hours) seconds.

getIdleSessionTTLInSeconds

public Integer getIdleSessionTTLInSeconds()

The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot.

A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Lex deletes any data provided before the timeout.

You can specify between 60 (1 minute) and 86,400 (24 hours) seconds.

Returns:

The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot.

A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Lex deletes any data provided before the timeout.

You can specify between 60 (1 minute) and 86,400 (24 hours) seconds.

withIdleSessionTTLInSeconds

public CreateBotRequest withIdleSessionTTLInSeconds(Integer idleSessionTTLInSeconds)

The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot.

A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Lex deletes any data provided before the timeout.

You can specify between 60 (1 minute) and 86,400 (24 hours) seconds.

Parameters:

idleSessionTTLInSeconds - The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot.

A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Lex deletes any data provided before the timeout.

You can specify between 60 (1 minute) and 86,400 (24 hours) seconds.

Returns:

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

getBotTags

public Map<String,String> getBotTags()

A list of tags to add to the bot. You can only add tags when you create a bot. You can't use the UpdateBot operation to update tags. To update tags, use the TagResource operation.

Returns:

A list of tags to add to the bot. You can only add tags when you create a bot. You can't use the UpdateBot operation to update tags. To update tags, use the TagResource operation.

setBotTags

public void setBotTags(Map<String,String> botTags)

A list of tags to add to the bot. You can only add tags when you create a bot. You can't use the UpdateBot operation to update tags. To update tags, use the TagResource operation.

Parameters:

botTags - A list of tags to add to the bot. You can only add tags when you create a bot. You can't use the UpdateBot operation to update tags. To update tags, use the TagResource operation.

withBotTags

public CreateBotRequest withBotTags(Map<String,String> botTags)

A list of tags to add to the bot. You can only add tags when you create a bot. You can't use the UpdateBot operation to update tags. To update tags, use the TagResource operation.

Parameters:

botTags - A list of tags to add to the bot. You can only add tags when you create a bot. You can't use the UpdateBot operation to update tags. To update tags, use the TagResource operation.

Returns:

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

addBotTagsEntry

public CreateBotRequest addBotTagsEntry(String key,
                                        String value)

Add a single BotTags entry

See Also:

withBotTags(java.util.Map<java.lang.String, java.lang.String>)

clearBotTagsEntries

public CreateBotRequest clearBotTagsEntries()

Removes all the entries added into BotTags.

Returns:

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

getTestBotAliasTags

public Map<String,String> getTestBotAliasTags()

A list of tags to add to the test alias for a bot. You can only add tags when you create a bot. You can't use the UpdateAlias operation to update tags. To update tags on the test alias, use the TagResource operation.

Returns:

A list of tags to add to the test alias for a bot. You can only add tags when you create a bot. You can't use the UpdateAlias operation to update tags. To update tags on the test alias, use the TagResource operation.

setTestBotAliasTags

public void setTestBotAliasTags(Map<String,String> testBotAliasTags)

A list of tags to add to the test alias for a bot. You can only add tags when you create a bot. You can't use the UpdateAlias operation to update tags. To update tags on the test alias, use the TagResource operation.

Parameters:

testBotAliasTags - A list of tags to add to the test alias for a bot. You can only add tags when you create a bot. You can't use the UpdateAlias operation to update tags. To update tags on the test alias, use the TagResource operation.

withTestBotAliasTags

public CreateBotRequest withTestBotAliasTags(Map<String,String> testBotAliasTags)

A list of tags to add to the test alias for a bot. You can only add tags when you create a bot. You can't use the UpdateAlias operation to update tags. To update tags on the test alias, use the TagResource operation.

Parameters:

testBotAliasTags - A list of tags to add to the test alias for a bot. You can only add tags when you create a bot. You can't use the UpdateAlias operation to update tags. To update tags on the test alias, use the TagResource operation.

Returns:

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

addTestBotAliasTagsEntry

public CreateBotRequest addTestBotAliasTagsEntry(String key,
                                                 String value)

Add a single TestBotAliasTags entry

See Also:

withTestBotAliasTags(java.util.Map<java.lang.String, java.lang.String>)

clearTestBotAliasTagsEntries

public CreateBotRequest clearTestBotAliasTagsEntries()

Removes all the entries added into TestBotAliasTags.

Returns:

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

setBotType

public void setBotType(String botType)

The type of a bot to create.

Parameters:

botType - The type of a bot to create.

See Also:

BotType

getBotType

public String getBotType()

The type of a bot to create.

Returns:

The type of a bot to create.

See Also:

BotType

withBotType

public CreateBotRequest withBotType(String botType)

The type of a bot to create.

Parameters:

botType - The type of a bot to create.

Returns:

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

See Also:

BotType

withBotType

public CreateBotRequest withBotType(BotType botType)

The type of a bot to create.

Parameters:

botType - The type of a bot to create.

Returns:

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

See Also:

BotType

getBotMembers

public List<BotMember> getBotMembers()

The list of bot members in a network to be created.

Returns:

The list of bot members in a network to be created.

setBotMembers

public void setBotMembers(Collection<BotMember> botMembers)

The list of bot members in a network to be created.

Parameters:

botMembers - The list of bot members in a network to be created.

withBotMembers

public CreateBotRequest withBotMembers(BotMember... botMembers)

The list of bot members in a network to be created.

NOTE: This method appends the values to the existing list (if any). Use setBotMembers(java.util.Collection) or withBotMembers(java.util.Collection) if you want to override the existing values.

Parameters:

botMembers - The list of bot members in a network to be created.

Returns:

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

withBotMembers

public CreateBotRequest withBotMembers(Collection<BotMember> botMembers)

The list of bot members in a network to be created.

Parameters:

botMembers - The list of bot members in a network to be created.

Returns:

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

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateBotRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()