com.amazonaws.services.cognitoidp.model.DeleteUserAttributesRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-cognitoidp Show documentation
/*
* Copyright 2019-2024 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.
*
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DeleteUserAttributesRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* An array of strings representing the user attribute names you want to delete.
*
*
* For custom attributes, you must prependattach the custom: prefix to the front of the attribute name.
*
*/
private java.util.List userAttributeNames;
/**
*
* A valid access token that Amazon Cognito issued to the user whose attributes you want to delete.
*
*/
private String accessToken;
/**
*
* An array of strings representing the user attribute names you want to delete.
*
*
* For custom attributes, you must prependattach the custom: prefix to the front of the attribute name.
*
*
* @return An array of strings representing the user attribute names you want to delete.
*
* For custom attributes, you must prependattach the custom: prefix to the front of the
* attribute name.
*/
public java.util.List getUserAttributeNames() {
return userAttributeNames;
}
/**
*
* An array of strings representing the user attribute names you want to delete.
*
*
* For custom attributes, you must prependattach the custom: prefix to the front of the attribute name.
*
*
* @param userAttributeNames
* An array of strings representing the user attribute names you want to delete.
*
* For custom attributes, you must prependattach the custom: prefix to the front of the
* attribute name.
*/
public void setUserAttributeNames(java.util.Collection userAttributeNames) {
if (userAttributeNames == null) {
this.userAttributeNames = null;
return;
}
this.userAttributeNames = new java.util.ArrayList(userAttributeNames);
}
/**
*
* An array of strings representing the user attribute names you want to delete.
*
*
* For custom attributes, you must prependattach the custom: prefix to the front of the attribute name.
*
*
* 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.
*
*
* @param userAttributeNames
* An array of strings representing the user attribute names you want to delete.
*
* For custom attributes, you must prependattach the custom: prefix to the front of the
* attribute name.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DeleteUserAttributesRequest withUserAttributeNames(String... userAttributeNames) {
if (this.userAttributeNames == null) {
setUserAttributeNames(new java.util.ArrayList(userAttributeNames.length));
}
for (String ele : userAttributeNames) {
this.userAttributeNames.add(ele);
}
return this;
}
/**
*
* An array of strings representing the user attribute names you want to delete.
*
*
* For custom attributes, you must prependattach the custom: prefix to the front of the attribute name.
*
*
* @param userAttributeNames
* An array of strings representing the user attribute names you want to delete.
*
* For custom attributes, you must prependattach the custom: prefix to the front of the
* attribute name.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DeleteUserAttributesRequest withUserAttributeNames(java.util.Collection userAttributeNames) {
setUserAttributeNames(userAttributeNames);
return this;
}
/**
*
* A valid access token that Amazon Cognito issued to the user whose attributes you want to delete.
*
*
* @param accessToken
* A valid access token that Amazon Cognito issued to the user whose attributes you want to delete.
*/
public void setAccessToken(String accessToken) {
this.accessToken = accessToken;
}
/**
*
* A valid access token that Amazon Cognito issued to the user whose attributes you want to delete.
*
*
* @return A valid access token that Amazon Cognito issued to the user whose attributes you want to delete.
*/
public String getAccessToken() {
return this.accessToken;
}
/**
*
* A valid access token that Amazon Cognito issued to the user whose attributes you want to delete.
*
*
* @param accessToken
* A valid access token that Amazon Cognito issued to the user whose attributes you want to delete.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DeleteUserAttributesRequest withAccessToken(String accessToken) {
setAccessToken(accessToken);
return this;
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getUserAttributeNames() != null)
sb.append("UserAttributeNames: ").append(getUserAttributeNames()).append(",");
if (getAccessToken() != null)
sb.append("AccessToken: ").append("***Sensitive Data Redacted***");
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DeleteUserAttributesRequest == false)
return false;
DeleteUserAttributesRequest other = (DeleteUserAttributesRequest) obj;
if (other.getUserAttributeNames() == null ^ this.getUserAttributeNames() == null)
return false;
if (other.getUserAttributeNames() != null && other.getUserAttributeNames().equals(this.getUserAttributeNames()) == false)
return false;
if (other.getAccessToken() == null ^ this.getAccessToken() == null)
return false;
if (other.getAccessToken() != null && other.getAccessToken().equals(this.getAccessToken()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getUserAttributeNames() == null) ? 0 : getUserAttributeNames().hashCode());
hashCode = prime * hashCode + ((getAccessToken() == null) ? 0 : getAccessToken().hashCode());
return hashCode;
}
@Override
public DeleteUserAttributesRequest clone() {
return (DeleteUserAttributesRequest) super.clone();
}
}