RegisterUserRequest (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.quicksight.model.QuickSightRequest
    - - software.amazon.awssdk.services.quicksight.model.RegisterUserRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<RegisterUserRequest.Builder,RegisterUserRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class RegisterUserRequest
extends QuickSightRequest
implements ToCopyableBuilder<RegisterUserRequest.Builder,RegisterUserRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface RegisterUserRequest.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`awsAccountId()` The ID for the AWS account that the user is in.
`static RegisterUserRequest.Builder`	`builder()`
`String`	`email()` The email address of the user that you want to register.
`boolean`	`equals(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)` Used to retrieve the value of a field from any class that extends `SdkRequest`.
`int`	`hashCode()`
`String`	`iamArn()` The ARN of the IAM user or role that you are registering with Amazon QuickSight.
`IdentityType`	`identityType()` Amazon QuickSight supports several ways of managing the identity of users.
`String`	`identityTypeAsString()` Amazon QuickSight supports several ways of managing the identity of users.
`String`	`namespace()` The namespace.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends RegisterUserRequest.Builder>`	`serializableBuilderClass()`
`String`	`sessionName()` The name of the session with the assumed IAM role.
`RegisterUserRequest.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 Amazon QuickSight user name that you want to create for the user you are registering.
`UserRole`	`userRole()` The Amazon QuickSight role of the user.
`String`	`userRoleAsString()` The Amazon QuickSight role of the user.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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
  - identityType
```
public IdentityType identityType()
```
    Amazon QuickSight supports several ways of managing the identity of users. This parameter accepts two values:
    - IAM: A user whose identity maps to an existing IAM user or role.
    - QUICKSIGHT: A user whose identity is owned and managed internally by Amazon QuickSight.
    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:
    Amazon QuickSight supports several ways of managing the identity of users. This parameter accepts two values:
    
    IAM: A user whose identity maps to an existing IAM user or role.
    
    QUICKSIGHT: A user whose identity is owned and managed internally by Amazon QuickSight.
    See Also:
    
    IdentityType
  - identityTypeAsString
```
public String identityTypeAsString()
```
    Amazon QuickSight supports several ways of managing the identity of users. This parameter accepts two values:
    - IAM: A user whose identity maps to an existing IAM user or role.
    - QUICKSIGHT: A user whose identity is owned and managed internally by Amazon QuickSight.
    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:
    Amazon QuickSight supports several ways of managing the identity of users. This parameter accepts two values:
    
    IAM: A user whose identity maps to an existing IAM user or role.
    
    QUICKSIGHT: A user whose identity is owned and managed internally by Amazon QuickSight.
    See Also:
    
    IdentityType
  - email
```
public String email()
```
    The email address of the user that you want to register.
    
    Returns:
    
    The email address of the user that you want to register.
  - userRole
```
public UserRole userRole()
```
    The Amazon QuickSight role of 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, data sets, analyses, and dashboards.
    - ADMIN: A user who is an author, who can also manage Amazon QuickSight settings.
    If the service returns an enum value that is not available in the current SDK version, userRole will return UserRole.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from userRoleAsString().
    Returns:
    The Amazon QuickSight role of 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, data sets, analyses, and dashboards.
    
    ADMIN: A user who is an author, who can also manage Amazon QuickSight settings.
    See Also:
    
    UserRole
  - userRoleAsString
```
public String userRoleAsString()
```
    The Amazon QuickSight role of 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, data sets, analyses, and dashboards.
    - ADMIN: A user who is an author, who can also manage Amazon QuickSight settings.
    If the service returns an enum value that is not available in the current SDK version, userRole will return UserRole.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from userRoleAsString().
    Returns:
    The Amazon QuickSight role of 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, data sets, analyses, and dashboards.
    
    ADMIN: A user who is an author, who can also manage Amazon QuickSight settings.
    See Also:
    
    UserRole
  - iamArn
```
public String iamArn()
```
    The ARN of the IAM user or role that you are registering with Amazon QuickSight.
    
    Returns:
    
    The ARN of the IAM user or role that you are registering with Amazon QuickSight.
  - sessionName
```
public String sessionName()
```
    The name of the session with the assumed IAM role. By using this parameter, you can register multiple users with the same IAM role, provided that each has a different session name. For more information on assuming IAM roles, see assume-role in the AWS CLI Reference.
    
    Returns:
    
    The name of the session with the assumed IAM role. By using this parameter, you can register multiple users with the same IAM role, provided that each has a different session name. For more information on assuming IAM roles, see assume-role in the AWS CLI Reference.
  - awsAccountId
```
public String awsAccountId()
```
    The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
    
    Returns:
    
    The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
  - namespace
```
public String namespace()
```
    The namespace. Currently, you should set this to default.
    
    Returns:
    
    The namespace. Currently, you should set this to default.
  - userName
```
public String userName()
```
    The Amazon QuickSight user name that you want to create for the user you are registering.
    
    Returns:
    
    The Amazon QuickSight user name that you want to create for the user you are registering.
  - toBuilder
```
public RegisterUserRequest.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<RegisterUserRequest.Builder,RegisterUserRequest>
    
    Specified by:
    
    toBuilder in class QuickSightRequest
    
    Returns:
    
    a builder for type T
  - builder
```
public static RegisterUserRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends RegisterUserRequest.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)
```
    Description copied from class: SdkRequest
    
    Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
    
    Overrides:
    
    getValueForField in class SdkRequest
    
    Parameters:
    
    fieldName - The name of the member to be retrieved.
    
    clazz - The class to cast the returned object to.
    
    Returns:
    
    Optional containing the casted return value
  - 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.

Class RegisterUserRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

identityType

identityTypeAsString

email

userRole

userRoleAsString

iamArn

sessionName

awsAccountId

namespace

userName

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields