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

Class DescribeBotVersionResponse

    • Method Detail

      • botId

        public final String botId()

        The identifier of the bot that contains the version.

        Returns:
        The identifier of the bot that contains the version.

      • botName

        public final String botName()

        The name of the bot that contains the version.

        Returns:
        The name of the bot that contains the version.

      • botVersion

        public final String botVersion()

        The version of the bot that was described.

        Returns:
        The version of the bot that was described.

      • description

        public final String description()

        The description specified for the bot.

        Returns:
        The description specified for the bot.

      • roleArn

        public final String roleArn()

        The Amazon Resource Name (ARN) of an IAM role that has permission to access the bot version.

        Returns:
        The Amazon Resource Name (ARN) of an IAM role that has permission to access the bot version.

      • dataPrivacy

        public final DataPrivacy dataPrivacy()

        Data privacy settings for the bot version.

        Returns:
        Data privacy settings for the bot version.

      • idleSessionTTLInSeconds

        public final Integer idleSessionTTLInSeconds()

        The number of seconds that a session with the bot remains active before it is discarded by Amazon Lex.

        Returns:
        The number of seconds that a session with the bot remains active before it is discarded by Amazon Lex.

      • botStatus

        public final BotStatus botStatus()

        The current status of the bot. When the status is Available, the bot version is ready for use.

        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:
        The current status of the bot. When the status is Available, the bot version is ready for use.
        See Also:
        BotStatus

      • botStatusAsString

        public final String botStatusAsString()

        The current status of the bot. When the status is Available, the bot version is ready for use.

        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:
        The current status of the bot. When the status is Available, the bot version is ready for use.
        See Also:
        BotStatus

      • hasFailureReasons

        public final boolean hasFailureReasons()
        For responses, this returns true if the service returned a value for the FailureReasons 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.

      • failureReasons

        public final List<String> failureReasons()

        If the botStatus is Failed, this contains a list of reasons that the version couldn't be built.

        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 hasFailureReasons() method.

        Returns:
        If the botStatus is Failed, this contains a list of reasons that the version couldn't be built.

      • creationDateTime

        public final Instant creationDateTime()

        A timestamp of the date and time that the bot version was created.

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

      • hasParentBotNetworks

        public final boolean hasParentBotNetworks()
        For responses, this returns true if the service returned a value for the ParentBotNetworks 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.

      • parentBotNetworks

        public final List<ParentBotNetwork> parentBotNetworks()

        A list of the networks to which the bot version you described belongs.

        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 hasParentBotNetworks() method.

        Returns:
        A list of the networks to which the bot version you described belongs.

      • botType

        public final BotType botType()

        The type of the bot in the version that was described.

        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 the bot in the version that was described.
        See Also:
        BotType

      • botTypeAsString

        public final String botTypeAsString()

        The type of the bot in the version that was described.

        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 the bot in the version that was described.
        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 members of bot network in the version that was described.

        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 members of bot network in the version that was described.

      • 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