com.amazonaws.services.cognitoidp.model.SetUserMFAPreferenceRequest Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-cognitoidp Show documentation
The AWS Java SDK for Amazon Cognito Identity Provider Service module holds the client classes that are used for communicating with Amazon Cognito Identity Provider Service.
There is a newer version: 1.12.778
Show newest version
/*
 * 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;

/**
 * 
 * @see AWS
 *      API Documentation
 */
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class SetUserMFAPreferenceRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {

    /**
     * 
     * The SMS text message multi-factor authentication (MFA) settings.
     * 
     */
    private SMSMfaSettingsType sMSMfaSettings;
    /**
     * 
     * The time-based one-time password (TOTP) software token MFA settings.
     * 
     */
    private SoftwareTokenMfaSettingsType softwareTokenMfaSettings;
    /**
     * 
     * A valid access token that Amazon Cognito issued to the user whose MFA preference you want to set.
     * 
     */
    private String accessToken;

    /**
     * 
     * The SMS text message multi-factor authentication (MFA) settings.
     * 
     * 
     * @param sMSMfaSettings
     *        The SMS text message multi-factor authentication (MFA) settings.
     */

    public void setSMSMfaSettings(SMSMfaSettingsType sMSMfaSettings) {
        this.sMSMfaSettings = sMSMfaSettings;
    }

    /**
     * 
     * The SMS text message multi-factor authentication (MFA) settings.
     * 
     * 
     * @return The SMS text message multi-factor authentication (MFA) settings.
     */

    public SMSMfaSettingsType getSMSMfaSettings() {
        return this.sMSMfaSettings;
    }

    /**
     * 
     * The SMS text message multi-factor authentication (MFA) settings.
     * 
     * 
     * @param sMSMfaSettings
     *        The SMS text message multi-factor authentication (MFA) settings.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public SetUserMFAPreferenceRequest withSMSMfaSettings(SMSMfaSettingsType sMSMfaSettings) {
        setSMSMfaSettings(sMSMfaSettings);
        return this;
    }

    /**
     * 
     * The time-based one-time password (TOTP) software token MFA settings.
     * 
     * 
     * @param softwareTokenMfaSettings
     *        The time-based one-time password (TOTP) software token MFA settings.
     */

    public void setSoftwareTokenMfaSettings(SoftwareTokenMfaSettingsType softwareTokenMfaSettings) {
        this.softwareTokenMfaSettings = softwareTokenMfaSettings;
    }

    /**
     * 
     * The time-based one-time password (TOTP) software token MFA settings.
     * 
     * 
     * @return The time-based one-time password (TOTP) software token MFA settings.
     */

    public SoftwareTokenMfaSettingsType getSoftwareTokenMfaSettings() {
        return this.softwareTokenMfaSettings;
    }

    /**
     * 
     * The time-based one-time password (TOTP) software token MFA settings.
     * 
     * 
     * @param softwareTokenMfaSettings
     *        The time-based one-time password (TOTP) software token MFA settings.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public SetUserMFAPreferenceRequest withSoftwareTokenMfaSettings(SoftwareTokenMfaSettingsType softwareTokenMfaSettings) {
        setSoftwareTokenMfaSettings(softwareTokenMfaSettings);
        return this;
    }

    /**
     * 
     * A valid access token that Amazon Cognito issued to the user whose MFA preference you want to set.
     * 
     * 
     * @param accessToken
     *        A valid access token that Amazon Cognito issued to the user whose MFA preference you want to set.
     */

    public void setAccessToken(String accessToken) {
        this.accessToken = accessToken;
    }

    /**
     * 
     * A valid access token that Amazon Cognito issued to the user whose MFA preference you want to set.
     * 
     * 
     * @return A valid access token that Amazon Cognito issued to the user whose MFA preference you want to set.
     */

    public String getAccessToken() {
        return this.accessToken;
    }

    /**
     * 
     * A valid access token that Amazon Cognito issued to the user whose MFA preference you want to set.
     * 
     * 
     * @param accessToken
     *        A valid access token that Amazon Cognito issued to the user whose MFA preference you want to set.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public SetUserMFAPreferenceRequest 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 (getSMSMfaSettings() != null)
            sb.append("SMSMfaSettings: ").append(getSMSMfaSettings()).append(",");
        if (getSoftwareTokenMfaSettings() != null)
            sb.append("SoftwareTokenMfaSettings: ").append(getSoftwareTokenMfaSettings()).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 SetUserMFAPreferenceRequest == false)
            return false;
        SetUserMFAPreferenceRequest other = (SetUserMFAPreferenceRequest) obj;
        if (other.getSMSMfaSettings() == null ^ this.getSMSMfaSettings() == null)
            return false;
        if (other.getSMSMfaSettings() != null && other.getSMSMfaSettings().equals(this.getSMSMfaSettings()) == false)
            return false;
        if (other.getSoftwareTokenMfaSettings() == null ^ this.getSoftwareTokenMfaSettings() == null)
            return false;
        if (other.getSoftwareTokenMfaSettings() != null && other.getSoftwareTokenMfaSettings().equals(this.getSoftwareTokenMfaSettings()) == 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 + ((getSMSMfaSettings() == null) ? 0 : getSMSMfaSettings().hashCode());
        hashCode = prime * hashCode + ((getSoftwareTokenMfaSettings() == null) ? 0 : getSoftwareTokenMfaSettings().hashCode());
        hashCode = prime * hashCode + ((getAccessToken() == null) ? 0 : getAccessToken().hashCode());
        return hashCode;
    }

    @Override
    public SetUserMFAPreferenceRequest clone() {
        return (SetUserMFAPreferenceRequest) super.clone();
    }

}