Package com.amazonaws.services.cognitoidp.model

Class AdminDeleteUserAttributesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitoidp.model.AdminDeleteUserAttributesRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class AdminDeleteUserAttributesRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Represents the request to delete user attributes as an administrator.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor	Description
AdminDeleteUserAttributesRequest()

Method Summary

Modifier and Type	Method	Description
AdminDeleteUserAttributesRequest	clone()	Creates a shallow clone of this request.
boolean	equals(Object obj)
List<String>	getUserAttributeNames()	An array of strings representing the user attribute names you wish to delete.
String	getUsername()	The user name of the user from which you would like to delete attributes.
String	getUserPoolId()	The user pool ID for the user pool where you want to delete user attributes.
int	hashCode()
void	setUserAttributeNames(Collection<String> userAttributeNames)	An array of strings representing the user attribute names you wish to delete.
void	setUsername(String username)	The user name of the user from which you would like to delete attributes.
void	setUserPoolId(String userPoolId)	The user pool ID for the user pool where you want to delete user attributes.
String	toString()	Returns a string representation of this object; useful for testing and debugging.
AdminDeleteUserAttributesRequest	withUserAttributeNames(String... userAttributeNames)	An array of strings representing the user attribute names you wish to delete.
AdminDeleteUserAttributesRequest	withUserAttributeNames(Collection<String> userAttributeNames)	An array of strings representing the user attribute names you wish to delete.
AdminDeleteUserAttributesRequest	withUsername(String username)	The user name of the user from which you would like to delete attributes.
AdminDeleteUserAttributesRequest	withUserPoolId(String userPoolId)	The user pool ID for the user pool where you want to delete user attributes.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AdminDeleteUserAttributesRequest

public AdminDeleteUserAttributesRequest()

Method Detail

setUserPoolId

public void setUserPoolId(String userPoolId)

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

Parameters:

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

getUserPoolId

public String getUserPoolId()

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.

withUserPoolId

public AdminDeleteUserAttributesRequest withUserPoolId(String userPoolId)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setUsername

public void setUsername(String username)

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

Parameters:

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

getUsername

public String getUsername()

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.

withUsername

public AdminDeleteUserAttributesRequest withUsername(String username)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

getUserAttributeNames

public List<String> getUserAttributeNames()

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

Returns:

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

setUserAttributeNames

public void setUserAttributeNames(Collection<String> userAttributeNames)

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

Parameters:

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

withUserAttributeNames

public AdminDeleteUserAttributesRequest withUserAttributeNames(String... userAttributeNames)

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

NOTE: This method appends the values to the existing list (if any). Use setUserAttributeNames(java.util.Collection) or withUserAttributeNames(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

withUserAttributeNames

public AdminDeleteUserAttributesRequest withUserAttributeNames(Collection<String> userAttributeNames)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public AdminDeleteUserAttributesRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()