Package 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("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	Description
static interface	AdminDeleteUserAttributesRequest.Builder

Method Summary

Modifier and Type	Method	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()	For responses, this returns true if the service returned a value for the UserAttributeNames property.
Map<String,SdkField<?>>	sdkFieldNameToField()
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 want to delete.
String	username()	The username of the user that you want to query or modify.
String	userPoolId()	The ID of 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 ID of the user pool where you want to delete user attributes.

Returns:

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

username

public final String username()

The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.

Returns:

The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.

hasUserAttributeNames

public final boolean hasUserAttributeNames()

For responses, this returns true if the service returned a value for the UserAttributeNames property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

userAttributeNames

public final List<String> userAttributeNames()

An array of strings representing the user attribute names you want 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.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasUserAttributeNames() method.

Returns:

An array of strings representing the user attribute names you want 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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo