software.amazon.awssdk.services.lexmodelsv2.model

Class BotImportSpecification

java.lang.Object

software.amazon.awssdk.services.lexmodelsv2.model.BotImportSpecification

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<BotImportSpecification.Builder,BotImportSpecification>

@Generated(value="software.amazon.awssdk:codegen")
public final class BotImportSpecification
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<BotImportSpecification.Builder,BotImportSpecification>

Provides the bot parameters required for importing a bot.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BotImportSpecification.Builder

Method Summary

Modifier and Type	Method and Description
String	botName() The name that Amazon Lex should use for the bot.
Map<String,String>	botTags() A list of tags to add to the bot.
static BotImportSpecification.Builder	builder()
DataPrivacy	dataPrivacy() Returns the value of the DataPrivacy property for this object.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
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 the IAM role used to build and run the bot.
List<SdkField<?>>	sdkFields()
static Class<? extends BotImportSpecification.Builder>	serializableBuilderClass()
Map<String,String>	testBotAliasTags() A list of tags to add to the test alias for a bot.
BotImportSpecification.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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 that Amazon Lex should use for the bot.

Returns:

The name that Amazon Lex should use for the bot.

roleArn

public final String roleArn()

The Amazon Resource Name (ARN) of the IAM role used to build and run the bot.

Returns:

The Amazon Resource Name (ARN) of the IAM role used to build and run the bot.

dataPrivacy

public final DataPrivacy dataPrivacy()

Returns the value of the DataPrivacy property for this object.

Returns:

The value of the DataPrivacy property for this object.

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 import 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 import 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 import 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 import a bot. You can't use the UpdateAlias operation to update tags. To update tags on the test alias, use the TagResource operation.

toBuilder

public BotImportSpecification.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<BotImportSpecification.Builder,BotImportSpecification>

builder

public static BotImportSpecification.Builder builder()

serializableBuilderClass

public static Class<? extends BotImportSpecification.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo