software.amazon.awssdk.services.chime.model

Class User

java.lang.Object

software.amazon.awssdk.services.chime.model.User

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<User.Builder,User>

@Generated(value="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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	User.Builder

Method Summary

Modifier and Type	Method and Description
String	accountId() The Amazon Chime account ID.
AlexaForBusinessMetadata	alexaForBusinessMetadata() The Alexa for Business metadata.
static User.Builder	builder()
String	displayName() The display name of the user.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Instant	invitedOn() Date and time when the user is invited to the Amazon Chime account, in ISO 8601 format.
License	licenseType() The license type for the user.
String	licenseTypeAsString() The license type for the user.
String	personalPIN() The user's personal meeting PIN.
String	primaryEmail() The primary email address of the user.
String	primaryProvisionedNumber() The primary phone number associated with the user.
Instant	registeredOn() Date and time when the user is registered, in ISO 8601 format.
List<SdkField<?>>	sdkFields()
static Class<? extends User.Builder>	serializableBuilderClass()
User.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	userId() The user ID.
InviteStatus	userInvitationStatus() The user invite status.
String	userInvitationStatusAsString() The user invite status.
RegistrationStatus	userRegistrationStatus() The user registration status.
String	userRegistrationStatusAsString() The user registration status.
UserType	userType() The user type.
String	userTypeAsString() The user type.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

License

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:

License

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:

UserType

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:

UserType

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:

RegistrationStatus

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:

RegistrationStatus

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:

InviteStatus

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:

InviteStatus

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()

Specified by:

toBuilder in interface ToCopyableBuilder<User.Builder,User>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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