/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.cognitoidp.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; /** *
* Represents the request to delete user attributes as an administrator. *
* * @see AWS API Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class AdminDeleteUserAttributesRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** ** The user pool ID for the user pool where you want to delete user attributes. *
*/ private String userPoolId; /** ** The user name of the user from which you would like to delete attributes. *
*/ private String username; /** ** 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.
*
* The user pool ID for the user pool where you want to delete user attributes. *
* * @param userPoolId * The user pool ID for the user pool where you want to delete user attributes. */ public void setUserPoolId(String userPoolId) { this.userPoolId = userPoolId; } /** ** The user pool ID for the user pool where you want to delete user attributes. *
* * @return The user pool ID for the user pool where you want to delete user attributes. */ public String getUserPoolId() { return this.userPoolId; } /** ** The user pool ID for the user pool where you want to delete user attributes. *
* * @param userPoolId * The user pool ID for the user pool where you want to delete user attributes. * @return Returns a reference to this object so that method calls can be chained together. */ public AdminDeleteUserAttributesRequest withUserPoolId(String userPoolId) { setUserPoolId(userPoolId); return this; } /** ** The user name of the user from which you would like to delete attributes. *
* * @param username * The user name of the user from which you would like to delete attributes. */ public void setUsername(String username) { this.username = username; } /** ** The user name of the user from which you would like to delete attributes. *
* * @return The user name of the user from which you would like to delete attributes. */ public String getUsername() { return this.username; } /** ** The user name of the user from which you would like to delete attributes. *
* * @param username * The user name of the user from which you would like to delete attributes. * @return Returns a reference to this object so that method calls can be chained together. */ public AdminDeleteUserAttributesRequest withUsername(String username) { setUsername(username); return this; } /** ** 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
* 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 java.util.Listcustom:
prefix to the attribute name.
*
* For custom attributes, you must prepend the
* An array of strings representing the user attribute names you want to delete.
*
* For custom attributes, you must prepend the
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setUserAttributeNames(java.util.Collection)} or {@link #withUserAttributeNames(java.util.Collection)} if
* you want to override the existing values.
* custom:
prefix to the attribute name.
*/
public void setUserAttributeNames(java.util.Collectioncustom:
prefix to the attribute name.
*
* For custom attributes, you must prepend the
* 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AdminDeleteUserAttributesRequest withUserAttributeNames(String... userAttributeNames) {
if (this.userAttributeNames == null) {
setUserAttributeNames(new java.util.ArrayListcustom:
prefix to the attribute name.
*
* For custom attributes, you must prepend the custom:
prefix to the attribute name.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AdminDeleteUserAttributesRequest withUserAttributeNames(java.util.Collection