com.amazonaws.services.pinpointsmsvoicev2.model.SenderIdInformation Maven / Gradle / Ivy
Show all versions of aws-java-sdk-pinpointsmsvoicev2 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.pinpointsmsvoicev2.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* The information for all SenderIds in an Amazon Web Services account.
*
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class SenderIdInformation implements Serializable, Cloneable, StructuredPojo {
/**
*
* The Amazon Resource Name (ARN) associated with the SenderId.
*
*/
private String senderIdArn;
/**
*
* The alphanumeric sender ID in a specific country that you'd like to describe.
*
*/
private String senderId;
/**
*
* The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
*
*/
private String isoCountryCode;
/**
*
* The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and
* PROMOTIONAL for messages that aren't critical or time-sensitive.
*
*/
private java.util.List messageTypes;
/**
*
* The monthly leasing price, in US dollars.
*
*/
private String monthlyLeasingPrice;
/**
*
* By default this is set to false. When set to true the sender ID can't be deleted.
*
*/
private Boolean deletionProtectionEnabled;
/**
*
* True if the sender ID is registered.
*
*/
private Boolean registered;
/**
*
* The unique identifier for the registration.
*
*/
private String registrationId;
/**
*
* The Amazon Resource Name (ARN) associated with the SenderId.
*
*
* @param senderIdArn
* The Amazon Resource Name (ARN) associated with the SenderId.
*/
public void setSenderIdArn(String senderIdArn) {
this.senderIdArn = senderIdArn;
}
/**
*
* The Amazon Resource Name (ARN) associated with the SenderId.
*
*
* @return The Amazon Resource Name (ARN) associated with the SenderId.
*/
public String getSenderIdArn() {
return this.senderIdArn;
}
/**
*
* The Amazon Resource Name (ARN) associated with the SenderId.
*
*
* @param senderIdArn
* The Amazon Resource Name (ARN) associated with the SenderId.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SenderIdInformation withSenderIdArn(String senderIdArn) {
setSenderIdArn(senderIdArn);
return this;
}
/**
*
* The alphanumeric sender ID in a specific country that you'd like to describe.
*
*
* @param senderId
* The alphanumeric sender ID in a specific country that you'd like to describe.
*/
public void setSenderId(String senderId) {
this.senderId = senderId;
}
/**
*
* The alphanumeric sender ID in a specific country that you'd like to describe.
*
*
* @return The alphanumeric sender ID in a specific country that you'd like to describe.
*/
public String getSenderId() {
return this.senderId;
}
/**
*
* The alphanumeric sender ID in a specific country that you'd like to describe.
*
*
* @param senderId
* The alphanumeric sender ID in a specific country that you'd like to describe.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SenderIdInformation withSenderId(String senderId) {
setSenderId(senderId);
return this;
}
/**
*
* The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
*
*
* @param isoCountryCode
* The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
*/
public void setIsoCountryCode(String isoCountryCode) {
this.isoCountryCode = isoCountryCode;
}
/**
*
* The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
*
*
* @return The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
*/
public String getIsoCountryCode() {
return this.isoCountryCode;
}
/**
*
* The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
*
*
* @param isoCountryCode
* The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SenderIdInformation withIsoCountryCode(String isoCountryCode) {
setIsoCountryCode(isoCountryCode);
return this;
}
/**
*
* The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and
* PROMOTIONAL for messages that aren't critical or time-sensitive.
*
*
* @return The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and
* PROMOTIONAL for messages that aren't critical or time-sensitive.
* @see MessageType
*/
public java.util.List getMessageTypes() {
return messageTypes;
}
/**
*
* The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and
* PROMOTIONAL for messages that aren't critical or time-sensitive.
*
*
* @param messageTypes
* The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and
* PROMOTIONAL for messages that aren't critical or time-sensitive.
* @see MessageType
*/
public void setMessageTypes(java.util.Collection messageTypes) {
if (messageTypes == null) {
this.messageTypes = null;
return;
}
this.messageTypes = new java.util.ArrayList(messageTypes);
}
/**
*
* The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and
* PROMOTIONAL for messages that aren't critical or time-sensitive.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setMessageTypes(java.util.Collection)} or {@link #withMessageTypes(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param messageTypes
* The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and
* PROMOTIONAL for messages that aren't critical or time-sensitive.
* @return Returns a reference to this object so that method calls can be chained together.
* @see MessageType
*/
public SenderIdInformation withMessageTypes(String... messageTypes) {
if (this.messageTypes == null) {
setMessageTypes(new java.util.ArrayList(messageTypes.length));
}
for (String ele : messageTypes) {
this.messageTypes.add(ele);
}
return this;
}
/**
*
* The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and
* PROMOTIONAL for messages that aren't critical or time-sensitive.
*
*
* @param messageTypes
* The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and
* PROMOTIONAL for messages that aren't critical or time-sensitive.
* @return Returns a reference to this object so that method calls can be chained together.
* @see MessageType
*/
public SenderIdInformation withMessageTypes(java.util.Collection messageTypes) {
setMessageTypes(messageTypes);
return this;
}
/**
*
* The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and
* PROMOTIONAL for messages that aren't critical or time-sensitive.
*
*
* @param messageTypes
* The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and
* PROMOTIONAL for messages that aren't critical or time-sensitive.
* @return Returns a reference to this object so that method calls can be chained together.
* @see MessageType
*/
public SenderIdInformation withMessageTypes(MessageType... messageTypes) {
java.util.ArrayList messageTypesCopy = new java.util.ArrayList(messageTypes.length);
for (MessageType value : messageTypes) {
messageTypesCopy.add(value.toString());
}
if (getMessageTypes() == null) {
setMessageTypes(messageTypesCopy);
} else {
getMessageTypes().addAll(messageTypesCopy);
}
return this;
}
/**
*
* The monthly leasing price, in US dollars.
*
*
* @param monthlyLeasingPrice
* The monthly leasing price, in US dollars.
*/
public void setMonthlyLeasingPrice(String monthlyLeasingPrice) {
this.monthlyLeasingPrice = monthlyLeasingPrice;
}
/**
*
* The monthly leasing price, in US dollars.
*
*
* @return The monthly leasing price, in US dollars.
*/
public String getMonthlyLeasingPrice() {
return this.monthlyLeasingPrice;
}
/**
*
* The monthly leasing price, in US dollars.
*
*
* @param monthlyLeasingPrice
* The monthly leasing price, in US dollars.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SenderIdInformation withMonthlyLeasingPrice(String monthlyLeasingPrice) {
setMonthlyLeasingPrice(monthlyLeasingPrice);
return this;
}
/**
*
* By default this is set to false. When set to true the sender ID can't be deleted.
*
*
* @param deletionProtectionEnabled
* By default this is set to false. When set to true the sender ID can't be deleted.
*/
public void setDeletionProtectionEnabled(Boolean deletionProtectionEnabled) {
this.deletionProtectionEnabled = deletionProtectionEnabled;
}
/**
*
* By default this is set to false. When set to true the sender ID can't be deleted.
*
*
* @return By default this is set to false. When set to true the sender ID can't be deleted.
*/
public Boolean getDeletionProtectionEnabled() {
return this.deletionProtectionEnabled;
}
/**
*
* By default this is set to false. When set to true the sender ID can't be deleted.
*
*
* @param deletionProtectionEnabled
* By default this is set to false. When set to true the sender ID can't be deleted.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SenderIdInformation withDeletionProtectionEnabled(Boolean deletionProtectionEnabled) {
setDeletionProtectionEnabled(deletionProtectionEnabled);
return this;
}
/**
*
* By default this is set to false. When set to true the sender ID can't be deleted.
*
*
* @return By default this is set to false. When set to true the sender ID can't be deleted.
*/
public Boolean isDeletionProtectionEnabled() {
return this.deletionProtectionEnabled;
}
/**
*
* True if the sender ID is registered.
*
*
* @param registered
* True if the sender ID is registered.
*/
public void setRegistered(Boolean registered) {
this.registered = registered;
}
/**
*
* True if the sender ID is registered.
*
*
* @return True if the sender ID is registered.
*/
public Boolean getRegistered() {
return this.registered;
}
/**
*
* True if the sender ID is registered.
*
*
* @param registered
* True if the sender ID is registered.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SenderIdInformation withRegistered(Boolean registered) {
setRegistered(registered);
return this;
}
/**
*
* True if the sender ID is registered.
*
*
* @return True if the sender ID is registered.
*/
public Boolean isRegistered() {
return this.registered;
}
/**
*
* The unique identifier for the registration.
*
*
* @param registrationId
* The unique identifier for the registration.
*/
public void setRegistrationId(String registrationId) {
this.registrationId = registrationId;
}
/**
*
* The unique identifier for the registration.
*
*
* @return The unique identifier for the registration.
*/
public String getRegistrationId() {
return this.registrationId;
}
/**
*
* The unique identifier for the registration.
*
*
* @param registrationId
* The unique identifier for the registration.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SenderIdInformation withRegistrationId(String registrationId) {
setRegistrationId(registrationId);
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 (getSenderIdArn() != null)
sb.append("SenderIdArn: ").append(getSenderIdArn()).append(",");
if (getSenderId() != null)
sb.append("SenderId: ").append(getSenderId()).append(",");
if (getIsoCountryCode() != null)
sb.append("IsoCountryCode: ").append(getIsoCountryCode()).append(",");
if (getMessageTypes() != null)
sb.append("MessageTypes: ").append(getMessageTypes()).append(",");
if (getMonthlyLeasingPrice() != null)
sb.append("MonthlyLeasingPrice: ").append(getMonthlyLeasingPrice()).append(",");
if (getDeletionProtectionEnabled() != null)
sb.append("DeletionProtectionEnabled: ").append(getDeletionProtectionEnabled()).append(",");
if (getRegistered() != null)
sb.append("Registered: ").append(getRegistered()).append(",");
if (getRegistrationId() != null)
sb.append("RegistrationId: ").append(getRegistrationId());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof SenderIdInformation == false)
return false;
SenderIdInformation other = (SenderIdInformation) obj;
if (other.getSenderIdArn() == null ^ this.getSenderIdArn() == null)
return false;
if (other.getSenderIdArn() != null && other.getSenderIdArn().equals(this.getSenderIdArn()) == false)
return false;
if (other.getSenderId() == null ^ this.getSenderId() == null)
return false;
if (other.getSenderId() != null && other.getSenderId().equals(this.getSenderId()) == false)
return false;
if (other.getIsoCountryCode() == null ^ this.getIsoCountryCode() == null)
return false;
if (other.getIsoCountryCode() != null && other.getIsoCountryCode().equals(this.getIsoCountryCode()) == false)
return false;
if (other.getMessageTypes() == null ^ this.getMessageTypes() == null)
return false;
if (other.getMessageTypes() != null && other.getMessageTypes().equals(this.getMessageTypes()) == false)
return false;
if (other.getMonthlyLeasingPrice() == null ^ this.getMonthlyLeasingPrice() == null)
return false;
if (other.getMonthlyLeasingPrice() != null && other.getMonthlyLeasingPrice().equals(this.getMonthlyLeasingPrice()) == false)
return false;
if (other.getDeletionProtectionEnabled() == null ^ this.getDeletionProtectionEnabled() == null)
return false;
if (other.getDeletionProtectionEnabled() != null && other.getDeletionProtectionEnabled().equals(this.getDeletionProtectionEnabled()) == false)
return false;
if (other.getRegistered() == null ^ this.getRegistered() == null)
return false;
if (other.getRegistered() != null && other.getRegistered().equals(this.getRegistered()) == false)
return false;
if (other.getRegistrationId() == null ^ this.getRegistrationId() == null)
return false;
if (other.getRegistrationId() != null && other.getRegistrationId().equals(this.getRegistrationId()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getSenderIdArn() == null) ? 0 : getSenderIdArn().hashCode());
hashCode = prime * hashCode + ((getSenderId() == null) ? 0 : getSenderId().hashCode());
hashCode = prime * hashCode + ((getIsoCountryCode() == null) ? 0 : getIsoCountryCode().hashCode());
hashCode = prime * hashCode + ((getMessageTypes() == null) ? 0 : getMessageTypes().hashCode());
hashCode = prime * hashCode + ((getMonthlyLeasingPrice() == null) ? 0 : getMonthlyLeasingPrice().hashCode());
hashCode = prime * hashCode + ((getDeletionProtectionEnabled() == null) ? 0 : getDeletionProtectionEnabled().hashCode());
hashCode = prime * hashCode + ((getRegistered() == null) ? 0 : getRegistered().hashCode());
hashCode = prime * hashCode + ((getRegistrationId() == null) ? 0 : getRegistrationId().hashCode());
return hashCode;
}
@Override
public SenderIdInformation clone() {
try {
return (SenderIdInformation) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.pinpointsmsvoicev2.model.transform.SenderIdInformationMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}