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:
  • Constructor Details

    • AdminUpdateUserAttributesRequest

      public AdminUpdateUserAttributesRequest()
  • Method Details

    • 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) or withUserAttributes(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 class Object
      Returns:
      A string representation of this object.
      See Also:
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • 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: