@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.
NOOP
Constructor and Description |
---|
AdminDeleteUserAttributesRequest() |
Modifier and Type | Method and Description |
---|---|
AdminDeleteUserAttributesRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
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.
|
addHandlerContext, 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
public void setUserPoolId(String userPoolId)
The user pool ID for the user pool where you want to delete user attributes.
userPoolId
- The user pool ID for the user pool where you want to delete user attributes.public String getUserPoolId()
The user pool ID for the user pool where you want to delete user attributes.
public AdminDeleteUserAttributesRequest withUserPoolId(String userPoolId)
The user pool ID for the user pool where you want to delete user attributes.
userPoolId
- The user pool ID for the user pool where you want to delete user attributes.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, this value must be the sub
of a local user or the username of a user from a third-party
IdP.
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, this value must be the sub
of a local user or the username of a
user from a third-party IdP.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, this value must be the sub
of a local user or the username of a user from a third-party
IdP.
username
isn't an alias
attribute in your user pool, this value must be the sub
of a local user or the username of a
user from a third-party IdP.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, this value must be the sub
of a local user or the username of a user from a third-party
IdP.
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, this value must be the sub
of a local user or the username of a
user from a third-party IdP.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.
For custom attributes, you must prepend the custom:
prefix to the attribute name.
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.
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.
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.
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.
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.
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.
public String toString()
toString
in class Object
Object.toString()
public AdminDeleteUserAttributesRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()