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)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
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()
String	toString() Returns a string representation of this object.
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

clone, finalize, 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()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateUserRequest.Builder,UpdateUserRequest>

Specified by:

toBuilder in class QuickSightRequest

builder

public static UpdateUserRequest.Builder builder()

serializableBuilderClass

public static Class<? extends UpdateUserRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo