User (AWS Java SDK :: Services :: QuickSight 2.20.149 API)

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.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface User.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`User.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Boolean`	`active()` The active status of user.
`String`	`arn()` The Amazon Resource Name (ARN) for the user.
`static User.Builder`	`builder()`
`String`	`customPermissionsName()` The custom permissions profile associated with this user.
`String`	`email()` The user's email address.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`externalLoginFederationProviderType()` The type of supported external login provider that provides identity to let the user federate into Amazon QuickSight with an associated IAM role.
`String`	`externalLoginFederationProviderUrl()` The URL of the external login provider.
`String`	`externalLoginId()` The identity ID for the user in the external login provider.
`<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.
`String`	`principalId()` The principal ID of 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()`
`String`	`toString()` Returns a string representation of this object.
`String`	`userName()` The user's user name.

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 Amazon Resource Name (ARN) for the user.
    
    Returns:
    
    The Amazon Resource Name (ARN) for the user.
  - userName
```
public final String userName()
```
    The user's user name. This value is required if you are registering a user that will be managed in Amazon QuickSight. In the output, the value for UserName is N/A when the value for IdentityType is IAM and the corresponding IAM user is deleted.
    
    Returns:
    
    The user's user name. This value is required if you are registering a user that will be managed in Amazon QuickSight. In the output, the value for UserName is N/A when the value for IdentityType is IAM and the corresponding IAM user is deleted.
  - email
```
public final String email()
```
    The user's email address.
    
    Returns:
    
    The user's email address.
  - role
```
public final UserRole role()
```
    The Amazon QuickSight role for the user. The user role can be one of the following:.
    - READER: A user who has read-only access to dashboards.
    - AUTHOR: A user who can create data sources, datasets, analyses, and dashboards.
    - ADMIN: A user who is an author, who can also manage Amazon Amazon QuickSight settings.
    - RESTRICTED_READER: This role isn't currently available for use.
    - RESTRICTED_AUTHOR: This role isn't currently available for use.
    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. The user role can be one of the following:.
    
    READER: A user who has read-only access to dashboards.
    
    AUTHOR: A user who can create data sources, datasets, analyses, and dashboards.
    
    ADMIN: A user who is an author, who can also manage Amazon Amazon QuickSight settings.
    
    RESTRICTED_READER: This role isn't currently available for use.
    
    RESTRICTED_AUTHOR: This role isn't currently available for use.
    See Also:
    
    UserRole
  - roleAsString
```
public final String roleAsString()
```
    The Amazon QuickSight role for the user. The user role can be one of the following:.
    - READER: A user who has read-only access to dashboards.
    - AUTHOR: A user who can create data sources, datasets, analyses, and dashboards.
    - ADMIN: A user who is an author, who can also manage Amazon Amazon QuickSight settings.
    - RESTRICTED_READER: This role isn't currently available for use.
    - RESTRICTED_AUTHOR: This role isn't currently available for use.
    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. The user role can be one of the following:.
    
    READER: A user who has read-only access to dashboards.
    
    AUTHOR: A user who can create data sources, datasets, analyses, and dashboards.
    
    ADMIN: A user who is an author, who can also manage Amazon Amazon QuickSight settings.
    
    RESTRICTED_READER: This role isn't currently available for use.
    
    RESTRICTED_AUTHOR: This role isn't currently available for use.
    See Also:
    
    UserRole
  - identityType
```
public final 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 final 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 final Boolean active()
```
    The active status of user. When you create an Amazon QuickSight user that's not an IAM user or an Active Directory user, that user is inactive until they sign in and provide a password.
    
    Returns:
    
    The active status of user. When you create an Amazon QuickSight user that's not an IAM user or an Active Directory user, that user is inactive until they sign in and provide a password.
  - principalId
```
public final String principalId()
```
    The principal ID of the user.
    
    Returns:
    
    The principal ID of the user.
  - customPermissionsName
```
public final String customPermissionsName()
```
    The custom permissions profile associated with this user.
    
    Returns:
    
    The custom permissions profile associated with this user.
  - externalLoginFederationProviderType
```
public final String externalLoginFederationProviderType()
```
    The type of supported external login provider that provides identity to let the user federate into Amazon QuickSight with an associated IAM role. The type can be one of the following.
    - COGNITO: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com.
    - CUSTOM_OIDC: Custom OpenID Connect (OIDC) provider.
    Returns:
    The type of supported external login provider that provides identity to let the user federate into Amazon QuickSight with an associated IAM role. The type can be one of the following.
    
    COGNITO: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com.
    
    CUSTOM_OIDC: Custom OpenID Connect (OIDC) provider.
  - externalLoginFederationProviderUrl
```
public final String externalLoginFederationProviderUrl()
```
    The URL of the external login provider.
    
    Returns:
    
    The URL of the external login provider.
  - externalLoginId
```
public final String externalLoginId()
```
    The identity ID for the user in the external login provider.
    
    Returns:
    
    The identity ID for the user in the external login provider.
  - 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

Class User

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

arn

userName

email

role

roleAsString

identityType

identityTypeAsString

active

principalId

customPermissionsName

externalLoginFederationProviderType

externalLoginFederationProviderUrl

externalLoginId

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields