CreateBotRequest (AWS Java SDK :: Services :: Lex Models V2 2.20.30 API)

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.lexmodelsv2.model.LexModelsV2Request
    - - software.amazon.awssdk.services.lexmodelsv2.model.CreateBotRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateBotRequest.Builder,CreateBotRequest>

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateBotRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreateBotRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<BotMember>`	`botMembers()` The list of bot members in a network to be created.
`String`	`botName()` The name of the bot.
`Map<String,String>`	`botTags()` A list of tags to add to the bot.
`BotType`	`botType()` The type of a bot to create.
`String`	`botTypeAsString()` The type of a bot to create.
`static CreateBotRequest.Builder`	`builder()`
`DataPrivacy`	`dataPrivacy()` Provides information on additional privacy protections Amazon Lex should use with the bot's data.
`String`	`description()` A description of the bot.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasBotMembers()` For responses, this returns true if the service returned a value for the BotMembers property.
`boolean`	`hasBotTags()` For responses, this returns true if the service returned a value for the BotTags property.
`int`	`hashCode()`
`boolean`	`hasTestBotAliasTags()` For responses, this returns true if the service returned a value for the TestBotAliasTags property.
`Integer`	`idleSessionTTLInSeconds()` The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot.
`String`	`roleArn()` The Amazon Resource Name (ARN) of an IAM role that has permission to access the bot.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateBotRequest.Builder>`	`serializableBuilderClass()`
`Map<String,String>`	`testBotAliasTags()` A list of tags to add to the test alias for a bot.
`CreateBotRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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
  - botName
```
public final String botName()
```
    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.
  - description
```
public final String description()
```
    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.
  - 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()
```
    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.
  - idleSessionTTLInSeconds
```
public final 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.
    
    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.
  - hasBotTags
```
public final boolean hasBotTags()
```
    For responses, this returns true if the service returned a value for the BotTags 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.
  - botTags
```
public final 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.
    
    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 hasBotTags() method.
    
    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.
  - hasTestBotAliasTags
```
public final boolean hasTestBotAliasTags()
```
    For responses, this returns true if the service returned a value for the TestBotAliasTags 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.
  - testBotAliasTags
```
public final 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.
    
    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 hasTestBotAliasTags() method.
    
    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.
  - botType
```
public final BotType botType()
```
    The type of a bot to create.
    
    If the service returns an enum value that is not available in the current SDK version, botType will return BotType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from botTypeAsString().
    
    Returns:
    
    The type of a bot to create.
    
    See Also:
    
    BotType
  - botTypeAsString
```
public final String botTypeAsString()
```
    The type of a bot to create.
    
    If the service returns an enum value that is not available in the current SDK version, botType will return BotType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from botTypeAsString().
    
    Returns:
    
    The type of a bot to create.
    
    See Also:
    
    BotType
  - hasBotMembers
```
public final boolean hasBotMembers()
```
    For responses, this returns true if the service returned a value for the BotMembers 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.
  - botMembers
```
public final List<BotMember> botMembers()
```
    The list of bot members in a network to be created.
    
    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 hasBotMembers() method.
    
    Returns:
    
    The list of bot members in a network to be created.
  - toBuilder
```
public CreateBotRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateBotRequest.Builder,CreateBotRequest>
    
    Specified by:
    
    toBuilder in class LexModelsV2Request
  - builder
```
public static CreateBotRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateBotRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - 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 SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class CreateBotRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

botName

description

roleArn

dataPrivacy

idleSessionTTLInSeconds

hasBotTags

botTags

hasTestBotAliasTags

testBotAliasTags

botType

botTypeAsString

hasBotMembers

botMembers

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields