Package software.amazon.awssdk.services.appstream.model

Class User

java.lang.Object

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

Describes a user in the user pool.

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
String	arn()	The ARN of the user.
AuthenticationType	authenticationType()	The authentication type for the user.
String	authenticationTypeAsString()	The authentication type for the user.
static User.Builder	builder()
Instant	createdTime()	The date and time the user was created in the user pool.
Boolean	enabled()	Specifies whether the user in the user pool is enabled.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	firstName()	The first name, or given name, of the user.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	lastName()	The last name, or surname, of the user.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends User.Builder>	serializableBuilderClass()
String	status()	The status of the user in the user pool.
User.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	userName()	The email address of the user.

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

arn

public final String arn()

The ARN of the user.

Returns:

The ARN of the user.

userName

public final String userName()

The email address of the user.

Users' email addresses are case-sensitive.

Returns:

The email address of the user.

Users' email addresses are case-sensitive.

enabled

public final Boolean enabled()

Specifies whether the user in the user pool is enabled.

Returns:

Specifies whether the user in the user pool is enabled.

status

public final String status()

The status of the user in the user pool. The status can be one of the following:

• UNCONFIRMED – The user is created but not confirmed.

• CONFIRMED – The user is confirmed.

• ARCHIVED – The user is no longer active.

• COMPROMISED – The user is disabled because of a potential security threat.

• UNKNOWN – The user status is not known.

Returns:

The status of the user in the user pool. The status can be one of the following:

• UNCONFIRMED – The user is created but not confirmed.

• CONFIRMED – The user is confirmed.

• ARCHIVED – The user is no longer active.

• COMPROMISED – The user is disabled because of a potential security threat.

• UNKNOWN – The user status is not known.

firstName

public final String firstName()

The first name, or given name, of the user.

Returns:

The first name, or given name, of the user.

lastName

public final String lastName()

The last name, or surname, of the user.

Returns:

The last name, or surname, of the user.

createdTime

public final Instant createdTime()

The date and time the user was created in the user pool.

Returns:

The date and time the user was created in the user pool.

authenticationType

public final AuthenticationType authenticationType()

The authentication type for the user.

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

Returns:

The authentication type for the user.

See Also:

AuthenticationType

authenticationTypeAsString

public final String authenticationTypeAsString()

The authentication type for the user.

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

Returns:

The authentication type for the user.

See Also:

AuthenticationType

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