Package software.amazon.awssdk.services.directoryservicedata.model

Class User

java.lang.Object

software.amazon.awssdk.services.directoryservicedata.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>

A user object that contains identifying information and attributes for a specified user.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	User.Builder

Method Summary

Modifier and Type	Method	Description
static User.Builder	builder()
String	distinguishedName()	The distinguished name of the object.
String	emailAddress()	The email address of the user.
Boolean	enabled()	Indicates whether the user account is active.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
String	givenName()	The first name of the user.
int	hashCode()
boolean	hasOtherAttributes()	For responses, this returns true if the service returned a value for the OtherAttributes property.
Map<String,AttributeValue>	otherAttributes()	An expression that includes one or more attributes, data types, and values of a user.
String	samAccountName()	The name of the user.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends User.Builder>	serializableBuilderClass()
String	sid()	The unique security identifier (SID) of the user.
String	surname()	The last name of the user.
User.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	userPrincipalName()	The UPN that is an internet-style login name for a user and based on the internet standard RFC 822.

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

distinguishedName

public final String distinguishedName()

The distinguished name of the object.

Returns:

The distinguished name of the object.

emailAddress

public final String emailAddress()

The email address of the user.

Returns:

The email address of the user.

enabled

public final Boolean enabled()

Indicates whether the user account is active.

Returns:

Indicates whether the user account is active.

givenName

public final String givenName()

The first name of the user.

Returns:

The first name of the user.

hasOtherAttributes

public final boolean hasOtherAttributes()

For responses, this returns true if the service returned a value for the OtherAttributes 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.

otherAttributes

public final Map<String,AttributeValue> otherAttributes()

An expression that includes one or more attributes, data types, and values of a user.

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 hasOtherAttributes() method.

Returns:

An expression that includes one or more attributes, data types, and values of a user.

samAccountName

public final String samAccountName()

The name of the user.

Returns:

The name of the user.

sid

public final String sid()

The unique security identifier (SID) of the user.

Returns:

The unique security identifier (SID) of the user.

surname

public final String surname()

The last name of the user.

Returns:

The last name of the user.

userPrincipalName

public final String userPrincipalName()

The UPN that is an internet-style login name for a user and based on the internet standard RFC 822. The UPN is shorter than the distinguished name and easier to remember.

Returns:

The UPN that is an internet-style login name for a user and based on the internet standard RFC 822. The UPN is shorter than the distinguished name and easier to remember.

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo