Class UpdateBotRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<UpdateBotRequest.Builder,
UpdateBotRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
botId()
The unique identifier of the bot to update.The list of bot members in the network associated with the update action.final String
botName()
The new name of the bot.final BotType
botType()
The type of the bot to be updated.final String
The type of the bot to be updated.static UpdateBotRequest.Builder
builder()
final DataPrivacy
Provides information on additional privacy protections Amazon Lex should use with the bot's data.final String
A description of the bot.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the BotMembers property.final int
hashCode()
final Integer
The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot.final String
roleArn()
The Amazon Resource Name (ARN) of an IAM role that has permissions to access the bot.static Class
<? extends UpdateBotRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
botId
The unique identifier of the bot to update. This identifier is returned by the CreateBot operation.
- Returns:
- The unique identifier of the bot to update. This identifier is returned by the CreateBot operation.
-
botName
The new name of the bot. The name must be unique in the account that creates the bot.
- Returns:
- The new name of the bot. The name must be unique in the account that creates the bot.
-
description
A description of the bot.
- Returns:
- A description of the bot.
-
roleArn
The Amazon Resource Name (ARN) of an IAM role that has permissions to access the bot.
- Returns:
- The Amazon Resource Name (ARN) of an IAM role that has permissions to access the bot.
-
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
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.
-
botType
The type of the bot to be updated.
If the service returns an enum value that is not available in the current SDK version,
botType
will returnBotType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frombotTypeAsString()
.- Returns:
- The type of the bot to be updated.
- See Also:
-
botTypeAsString
The type of the bot to be updated.
If the service returns an enum value that is not available in the current SDK version,
botType
will returnBotType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frombotTypeAsString()
.- Returns:
- The type of the bot to be updated.
- See Also:
-
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 theisEmpty()
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
The list of bot members in the network associated with the update action.
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 the network associated with the update action.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<UpdateBotRequest.Builder,
UpdateBotRequest> - Specified by:
toBuilder
in classLexModelsV2Request
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-