com.amazonaws.services.cognitoidp.model.AdminSetUserSettingsRequest 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;
/**
*
* You can use this parameter to set an MFA configuration that uses the SMS delivery medium.
*
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class AdminSetUserSettingsRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The ID of the user pool that contains the user whose options you're setting.
*
*/
private String userPoolId;
/**
*
* 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.
*
*/
private String username;
/**
*
* You can use this parameter only to set an SMS configuration that uses SMS for delivery.
*
*/
private java.util.List mFAOptions;
/**
*
* The ID of the user pool that contains the user whose options you're setting.
*
*
* @param userPoolId
* The ID of the user pool that contains the user whose options you're setting.
*/
public void setUserPoolId(String userPoolId) {
this.userPoolId = userPoolId;
}
/**
*
* The ID of the user pool that contains the user whose options you're setting.
*
*
* @return The ID of the user pool that contains the user whose options you're setting.
*/
public String getUserPoolId() {
return this.userPoolId;
}
/**
*
* The ID of the user pool that contains the user whose options you're setting.
*
*
* @param userPoolId
* The ID of the user pool that contains the user whose options you're setting.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AdminSetUserSettingsRequest withUserPoolId(String userPoolId) {
setUserPoolId(userPoolId);
return this;
}
/**
*
* 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.
*
*
* @param 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 void setUsername(String username) {
this.username = 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.
*
*
* @return 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() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AdminSetUserSettingsRequest withUsername(String username) {
setUsername(username);
return this;
}
/**
*
* You can use this parameter only to set an SMS configuration that uses SMS for delivery.
*
*
* @return You can use this parameter only to set an SMS configuration that uses SMS for delivery.
*/
public java.util.List getMFAOptions() {
return mFAOptions;
}
/**
*
* You can use this parameter only to set an SMS configuration that uses SMS for delivery.
*
*
* @param mFAOptions
* You can use this parameter only to set an SMS configuration that uses SMS for delivery.
*/
public void setMFAOptions(java.util.Collection mFAOptions) {
if (mFAOptions == null) {
this.mFAOptions = null;
return;
}
this.mFAOptions = new java.util.ArrayList(mFAOptions);
}
/**
*
* You can use this parameter only to set an SMS configuration that uses SMS for delivery.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setMFAOptions(java.util.Collection)} or {@link #withMFAOptions(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param mFAOptions
* You can use this parameter only to set an SMS configuration that uses SMS for delivery.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AdminSetUserSettingsRequest withMFAOptions(MFAOptionType... mFAOptions) {
if (this.mFAOptions == null) {
setMFAOptions(new java.util.ArrayList(mFAOptions.length));
}
for (MFAOptionType ele : mFAOptions) {
this.mFAOptions.add(ele);
}
return this;
}
/**
*
* You can use this parameter only to set an SMS configuration that uses SMS for delivery.
*
*
* @param mFAOptions
* You can use this parameter only to set an SMS configuration that uses SMS for delivery.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AdminSetUserSettingsRequest withMFAOptions(java.util.Collection mFAOptions) {
setMFAOptions(mFAOptions);
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 (getUserPoolId() != null)
sb.append("UserPoolId: ").append(getUserPoolId()).append(",");
if (getUsername() != null)
sb.append("Username: ").append("***Sensitive Data Redacted***").append(",");
if (getMFAOptions() != null)
sb.append("MFAOptions: ").append(getMFAOptions());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof AdminSetUserSettingsRequest == false)
return false;
AdminSetUserSettingsRequest other = (AdminSetUserSettingsRequest) obj;
if (other.getUserPoolId() == null ^ this.getUserPoolId() == null)
return false;
if (other.getUserPoolId() != null && other.getUserPoolId().equals(this.getUserPoolId()) == false)
return false;
if (other.getUsername() == null ^ this.getUsername() == null)
return false;
if (other.getUsername() != null && other.getUsername().equals(this.getUsername()) == false)
return false;
if (other.getMFAOptions() == null ^ this.getMFAOptions() == null)
return false;
if (other.getMFAOptions() != null && other.getMFAOptions().equals(this.getMFAOptions()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getUserPoolId() == null) ? 0 : getUserPoolId().hashCode());
hashCode = prime * hashCode + ((getUsername() == null) ? 0 : getUsername().hashCode());
hashCode = prime * hashCode + ((getMFAOptions() == null) ? 0 : getMFAOptions().hashCode());
return hashCode;
}
@Override
public AdminSetUserSettingsRequest clone() {
return (AdminSetUserSettingsRequest) super.clone();
}
}