Class Bot

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

A resource that allows Enterprise account administrators to configure an interface to receive events from Amazon Chime.

See Also:

  • Method Details

    • botId

      public final String botId()

      The bot ID.

      Returns:
      The bot ID.

    • userId

      public final String userId()

      The unique ID for the bot user.

      Returns:
      The unique ID for the bot user.

    • displayName

      public final String displayName()

      The bot display name.

      Returns:
      The bot display name.

    • botType

      public final BotType botType()

      The bot type.

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

    • botTypeAsString

      public final String botTypeAsString()

      The bot type.

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

    • disabled

      public final Boolean disabled()

      When true, the bot is stopped from running in your account.

      Returns:
      When true, the bot is stopped from running in your account.

    • createdTimestamp

      public final Instant createdTimestamp()

      The bot creation timestamp, in ISO 8601 format.

      Returns:
      The bot creation timestamp, in ISO 8601 format.

    • updatedTimestamp

      public final Instant updatedTimestamp()

      The updated bot timestamp, in ISO 8601 format.

      Returns:
      The updated bot timestamp, in ISO 8601 format.

    • botEmail

      public final String botEmail()

      The bot email address.

      Returns:
      The bot email address.

    • securityToken

      public final String securityToken()

      The security token used to authenticate Amazon Chime with the outgoing event endpoint.

      Returns:
      The security token used to authenticate Amazon Chime with the outgoing event endpoint.

    • toBuilder

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

    • builder

      public static Bot.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Bot.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.