com.amazonaws.services.cognitoidp.model.SetUserSettingsRequest 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 set user settings.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class SetUserSettingsRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* A valid access token that Amazon Cognito issued to the user whose user settings you want to configure.
*
*/
private String accessToken;
/**
*
* You can use this parameter only to set an SMS configuration that uses SMS for delivery.
*
*/
private java.util.List mFAOptions;
/**
*
* A valid access token that Amazon Cognito issued to the user whose user settings you want to configure.
*
*
* @param accessToken
* A valid access token that Amazon Cognito issued to the user whose user settings you want to configure.
*/
public void setAccessToken(String accessToken) {
this.accessToken = accessToken;
}
/**
*
* A valid access token that Amazon Cognito issued to the user whose user settings you want to configure.
*
*
* @return A valid access token that Amazon Cognito issued to the user whose user settings you want to configure.
*/
public String getAccessToken() {
return this.accessToken;
}
/**
*
* A valid access token that Amazon Cognito issued to the user whose user settings you want to configure.
*
*
* @param accessToken
* A valid access token that Amazon Cognito issued to the user whose user settings you want to configure.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SetUserSettingsRequest withAccessToken(String accessToken) {
setAccessToken(accessToken);
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 SetUserSettingsRequest 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 SetUserSettingsRequest 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 (getAccessToken() != null)
sb.append("AccessToken: ").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 SetUserSettingsRequest == false)
return false;
SetUserSettingsRequest other = (SetUserSettingsRequest) obj;
if (other.getAccessToken() == null ^ this.getAccessToken() == null)
return false;
if (other.getAccessToken() != null && other.getAccessToken().equals(this.getAccessToken()) == 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 + ((getAccessToken() == null) ? 0 : getAccessToken().hashCode());
hashCode = prime * hashCode + ((getMFAOptions() == null) ? 0 : getMFAOptions().hashCode());
return hashCode;
}
@Override
public SetUserSettingsRequest clone() {
return (SetUserSettingsRequest) super.clone();
}
}