com.amazonaws.services.cognitoidp.model

Class AdminDeleteUserAttributesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitoidp.model.AdminDeleteUserAttributesRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AdminDeleteUserAttributesRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Represents the request to delete user attributes as an administrator.

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
AdminDeleteUserAttributesRequest()

Method Summary

Modifier and Type	Method and Description
AdminDeleteUserAttributesRequest	clone()
boolean	equals(Object obj)
List<String>	getUserAttributeNames() An array of strings representing the user attribute names you want to delete.
String	getUsername() The username of the user that you want to query or modify.
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 want to delete.
void	setUsername(String username) The username of the user that you want to query or modify.
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.
AdminDeleteUserAttributesRequest	withUserAttributeNames(Collection<String> userAttributeNames) An array of strings representing the user attribute names you want to delete.
AdminDeleteUserAttributesRequest	withUserAttributeNames(String... userAttributeNames) An array of strings representing the user attribute names you want to delete.
AdminDeleteUserAttributesRequest	withUsername(String username) The username of the user that you want to query or modify.
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

addHandlerContext, copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, 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 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, you can also use their sub in this request.

Parameters:

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, you can also use their sub in this request.

getUsername

public String getUsername()

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, you can also use their sub in this request.

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, you can also use their sub in this request.

withUsername

public AdminDeleteUserAttributesRequest withUsername(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, you can also use their sub in this request.

Parameters:

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, you can also use their sub in this request.

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 want to delete.

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

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.

setUserAttributeNames

public void setUserAttributeNames(Collection<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.

Parameters:

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.

withUserAttributeNames

public AdminDeleteUserAttributesRequest withUserAttributeNames(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.

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 want to delete.

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

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 want to delete.

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

Parameters:

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.

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. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

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()

Overrides:

clone in class AmazonWebServiceRequest