/* * Copyright 2010-2023 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.sns.model; import java.io.Serializable; import com.amazonaws.AmazonWebServiceRequest; /** *

* Adds a destination phone number to an Amazon Web Services account in the SMS * sandbox and sends a one-time password (OTP) to that phone number. *

*

* When you start using Amazon SNS to send SMS messages, your Amazon Web * Services account is in the SMS sandbox. The SMS sandbox provides a * safe environment for you to try Amazon SNS features without risking your * reputation as an SMS sender. While your Amazon Web Services account is in the * SMS sandbox, you can use all of the features of Amazon SNS. However, you can * send SMS messages only to verified destination phone numbers. For more * information, including how to move out of the sandbox to send messages * without restrictions, see SMS * sandbox in the Amazon SNS Developer Guide. *

*/ public class CreateSMSSandboxPhoneNumberRequest extends AmazonWebServiceRequest implements Serializable { /** *

* The destination phone number to verify. On verification, Amazon SNS adds * this phone number to the list of verified phone numbers that you can send * SMS messages to. *

*

* Constraints:
* Length: - 20
* Pattern: ^(\+[0-9]{8,}|[0-9]{0,9})$
*/ private String phoneNumber; /** *

* The language to use for sending the OTP. The default value is * en-US. *

*

* Constraints:
* Allowed Values: en-US, en-GB, es-419, es-ES, de-DE, fr-CA, fr-FR, * it-IT, ja-JP, pt-BR, kr-KR, zh-CN, zh-TW */ private String languageCode; /** *

* The destination phone number to verify. On verification, Amazon SNS adds * this phone number to the list of verified phone numbers that you can send * SMS messages to. *

*

* Constraints:
* Length: - 20
* Pattern: ^(\+[0-9]{8,}|[0-9]{0,9})$
* * @return

* The destination phone number to verify. On verification, Amazon * SNS adds this phone number to the list of verified phone numbers * that you can send SMS messages to. *

*/ public String getPhoneNumber() { return phoneNumber; } /** *

* The destination phone number to verify. On verification, Amazon SNS adds * this phone number to the list of verified phone numbers that you can send * SMS messages to. *

*

* Constraints:
* Length: - 20
* Pattern: ^(\+[0-9]{8,}|[0-9]{0,9})$
* * @param phoneNumber

* The destination phone number to verify. On verification, * Amazon SNS adds this phone number to the list of verified * phone numbers that you can send SMS messages to. *

*/ public void setPhoneNumber(String phoneNumber) { this.phoneNumber = phoneNumber; } /** *

* The destination phone number to verify. On verification, Amazon SNS adds * this phone number to the list of verified phone numbers that you can send * SMS messages to. *

*

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Length: - 20
* Pattern: ^(\+[0-9]{8,}|[0-9]{0,9})$
* * @param phoneNumber

* The destination phone number to verify. On verification, * Amazon SNS adds this phone number to the list of verified * phone numbers that you can send SMS messages to. *

* @return A reference to this updated object so that method calls can be * chained together. */ public CreateSMSSandboxPhoneNumberRequest withPhoneNumber(String phoneNumber) { this.phoneNumber = phoneNumber; return this; } /** *

* The language to use for sending the OTP. The default value is * en-US. *

*

* Constraints:
* Allowed Values: en-US, en-GB, es-419, es-ES, de-DE, fr-CA, fr-FR, * it-IT, ja-JP, pt-BR, kr-KR, zh-CN, zh-TW * * @return

* The language to use for sending the OTP. The default value is * en-US. *

* @see LanguageCodeString */ public String getLanguageCode() { return languageCode; } /** *

* The language to use for sending the OTP. The default value is * en-US. *

*

* Constraints:
* Allowed Values: en-US, en-GB, es-419, es-ES, de-DE, fr-CA, fr-FR, * it-IT, ja-JP, pt-BR, kr-KR, zh-CN, zh-TW * * @param languageCode

* The language to use for sending the OTP. The default value is * en-US. *

* @see LanguageCodeString */ public void setLanguageCode(String languageCode) { this.languageCode = languageCode; } /** *

* The language to use for sending the OTP. The default value is * en-US. *

*

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Allowed Values: en-US, en-GB, es-419, es-ES, de-DE, fr-CA, fr-FR, * it-IT, ja-JP, pt-BR, kr-KR, zh-CN, zh-TW * * @param languageCode

* The language to use for sending the OTP. The default value is * en-US. *

* @return A reference to this updated object so that method calls can be * chained together. * @see LanguageCodeString */ public CreateSMSSandboxPhoneNumberRequest withLanguageCode(String languageCode) { this.languageCode = languageCode; return this; } /** *

* The language to use for sending the OTP. The default value is * en-US. *

*

* Constraints:
* Allowed Values: en-US, en-GB, es-419, es-ES, de-DE, fr-CA, fr-FR, * it-IT, ja-JP, pt-BR, kr-KR, zh-CN, zh-TW * * @param languageCode

* The language to use for sending the OTP. The default value is * en-US. *

* @see LanguageCodeString */ public void setLanguageCode(LanguageCodeString languageCode) { this.languageCode = languageCode.toString(); } /** *

* The language to use for sending the OTP. The default value is * en-US. *

*

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Allowed Values: en-US, en-GB, es-419, es-ES, de-DE, fr-CA, fr-FR, * it-IT, ja-JP, pt-BR, kr-KR, zh-CN, zh-TW * * @param languageCode

* The language to use for sending the OTP. The default value is * en-US. *

* @return A reference to this updated object so that method calls can be * chained together. * @see LanguageCodeString */ public CreateSMSSandboxPhoneNumberRequest withLanguageCode(LanguageCodeString languageCode) { this.languageCode = languageCode.toString(); 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 (getPhoneNumber() != null) sb.append("PhoneNumber: " + getPhoneNumber() + ","); if (getLanguageCode() != null) sb.append("LanguageCode: " + getLanguageCode()); sb.append("}"); return sb.toString(); } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getPhoneNumber() == null) ? 0 : getPhoneNumber().hashCode()); hashCode = prime * hashCode + ((getLanguageCode() == null) ? 0 : getLanguageCode().hashCode()); return hashCode; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof CreateSMSSandboxPhoneNumberRequest == false) return false; CreateSMSSandboxPhoneNumberRequest other = (CreateSMSSandboxPhoneNumberRequest) obj; if (other.getPhoneNumber() == null ^ this.getPhoneNumber() == null) return false; if (other.getPhoneNumber() != null && other.getPhoneNumber().equals(this.getPhoneNumber()) == false) return false; if (other.getLanguageCode() == null ^ this.getLanguageCode() == null) return false; if (other.getLanguageCode() != null && other.getLanguageCode().equals(this.getLanguageCode()) == false) return false; return true; } }