com.amazonaws.services.chimesdkvoice.model.PhoneNumber Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-chimesdkvoice Show documentation
Show all versions of aws-java-sdk-chimesdkvoice Show documentation
The AWS Java SDK for Amazon Chime SDK Voice module holds the client classes that are used for communicating with Amazon Chime SDK Voice Service
/*
* Copyright 2018-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.chimesdkvoice.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* A phone number used to call an Amazon Chime SDK Voice Connector.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class PhoneNumber implements Serializable, Cloneable, StructuredPojo {
/**
*
* The phone number's ID.
*
*/
private String phoneNumberId;
/**
*
* The phone number, in E.164 format.
*
*/
private String e164PhoneNumber;
/**
*
* The phone number's country. Format: ISO 3166-1 alpha-2.
*
*/
private String country;
/**
*
* The phone number's type.
*
*/
private String type;
/**
*
* The phone number's product type.
*
*/
private String productType;
/**
*
* The phone number's status.
*
*/
private String status;
/**
*
* The phone number's capabilities.
*
*/
private PhoneNumberCapabilities capabilities;
/**
*
* The phone number's associations.
*
*/
private java.util.List associations;
/**
*
* The outbound calling name associated with the phone number.
*
*/
private String callingName;
/**
*
* The outbound calling name status.
*
*/
private String callingNameStatus;
/**
*
* The phone number creation timestamp, in ISO 8601 format.
*
*/
private java.util.Date createdTimestamp;
/**
*
* The updated phone number timestamp, in ISO 8601 format.
*
*/
private java.util.Date updatedTimestamp;
/**
*
* The deleted phone number timestamp, in ISO 8601 format.
*
*/
private java.util.Date deletionTimestamp;
/**
*
* The phone number's order ID.
*
*/
private String orderId;
/**
*
* The phone number's ID.
*
*
* @param phoneNumberId
* The phone number's ID.
*/
public void setPhoneNumberId(String phoneNumberId) {
this.phoneNumberId = phoneNumberId;
}
/**
*
* The phone number's ID.
*
*
* @return The phone number's ID.
*/
public String getPhoneNumberId() {
return this.phoneNumberId;
}
/**
*
* The phone number's ID.
*
*
* @param phoneNumberId
* The phone number's ID.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PhoneNumber withPhoneNumberId(String phoneNumberId) {
setPhoneNumberId(phoneNumberId);
return this;
}
/**
*
* The phone number, in E.164 format.
*
*
* @param e164PhoneNumber
* The phone number, in E.164 format.
*/
public void setE164PhoneNumber(String e164PhoneNumber) {
this.e164PhoneNumber = e164PhoneNumber;
}
/**
*
* The phone number, in E.164 format.
*
*
* @return The phone number, in E.164 format.
*/
public String getE164PhoneNumber() {
return this.e164PhoneNumber;
}
/**
*
* The phone number, in E.164 format.
*
*
* @param e164PhoneNumber
* The phone number, in E.164 format.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PhoneNumber withE164PhoneNumber(String e164PhoneNumber) {
setE164PhoneNumber(e164PhoneNumber);
return this;
}
/**
*
* The phone number's country. Format: ISO 3166-1 alpha-2.
*
*
* @param country
* The phone number's country. Format: ISO 3166-1 alpha-2.
*/
public void setCountry(String country) {
this.country = country;
}
/**
*
* The phone number's country. Format: ISO 3166-1 alpha-2.
*
*
* @return The phone number's country. Format: ISO 3166-1 alpha-2.
*/
public String getCountry() {
return this.country;
}
/**
*
* The phone number's country. Format: ISO 3166-1 alpha-2.
*
*
* @param country
* The phone number's country. Format: ISO 3166-1 alpha-2.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PhoneNumber withCountry(String country) {
setCountry(country);
return this;
}
/**
*
* The phone number's type.
*
*
* @param type
* The phone number's type.
* @see PhoneNumberType
*/
public void setType(String type) {
this.type = type;
}
/**
*
* The phone number's type.
*
*
* @return The phone number's type.
* @see PhoneNumberType
*/
public String getType() {
return this.type;
}
/**
*
* The phone number's type.
*
*
* @param type
* The phone number's type.
* @return Returns a reference to this object so that method calls can be chained together.
* @see PhoneNumberType
*/
public PhoneNumber withType(String type) {
setType(type);
return this;
}
/**
*
* The phone number's type.
*
*
* @param type
* The phone number's type.
* @return Returns a reference to this object so that method calls can be chained together.
* @see PhoneNumberType
*/
public PhoneNumber withType(PhoneNumberType type) {
this.type = type.toString();
return this;
}
/**
*
* The phone number's product type.
*
*
* @param productType
* The phone number's product type.
* @see PhoneNumberProductType
*/
public void setProductType(String productType) {
this.productType = productType;
}
/**
*
* The phone number's product type.
*
*
* @return The phone number's product type.
* @see PhoneNumberProductType
*/
public String getProductType() {
return this.productType;
}
/**
*
* The phone number's product type.
*
*
* @param productType
* The phone number's product type.
* @return Returns a reference to this object so that method calls can be chained together.
* @see PhoneNumberProductType
*/
public PhoneNumber withProductType(String productType) {
setProductType(productType);
return this;
}
/**
*
* The phone number's product type.
*
*
* @param productType
* The phone number's product type.
* @return Returns a reference to this object so that method calls can be chained together.
* @see PhoneNumberProductType
*/
public PhoneNumber withProductType(PhoneNumberProductType productType) {
this.productType = productType.toString();
return this;
}
/**
*
* The phone number's status.
*
*
* @param status
* The phone number's status.
* @see PhoneNumberStatus
*/
public void setStatus(String status) {
this.status = status;
}
/**
*
* The phone number's status.
*
*
* @return The phone number's status.
* @see PhoneNumberStatus
*/
public String getStatus() {
return this.status;
}
/**
*
* The phone number's status.
*
*
* @param status
* The phone number's status.
* @return Returns a reference to this object so that method calls can be chained together.
* @see PhoneNumberStatus
*/
public PhoneNumber withStatus(String status) {
setStatus(status);
return this;
}
/**
*
* The phone number's status.
*
*
* @param status
* The phone number's status.
* @return Returns a reference to this object so that method calls can be chained together.
* @see PhoneNumberStatus
*/
public PhoneNumber withStatus(PhoneNumberStatus status) {
this.status = status.toString();
return this;
}
/**
*
* The phone number's capabilities.
*
*
* @param capabilities
* The phone number's capabilities.
*/
public void setCapabilities(PhoneNumberCapabilities capabilities) {
this.capabilities = capabilities;
}
/**
*
* The phone number's capabilities.
*
*
* @return The phone number's capabilities.
*/
public PhoneNumberCapabilities getCapabilities() {
return this.capabilities;
}
/**
*
* The phone number's capabilities.
*
*
* @param capabilities
* The phone number's capabilities.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PhoneNumber withCapabilities(PhoneNumberCapabilities capabilities) {
setCapabilities(capabilities);
return this;
}
/**
*
* The phone number's associations.
*
*
* @return The phone number's associations.
*/
public java.util.List getAssociations() {
return associations;
}
/**
*
* The phone number's associations.
*
*
* @param associations
* The phone number's associations.
*/
public void setAssociations(java.util.Collection associations) {
if (associations == null) {
this.associations = null;
return;
}
this.associations = new java.util.ArrayList(associations);
}
/**
*
* The phone number's associations.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setAssociations(java.util.Collection)} or {@link #withAssociations(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param associations
* The phone number's associations.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PhoneNumber withAssociations(PhoneNumberAssociation... associations) {
if (this.associations == null) {
setAssociations(new java.util.ArrayList(associations.length));
}
for (PhoneNumberAssociation ele : associations) {
this.associations.add(ele);
}
return this;
}
/**
*
* The phone number's associations.
*
*
* @param associations
* The phone number's associations.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PhoneNumber withAssociations(java.util.Collection associations) {
setAssociations(associations);
return this;
}
/**
*
* The outbound calling name associated with the phone number.
*
*
* @param callingName
* The outbound calling name associated with the phone number.
*/
public void setCallingName(String callingName) {
this.callingName = callingName;
}
/**
*
* The outbound calling name associated with the phone number.
*
*
* @return The outbound calling name associated with the phone number.
*/
public String getCallingName() {
return this.callingName;
}
/**
*
* The outbound calling name associated with the phone number.
*
*
* @param callingName
* The outbound calling name associated with the phone number.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PhoneNumber withCallingName(String callingName) {
setCallingName(callingName);
return this;
}
/**
*
* The outbound calling name status.
*
*
* @param callingNameStatus
* The outbound calling name status.
* @see CallingNameStatus
*/
public void setCallingNameStatus(String callingNameStatus) {
this.callingNameStatus = callingNameStatus;
}
/**
*
* The outbound calling name status.
*
*
* @return The outbound calling name status.
* @see CallingNameStatus
*/
public String getCallingNameStatus() {
return this.callingNameStatus;
}
/**
*
* The outbound calling name status.
*
*
* @param callingNameStatus
* The outbound calling name status.
* @return Returns a reference to this object so that method calls can be chained together.
* @see CallingNameStatus
*/
public PhoneNumber withCallingNameStatus(String callingNameStatus) {
setCallingNameStatus(callingNameStatus);
return this;
}
/**
*
* The outbound calling name status.
*
*
* @param callingNameStatus
* The outbound calling name status.
* @return Returns a reference to this object so that method calls can be chained together.
* @see CallingNameStatus
*/
public PhoneNumber withCallingNameStatus(CallingNameStatus callingNameStatus) {
this.callingNameStatus = callingNameStatus.toString();
return this;
}
/**
*
* The phone number creation timestamp, in ISO 8601 format.
*
*
* @param createdTimestamp
* The phone number creation timestamp, in ISO 8601 format.
*/
public void setCreatedTimestamp(java.util.Date createdTimestamp) {
this.createdTimestamp = createdTimestamp;
}
/**
*
* The phone number creation timestamp, in ISO 8601 format.
*
*
* @return The phone number creation timestamp, in ISO 8601 format.
*/
public java.util.Date getCreatedTimestamp() {
return this.createdTimestamp;
}
/**
*
* The phone number creation timestamp, in ISO 8601 format.
*
*
* @param createdTimestamp
* The phone number creation timestamp, in ISO 8601 format.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PhoneNumber withCreatedTimestamp(java.util.Date createdTimestamp) {
setCreatedTimestamp(createdTimestamp);
return this;
}
/**
*
* The updated phone number timestamp, in ISO 8601 format.
*
*
* @param updatedTimestamp
* The updated phone number timestamp, in ISO 8601 format.
*/
public void setUpdatedTimestamp(java.util.Date updatedTimestamp) {
this.updatedTimestamp = updatedTimestamp;
}
/**
*
* The updated phone number timestamp, in ISO 8601 format.
*
*
* @return The updated phone number timestamp, in ISO 8601 format.
*/
public java.util.Date getUpdatedTimestamp() {
return this.updatedTimestamp;
}
/**
*
* The updated phone number timestamp, in ISO 8601 format.
*
*
* @param updatedTimestamp
* The updated phone number timestamp, in ISO 8601 format.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PhoneNumber withUpdatedTimestamp(java.util.Date updatedTimestamp) {
setUpdatedTimestamp(updatedTimestamp);
return this;
}
/**
*
* The deleted phone number timestamp, in ISO 8601 format.
*
*
* @param deletionTimestamp
* The deleted phone number timestamp, in ISO 8601 format.
*/
public void setDeletionTimestamp(java.util.Date deletionTimestamp) {
this.deletionTimestamp = deletionTimestamp;
}
/**
*
* The deleted phone number timestamp, in ISO 8601 format.
*
*
* @return The deleted phone number timestamp, in ISO 8601 format.
*/
public java.util.Date getDeletionTimestamp() {
return this.deletionTimestamp;
}
/**
*
* The deleted phone number timestamp, in ISO 8601 format.
*
*
* @param deletionTimestamp
* The deleted phone number timestamp, in ISO 8601 format.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PhoneNumber withDeletionTimestamp(java.util.Date deletionTimestamp) {
setDeletionTimestamp(deletionTimestamp);
return this;
}
/**
*
* The phone number's order ID.
*
*
* @param orderId
* The phone number's order ID.
*/
public void setOrderId(String orderId) {
this.orderId = orderId;
}
/**
*
* The phone number's order ID.
*
*
* @return The phone number's order ID.
*/
public String getOrderId() {
return this.orderId;
}
/**
*
* The phone number's order ID.
*
*
* @param orderId
* The phone number's order ID.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PhoneNumber withOrderId(String orderId) {
setOrderId(orderId);
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 (getPhoneNumberId() != null)
sb.append("PhoneNumberId: ").append("***Sensitive Data Redacted***").append(",");
if (getE164PhoneNumber() != null)
sb.append("E164PhoneNumber: ").append("***Sensitive Data Redacted***").append(",");
if (getCountry() != null)
sb.append("Country: ").append(getCountry()).append(",");
if (getType() != null)
sb.append("Type: ").append(getType()).append(",");
if (getProductType() != null)
sb.append("ProductType: ").append(getProductType()).append(",");
if (getStatus() != null)
sb.append("Status: ").append(getStatus()).append(",");
if (getCapabilities() != null)
sb.append("Capabilities: ").append(getCapabilities()).append(",");
if (getAssociations() != null)
sb.append("Associations: ").append(getAssociations()).append(",");
if (getCallingName() != null)
sb.append("CallingName: ").append("***Sensitive Data Redacted***").append(",");
if (getCallingNameStatus() != null)
sb.append("CallingNameStatus: ").append(getCallingNameStatus()).append(",");
if (getCreatedTimestamp() != null)
sb.append("CreatedTimestamp: ").append(getCreatedTimestamp()).append(",");
if (getUpdatedTimestamp() != null)
sb.append("UpdatedTimestamp: ").append(getUpdatedTimestamp()).append(",");
if (getDeletionTimestamp() != null)
sb.append("DeletionTimestamp: ").append(getDeletionTimestamp()).append(",");
if (getOrderId() != null)
sb.append("OrderId: ").append(getOrderId());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof PhoneNumber == false)
return false;
PhoneNumber other = (PhoneNumber) obj;
if (other.getPhoneNumberId() == null ^ this.getPhoneNumberId() == null)
return false;
if (other.getPhoneNumberId() != null && other.getPhoneNumberId().equals(this.getPhoneNumberId()) == false)
return false;
if (other.getE164PhoneNumber() == null ^ this.getE164PhoneNumber() == null)
return false;
if (other.getE164PhoneNumber() != null && other.getE164PhoneNumber().equals(this.getE164PhoneNumber()) == false)
return false;
if (other.getCountry() == null ^ this.getCountry() == null)
return false;
if (other.getCountry() != null && other.getCountry().equals(this.getCountry()) == false)
return false;
if (other.getType() == null ^ this.getType() == null)
return false;
if (other.getType() != null && other.getType().equals(this.getType()) == false)
return false;
if (other.getProductType() == null ^ this.getProductType() == null)
return false;
if (other.getProductType() != null && other.getProductType().equals(this.getProductType()) == false)
return false;
if (other.getStatus() == null ^ this.getStatus() == null)
return false;
if (other.getStatus() != null && other.getStatus().equals(this.getStatus()) == false)
return false;
if (other.getCapabilities() == null ^ this.getCapabilities() == null)
return false;
if (other.getCapabilities() != null && other.getCapabilities().equals(this.getCapabilities()) == false)
return false;
if (other.getAssociations() == null ^ this.getAssociations() == null)
return false;
if (other.getAssociations() != null && other.getAssociations().equals(this.getAssociations()) == false)
return false;
if (other.getCallingName() == null ^ this.getCallingName() == null)
return false;
if (other.getCallingName() != null && other.getCallingName().equals(this.getCallingName()) == false)
return false;
if (other.getCallingNameStatus() == null ^ this.getCallingNameStatus() == null)
return false;
if (other.getCallingNameStatus() != null && other.getCallingNameStatus().equals(this.getCallingNameStatus()) == false)
return false;
if (other.getCreatedTimestamp() == null ^ this.getCreatedTimestamp() == null)
return false;
if (other.getCreatedTimestamp() != null && other.getCreatedTimestamp().equals(this.getCreatedTimestamp()) == false)
return false;
if (other.getUpdatedTimestamp() == null ^ this.getUpdatedTimestamp() == null)
return false;
if (other.getUpdatedTimestamp() != null && other.getUpdatedTimestamp().equals(this.getUpdatedTimestamp()) == false)
return false;
if (other.getDeletionTimestamp() == null ^ this.getDeletionTimestamp() == null)
return false;
if (other.getDeletionTimestamp() != null && other.getDeletionTimestamp().equals(this.getDeletionTimestamp()) == false)
return false;
if (other.getOrderId() == null ^ this.getOrderId() == null)
return false;
if (other.getOrderId() != null && other.getOrderId().equals(this.getOrderId()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getPhoneNumberId() == null) ? 0 : getPhoneNumberId().hashCode());
hashCode = prime * hashCode + ((getE164PhoneNumber() == null) ? 0 : getE164PhoneNumber().hashCode());
hashCode = prime * hashCode + ((getCountry() == null) ? 0 : getCountry().hashCode());
hashCode = prime * hashCode + ((getType() == null) ? 0 : getType().hashCode());
hashCode = prime * hashCode + ((getProductType() == null) ? 0 : getProductType().hashCode());
hashCode = prime * hashCode + ((getStatus() == null) ? 0 : getStatus().hashCode());
hashCode = prime * hashCode + ((getCapabilities() == null) ? 0 : getCapabilities().hashCode());
hashCode = prime * hashCode + ((getAssociations() == null) ? 0 : getAssociations().hashCode());
hashCode = prime * hashCode + ((getCallingName() == null) ? 0 : getCallingName().hashCode());
hashCode = prime * hashCode + ((getCallingNameStatus() == null) ? 0 : getCallingNameStatus().hashCode());
hashCode = prime * hashCode + ((getCreatedTimestamp() == null) ? 0 : getCreatedTimestamp().hashCode());
hashCode = prime * hashCode + ((getUpdatedTimestamp() == null) ? 0 : getUpdatedTimestamp().hashCode());
hashCode = prime * hashCode + ((getDeletionTimestamp() == null) ? 0 : getDeletionTimestamp().hashCode());
hashCode = prime * hashCode + ((getOrderId() == null) ? 0 : getOrderId().hashCode());
return hashCode;
}
@Override
public PhoneNumber clone() {
try {
return (PhoneNumber) 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.chimesdkvoice.model.transform.PhoneNumberMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}