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

Class DescribeBotResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.lexmodelsv2.model.LexModelsV2Response
software.amazon.awssdk.services.lexmodelsv2.model.DescribeBotResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeBotResponse.Builder,DescribeBotResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeBotResponse extends LexModelsV2Response implements ToCopyableBuilder<DescribeBotResponse.Builder,DescribeBotResponse>

  • Method Details

    • botId

      public final String botId()

      The unique identifier of the bot.

      Returns:
      The unique identifier of the bot.

    • 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.

    • roleArn

      public final String roleArn()

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

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

    • dataPrivacy

      public final DataPrivacy dataPrivacy()

      Settings for managing data privacy of the bot and its conversations with users.

      Returns:
      Settings for managing data privacy of the bot and its conversations with users.

    • idleSessionTTLInSeconds

      public final Integer idleSessionTTLInSeconds()

      The maximum time in seconds that Amazon Lex retains the data gathered in a conversation.

      Returns:
      The maximum time in seconds that Amazon Lex retains the data gathered in a conversation.

    • botStatus

      public final BotStatus botStatus()

      The current status of the bot. When the status is Available the bot is ready to be used in conversations with users.

      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 to be used in conversations with users.
      See Also:

    • botStatusAsString

      public final String botStatusAsString()

      The current status of the bot. When the status is Available the bot is ready to be used in conversations with users.

      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 to be used in conversations with users.
      See Also:

    • creationDateTime

      public final Instant creationDateTime()

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

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

    • lastUpdatedDateTime

      public final Instant lastUpdatedDateTime()

      A timestamp of the date and time that the bot was last updated.

      Returns:
      A timestamp of the date and time that the bot was last updated.

    • botType

      public final BotType botType()

      The type of the bot 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 that was described.
      See Also:

    • botTypeAsString

      public final String botTypeAsString()

      The type of the bot 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 that was described.
      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 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 the network 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 list of bots in the network that was described.

    • 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 bot 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 bot couldn't be built.

    • toBuilder

      public DescribeBotResponse.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<DescribeBotResponse.Builder,DescribeBotResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static DescribeBotResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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

      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.