software.amazon.awssdk.services.quicksight.model

Class UpdateUserRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateUserRequest.Builder,UpdateUserRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateUserRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	awsAccountId() The ID for the AWS account that the user is in.
static UpdateUserRequest.Builder	builder()
String	email() The email address of the user that you want to update.
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	namespace() The namespace.
UserRole	role() The Amazon QuickSight role of the user.
String	roleAsString() The Amazon QuickSight role of the user.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateUserRequest.Builder>	serializableBuilderClass()
UpdateUserRequest.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 update.

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

userName

public String userName()

The Amazon QuickSight user name that you want to update.

Returns:

The Amazon QuickSight user name that you want to update.

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.

email

public String email()

The email address of the user that you want to update.

Returns:

The email address of the user that you want to update.

role

public UserRole role()

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, role will return UserRole.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from roleAsString().

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

roleAsString

public String roleAsString()

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, role will return UserRole.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from roleAsString().

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

toBuilder

public UpdateUserRequest.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<UpdateUserRequest.Builder,UpdateUserRequest>

Specified by:

toBuilder in class QuickSightRequest

Returns:

a builder for type T

builder

public static UpdateUserRequest.Builder builder()

serializableBuilderClass

public static Class<? extends UpdateUserRequest.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.