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

Class CreateBotResponse

    • Method Detail

      • botId

        public final String botId()

        A unique identifier for a particular bot. You use this to identify the bot when you call other Amazon Lex API operations.

        Returns:
        A unique identifier for a particular bot. You use this to identify the bot when you call other Amazon Lex API operations.

      • botName

        public final String botName()

        The name specified for the bot.

        Returns:
        The name specified for the bot.

      • description

        public final String description()

        The description specified for the bot.

        Returns:
        The description specified for the bot.

      • roleArn

        public final String roleArn()

        The IAM role specified for the bot.

        Returns:
        The IAM role specified for the bot.

      • dataPrivacy

        public final DataPrivacy dataPrivacy()

        The data privacy settings specified for the bot.

        Returns:
        The data privacy settings specified for the bot.

      • idleSessionTTLInSeconds

        public final Integer idleSessionTTLInSeconds()

        The session idle time specified for the bot.

        Returns:
        The session idle time specified for the bot.

      • botStatus

        public final BotStatus botStatus()

        Shows the current status of the bot. The bot is first in the Creating status. Once the bot is read for use, it changes to the Available status. After the bot is created, you can use the DRAFT version of the bot.

        If the service returns an enum value that is not available in the current SDK version, botStatus will return BotStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from botStatusAsString().

        Returns:
        Shows the current status of the bot. The bot is first in the Creating status. Once the bot is read for use, it changes to the Available status. After the bot is created, you can use the DRAFT version of the bot.
        See Also:
        BotStatus

      • botStatusAsString

        public final String botStatusAsString()

        Shows the current status of the bot. The bot is first in the Creating status. Once the bot is read for use, it changes to the Available status. After the bot is created, you can use the DRAFT version of the bot.

        If the service returns an enum value that is not available in the current SDK version, botStatus will return BotStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from botStatusAsString().

        Returns:
        Shows the current status of the bot. The bot is first in the Creating status. Once the bot is read for use, it changes to the Available status. After the bot is created, you can use the DRAFT version of the bot.
        See Also:
        BotStatus

      • creationDateTime

        public final Instant creationDateTime()

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

        Returns:
        A timestamp indicating the date and time that the bot was created.

      • 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 associated with the bot.

        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 associated with the bot.

      • 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 associated with the test alias for the bot.

        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 associated with the test alias for the bot.

      • botType

        public final BotType botType()

        The type of a bot that was created.

        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 that was created.
        See Also:
        BotType

      • botTypeAsString

        public final String botTypeAsString()

        The type of a bot that was created.

        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 that was created.
        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 bots in a network that was 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 bots in a network that was created.

      • 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