Class User

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

The user on the Amazon Chime account.

See Also:

  • Method Details

    • userId

      public final String userId()

      The user ID.

      Returns:
      The user ID.

    • accountId

      public final String accountId()

      The Amazon Chime account ID.

      Returns:
      The Amazon Chime account ID.

    • primaryEmail

      public final String primaryEmail()

      The primary email address of the user.

      Returns:
      The primary email address of the user.

    • primaryProvisionedNumber

      public final String primaryProvisionedNumber()

      The primary phone number associated with the user.

      Returns:
      The primary phone number associated with the user.

    • displayName

      public final String displayName()

      The display name of the user.

      Returns:
      The display name of the user.

    • licenseType

      public final License licenseType()

      The license type for the user.

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

      Returns:
      The license type for the user.
      See Also:

    • licenseTypeAsString

      public final String licenseTypeAsString()

      The license type for the user.

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

      Returns:
      The license type for the user.
      See Also:

    • userType

      public final UserType userType()

      The user type.

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

      Returns:
      The user type.
      See Also:

    • userTypeAsString

      public final String userTypeAsString()

      The user type.

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

      Returns:
      The user type.
      See Also:

    • userRegistrationStatus

      public final RegistrationStatus userRegistrationStatus()

      The user registration status.

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

      Returns:
      The user registration status.
      See Also:

    • userRegistrationStatusAsString

      public final String userRegistrationStatusAsString()

      The user registration status.

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

      Returns:
      The user registration status.
      See Also:

    • userInvitationStatus

      public final InviteStatus userInvitationStatus()

      The user invite status.

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

      Returns:
      The user invite status.
      See Also:

    • userInvitationStatusAsString

      public final String userInvitationStatusAsString()

      The user invite status.

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

      Returns:
      The user invite status.
      See Also:

    • registeredOn

      public final Instant registeredOn()

      Date and time when the user is registered, in ISO 8601 format.

      Returns:
      Date and time when the user is registered, in ISO 8601 format.

    • invitedOn

      public final Instant invitedOn()

      Date and time when the user is invited to the Amazon Chime account, in ISO 8601 format.

      Returns:
      Date and time when the user is invited to the Amazon Chime account, in ISO 8601 format.

    • alexaForBusinessMetadata

      public final AlexaForBusinessMetadata alexaForBusinessMetadata()

      The Alexa for Business metadata.

      Returns:
      The Alexa for Business metadata.

    • personalPIN

      public final String personalPIN()

      The user's personal meeting PIN.

      Returns:
      The user's personal meeting PIN.

    • toBuilder

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

    • builder

      public static User.Builder builder()

    • serializableBuilderClass

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