com.amazonaws.services.cognitoidp.model.AdminSetUserSettingsRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-cognitoidp Show documentation
/*
* Copyright 2010-2016 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 com.amazonaws.AmazonWebServiceRequest;
/**
*
* Represents the request to set user settings as an administrator.
*
*/
public class AdminSetUserSettingsRequest extends AmazonWebServiceRequest
implements Serializable, Cloneable {
/**
*
* The user pool ID for the user pool where you want to set the user's
* settings, such as MFA options.
*
*/
private String userPoolId;
/**
*
* The user name of the user for whom you wish to set user settings.
*
*/
private String username;
/**
*
* Specifies the options for MFA (e.g., email or phone number).
*
*/
private java.util.List mFAOptions;
/**
*
* The user pool ID for the user pool where you want to set the user's
* settings, such as MFA options.
*
*
* @param userPoolId
* The user pool ID for the user pool where you want to set the
* user's settings, such as MFA options.
*/
public void setUserPoolId(String userPoolId) {
this.userPoolId = userPoolId;
}
/**
*
* The user pool ID for the user pool where you want to set the user's
* settings, such as MFA options.
*
*
* @return The user pool ID for the user pool where you want to set the
* user's settings, such as MFA options.
*/
public String getUserPoolId() {
return this.userPoolId;
}
/**
*
* The user pool ID for the user pool where you want to set the user's
* settings, such as MFA options.
*
*
* @param userPoolId
* The user pool ID for the user pool where you want to set the
* user's settings, such as MFA options.
* @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 user name of the user for whom you wish to set user settings.
*
*
* @param username
* The user name of the user for whom you wish to set user settings.
*/
public void setUsername(String username) {
this.username = username;
}
/**
*
* The user name of the user for whom you wish to set user settings.
*
*
* @return The user name of the user for whom you wish to set user settings.
*/
public String getUsername() {
return this.username;
}
/**
*
* The user name of the user for whom you wish to set user settings.
*
*
* @param username
* The user name of the user for whom you wish to set user settings.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public AdminSetUserSettingsRequest withUsername(String username) {
setUsername(username);
return this;
}
/**
*
* Specifies the options for MFA (e.g., email or phone number).
*
*
* @return Specifies the options for MFA (e.g., email or phone number).
*/
public java.util.List getMFAOptions() {
return mFAOptions;
}
/**
*
* Specifies the options for MFA (e.g., email or phone number).
*
*
* @param mFAOptions
* Specifies the options for MFA (e.g., email or phone number).
*/
public void setMFAOptions(java.util.Collection mFAOptions) {
if (mFAOptions == null) {
this.mFAOptions = null;
return;
}
this.mFAOptions = new java.util.ArrayList(mFAOptions);
}
/**
*
* Specifies the options for MFA (e.g., email or phone number).
*
*
* 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
* Specifies the options for MFA (e.g., email or phone number).
* @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;
}
/**
*
* Specifies the options for MFA (e.g., email or phone number).
*
*
* @param mFAOptions
* Specifies the options for MFA (e.g., email or phone number).
* @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; useful for testing and
* debugging.
*
* @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: " + getUserPoolId() + ",");
if (getUsername() != null)
sb.append("Username: " + getUsername() + ",");
if (getMFAOptions() != null)
sb.append("MFAOptions: " + 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();
}
}