Class BotSummary

java.lang.Object
software.amazon.awssdk.services.lexmodelsv2.model.BotSummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<BotSummary.Builder,BotSummary>
@Generated("software.amazon.awssdk:codegen") public final class BotSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<BotSummary.Builder,BotSummary>

Summary information about a bot returned by the ListBots operation.

See Also:

  • Method Details

    • botId

      public final String botId()

      The unique identifier assigned to the bot. Use this ID to get detailed information about the bot with the DescribeBot operation.

      Returns:
      The unique identifier assigned to the bot. Use this ID to get detailed information about the bot with the DescribeBot operation.

    • botName

      public final String botName()

      The name of the bot.

      Returns:
      The name of the bot.

    • description

      public final String description()

      The description of the bot.

      Returns:
      The description of the bot.

    • botStatus

      public final BotStatus botStatus()

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

    • botStatusAsString

      public final String botStatusAsString()

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

    • latestBotVersion

      public final String latestBotVersion()

      The latest numerical version in use for the bot.

      Returns:
      The latest numerical version in use for the bot.

    • lastUpdatedDateTime

      public final Instant lastUpdatedDateTime()

      The date and time that the bot was last updated.

      Returns:
      The date and time that the bot was last updated.

    • botType

      public final BotType botType()

      The type of the bot.

      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.
      See Also:

    • botTypeAsString

      public final String botTypeAsString()

      The type of the bot.

      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.
      See Also:

    • toBuilder

      public BotSummary.Builder 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 interface ToCopyableBuilder<BotSummary.Builder,BotSummary>
      Returns:
      a builder for type T

    • builder

      public static BotSummary.Builder builder()

    • serializableBuilderClass

      public static Class<? extends BotSummary.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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.