Class AdminDeleteUserAttributesRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
Represents the request to delete user attributes as an administrator.
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
Creates a shallow clone of this request.boolean
An array of strings representing the user attribute names you wish to delete.The user name of the user from which you would like to delete attributes.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.toString()
Returns a string representation of this object; useful for testing and debugging.withUserAttributeNames
(String... userAttributeNames) An array of strings representing the user attribute names you wish to delete.withUserAttributeNames
(Collection<String> userAttributeNames) An array of strings representing the user attribute names you wish to delete.withUsername
(String username) The user name of the user from which you would like to delete attributes.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
-
Constructor Details
-
AdminDeleteUserAttributesRequest
public AdminDeleteUserAttributesRequest()
-
-
Method Details
-
setUserPoolId
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
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
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
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
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
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
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
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
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)
orwithUserAttributeNames(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
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
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 classAmazonWebServiceRequest
- See Also:
-