software.amazon.awssdk.services.cognitoidentityprovider.model

Class AdminDeleteUserAttributesRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderRequest

software.amazon.awssdk.services.cognitoidentityprovider.model.AdminDeleteUserAttributesRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<AdminDeleteUserAttributesRequest.Builder,AdminDeleteUserAttributesRequest>

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

Represents the request to delete user attributes as an administrator.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AdminDeleteUserAttributesRequest.Builder

Method Summary

Modifier and Type	Method and Description
static AdminDeleteUserAttributesRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasUserAttributeNames() Returns true if the UserAttributeNames property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
List<SdkField<?>>	sdkFields()
static Class<? extends AdminDeleteUserAttributesRequest.Builder>	serializableBuilderClass()
AdminDeleteUserAttributesRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
List<String>	userAttributeNames() An array of strings representing the user attribute names you wish to delete.
String	username() The user name of the user from which you would like to delete attributes.
String	userPoolId() The user pool ID for the user pool where you want to delete user attributes.

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

userPoolId

public final String userPoolId()

The user pool ID for the user pool where you want to delete user attributes.

Returns:

The user pool ID for the user pool where you want to delete user attributes.

username

public final String username()

The user name of the user from which you would like to delete attributes.

Returns:

The user name of the user from which you would like to delete attributes.

hasUserAttributeNames

public final boolean hasUserAttributeNames()

Returns true if the UserAttributeNames property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

userAttributeNames

public final List<String> userAttributeNames()

An array of strings representing the user attribute names you wish to delete.

For custom attributes, you must prepend the custom: prefix to the attribute name.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasUserAttributeNames() to see if a value was sent in this field.

Returns:

An array of strings representing the user attribute names you wish to delete.

For custom attributes, you must prepend the custom: prefix to the attribute name.

toBuilder

public AdminDeleteUserAttributesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AdminDeleteUserAttributesRequest.Builder,AdminDeleteUserAttributesRequest>

Specified by:

toBuilder in class CognitoIdentityProviderRequest

builder

public static AdminDeleteUserAttributesRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo