software.amazon.awssdk.services.quicksight.model

Class User

java.lang.Object

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

A registered user of Amazon QuickSight. Currently, an Amazon QuickSight subscription can't contain more than 20 million users.

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
Boolean	active() Active status of user.
String	arn() The Amazon Resource Name (ARN) for the user.
static User.Builder	builder()
String	email() The user's email address.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
IdentityType	identityType() The type of identity authentication used by the user.
String	identityTypeAsString() The type of identity authentication used by the user.
UserRole	role() The Amazon QuickSight role for the user.
String	roleAsString() The Amazon QuickSight role for the user.
List<SdkField<?>>	sdkFields()
static Class<? extends User.Builder>	serializableBuilderClass()
User.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	userName() The user's user name.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

arn

public String arn()

The Amazon Resource Name (ARN) for the user.

Returns:

The Amazon Resource Name (ARN) for the user.

userName

public String userName()

The user's user name.

Returns:

The user's user name.

email

public String email()

The user's email address.

Returns:

The user's email address.

role

public UserRole role()

The Amazon QuickSight role for the user.

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

Returns:

The Amazon QuickSight role for the user.

See Also:

UserRole

roleAsString

public String roleAsString()

The Amazon QuickSight role for the user.

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

Returns:

The Amazon QuickSight role for the user.

See Also:

UserRole

identityType

public IdentityType identityType()

The type of identity authentication used by the user.

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

Returns:

The type of identity authentication used by the user.

See Also:

IdentityType

identityTypeAsString

public String identityTypeAsString()

The type of identity authentication used by the user.

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

Returns:

The type of identity authentication used by the user.

See Also:

IdentityType

active

public Boolean active()

Active status of user. When you create an Amazon QuickSight user that’s not an IAM user or an AD user, that user is inactive until they sign in and provide a password

Returns:

Active status of user. When you create an Amazon QuickSight user that’s not an IAM user or an AD user, that user is inactive until they sign in and provide a password

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

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public 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.