Class Invite

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

Invitation object returned after emailing users to invite them to join the Amazon Chime Team account.

See Also:

  • Method Details

    • inviteId

      public final String inviteId()

      The invite ID.

      Returns:
      The invite ID.

    • status

      public final InviteStatus status()

      The status of the invite.

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

      Returns:
      The status of the invite.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the invite.

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

      Returns:
      The status of the invite.
      See Also:

    • emailAddress

      public final String emailAddress()

      The email address to which the invite is sent.

      Returns:
      The email address to which the invite is sent.

    • emailStatus

      public final EmailStatus emailStatus()

      The status of the invite email.

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

      Returns:
      The status of the invite email.
      See Also:

    • emailStatusAsString

      public final String emailStatusAsString()

      The status of the invite email.

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

      Returns:
      The status of the invite email.
      See Also:

    • toBuilder

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

    • builder

      public static Invite.Builder builder()

    • serializableBuilderClass

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