Class AdminUpdateUserAttributesRequest
- java.lang.Object
-
- com.amazonaws.AmazonWebServiceRequest
-
- com.amazonaws.services.cognitoidp.model.AdminUpdateUserAttributesRequest
-
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
public class AdminUpdateUserAttributesRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
Represents the request to update the user's attributes as an administrator.
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
-
Constructor Summary
Constructors Constructor Description AdminUpdateUserAttributesRequest()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AdminUpdateUserAttributesRequest
clone()
Creates a shallow clone of this request.boolean
equals(Object obj)
List<AttributeType>
getUserAttributes()
An array of name-value pairs representing user attributes.String
getUsername()
The user name of the user for whom you want to update user attributes.String
getUserPoolId()
The user pool ID for the user pool where you want to update user attributes.int
hashCode()
void
setUserAttributes(Collection<AttributeType> userAttributes)
An array of name-value pairs representing user attributes.void
setUsername(String username)
The user name of the user for whom you want to update user attributes.void
setUserPoolId(String userPoolId)
The user pool ID for the user pool where you want to update user attributes.String
toString()
Returns a string representation of this object; useful for testing and debugging.AdminUpdateUserAttributesRequest
withUserAttributes(AttributeType... userAttributes)
An array of name-value pairs representing user attributes.AdminUpdateUserAttributesRequest
withUserAttributes(Collection<AttributeType> userAttributes)
An array of name-value pairs representing user attributes.AdminUpdateUserAttributesRequest
withUsername(String username)
The user name of the user for whom you want to update user attributes.AdminUpdateUserAttributesRequest
withUserPoolId(String userPoolId)
The user pool ID for the user pool where you want to update 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
-
-
-
-
Method Detail
-
setUserPoolId
public void setUserPoolId(String userPoolId)
The user pool ID for the user pool where you want to update user attributes.
- Parameters:
userPoolId
- The user pool ID for the user pool where you want to update user attributes.
-
getUserPoolId
public String getUserPoolId()
The user pool ID for the user pool where you want to update user attributes.
- Returns:
- The user pool ID for the user pool where you want to update user attributes.
-
withUserPoolId
public AdminUpdateUserAttributesRequest withUserPoolId(String userPoolId)
The user pool ID for the user pool where you want to update user attributes.
- Parameters:
userPoolId
- The user pool ID for the user pool where you want to update 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 for whom you want to update user attributes.
- Parameters:
username
- The user name of the user for whom you want to update user attributes.
-
getUsername
public String getUsername()
The user name of the user for whom you want to update user attributes.
- Returns:
- The user name of the user for whom you want to update user attributes.
-
withUsername
public AdminUpdateUserAttributesRequest withUsername(String username)
The user name of the user for whom you want to update user attributes.
- Parameters:
username
- The user name of the user for whom you want to update user attributes.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getUserAttributes
public List<AttributeType> getUserAttributes()
An array of name-value pairs representing user attributes.
- Returns:
- An array of name-value pairs representing user attributes.
-
setUserAttributes
public void setUserAttributes(Collection<AttributeType> userAttributes)
An array of name-value pairs representing user attributes.
- Parameters:
userAttributes
- An array of name-value pairs representing user attributes.
-
withUserAttributes
public AdminUpdateUserAttributesRequest withUserAttributes(AttributeType... userAttributes)
An array of name-value pairs representing user attributes.
NOTE: This method appends the values to the existing list (if any). Use
setUserAttributes(java.util.Collection)
orwithUserAttributes(java.util.Collection)
if you want to override the existing values.- Parameters:
userAttributes
- An array of name-value pairs representing user attributes.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withUserAttributes
public AdminUpdateUserAttributesRequest withUserAttributes(Collection<AttributeType> userAttributes)
An array of name-value pairs representing user attributes.
- Parameters:
userAttributes
- An array of name-value pairs representing user attributes.- 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 classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public AdminUpdateUserAttributesRequest 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:
Object.clone()
-
-