com.amazonaws.services.chimesdkvoice.model.OriginationRoute Maven / Gradle / Ivy
/*
* 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.chimesdkvoice.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Origination routes define call distribution properties for your SIP hosts to receive inbound calls using an Amazon
* Chime SDK Voice Connector. Limit: Ten origination routes for each Voice Connector.
*
*
*
* The parameters listed below are not required, but you must use at least one.
*
*
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class OriginationRoute implements Serializable, Cloneable, StructuredPojo {
/**
*
* The FQDN or IP address to contact for origination traffic.
*
*/
private String host;
/**
*
* The designated origination route port. Defaults to 5060.
*
*/
private Integer port;
/**
*
* The protocol to use for the origination route. Encryption-enabled Amazon Chime SDK Voice Connectors use TCP
* protocol by default.
*
*/
private String protocol;
/**
*
* The priority associated with the host, with 1 being the highest priority. Higher priority hosts are attempted
* first.
*
*/
private Integer priority;
/**
*
* The weight assigned to an origination route. When hosts have equal priority, calls are distributed between them
* based on their relative weights.
*
*/
private Integer weight;
/**
*
* The FQDN or IP address to contact for origination traffic.
*
*
* @param host
* The FQDN or IP address to contact for origination traffic.
*/
public void setHost(String host) {
this.host = host;
}
/**
*
* The FQDN or IP address to contact for origination traffic.
*
*
* @return The FQDN or IP address to contact for origination traffic.
*/
public String getHost() {
return this.host;
}
/**
*
* The FQDN or IP address to contact for origination traffic.
*
*
* @param host
* The FQDN or IP address to contact for origination traffic.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public OriginationRoute withHost(String host) {
setHost(host);
return this;
}
/**
*
* The designated origination route port. Defaults to 5060.
*
*
* @param port
* The designated origination route port. Defaults to 5060.
*/
public void setPort(Integer port) {
this.port = port;
}
/**
*
* The designated origination route port. Defaults to 5060.
*
*
* @return The designated origination route port. Defaults to 5060.
*/
public Integer getPort() {
return this.port;
}
/**
*
* The designated origination route port. Defaults to 5060.
*
*
* @param port
* The designated origination route port. Defaults to 5060.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public OriginationRoute withPort(Integer port) {
setPort(port);
return this;
}
/**
*
* The protocol to use for the origination route. Encryption-enabled Amazon Chime SDK Voice Connectors use TCP
* protocol by default.
*
*
* @param protocol
* The protocol to use for the origination route. Encryption-enabled Amazon Chime SDK Voice Connectors use
* TCP protocol by default.
* @see OriginationRouteProtocol
*/
public void setProtocol(String protocol) {
this.protocol = protocol;
}
/**
*
* The protocol to use for the origination route. Encryption-enabled Amazon Chime SDK Voice Connectors use TCP
* protocol by default.
*
*
* @return The protocol to use for the origination route. Encryption-enabled Amazon Chime SDK Voice Connectors use
* TCP protocol by default.
* @see OriginationRouteProtocol
*/
public String getProtocol() {
return this.protocol;
}
/**
*
* The protocol to use for the origination route. Encryption-enabled Amazon Chime SDK Voice Connectors use TCP
* protocol by default.
*
*
* @param protocol
* The protocol to use for the origination route. Encryption-enabled Amazon Chime SDK Voice Connectors use
* TCP protocol by default.
* @return Returns a reference to this object so that method calls can be chained together.
* @see OriginationRouteProtocol
*/
public OriginationRoute withProtocol(String protocol) {
setProtocol(protocol);
return this;
}
/**
*
* The protocol to use for the origination route. Encryption-enabled Amazon Chime SDK Voice Connectors use TCP
* protocol by default.
*
*
* @param protocol
* The protocol to use for the origination route. Encryption-enabled Amazon Chime SDK Voice Connectors use
* TCP protocol by default.
* @return Returns a reference to this object so that method calls can be chained together.
* @see OriginationRouteProtocol
*/
public OriginationRoute withProtocol(OriginationRouteProtocol protocol) {
this.protocol = protocol.toString();
return this;
}
/**
*
* The priority associated with the host, with 1 being the highest priority. Higher priority hosts are attempted
* first.
*
*
* @param priority
* The priority associated with the host, with 1 being the highest priority. Higher priority hosts are
* attempted first.
*/
public void setPriority(Integer priority) {
this.priority = priority;
}
/**
*
* The priority associated with the host, with 1 being the highest priority. Higher priority hosts are attempted
* first.
*
*
* @return The priority associated with the host, with 1 being the highest priority. Higher priority hosts are
* attempted first.
*/
public Integer getPriority() {
return this.priority;
}
/**
*
* The priority associated with the host, with 1 being the highest priority. Higher priority hosts are attempted
* first.
*
*
* @param priority
* The priority associated with the host, with 1 being the highest priority. Higher priority hosts are
* attempted first.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public OriginationRoute withPriority(Integer priority) {
setPriority(priority);
return this;
}
/**
*
* The weight assigned to an origination route. When hosts have equal priority, calls are distributed between them
* based on their relative weights.
*
*
* @param weight
* The weight assigned to an origination route. When hosts have equal priority, calls are distributed between
* them based on their relative weights.
*/
public void setWeight(Integer weight) {
this.weight = weight;
}
/**
*
* The weight assigned to an origination route. When hosts have equal priority, calls are distributed between them
* based on their relative weights.
*
*
* @return The weight assigned to an origination route. When hosts have equal priority, calls are distributed
* between them based on their relative weights.
*/
public Integer getWeight() {
return this.weight;
}
/**
*
* The weight assigned to an origination route. When hosts have equal priority, calls are distributed between them
* based on their relative weights.
*
*
* @param weight
* The weight assigned to an origination route. When hosts have equal priority, calls are distributed between
* them based on their relative weights.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public OriginationRoute withWeight(Integer weight) {
setWeight(weight);
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 (getHost() != null)
sb.append("Host: ").append(getHost()).append(",");
if (getPort() != null)
sb.append("Port: ").append(getPort()).append(",");
if (getProtocol() != null)
sb.append("Protocol: ").append(getProtocol()).append(",");
if (getPriority() != null)
sb.append("Priority: ").append(getPriority()).append(",");
if (getWeight() != null)
sb.append("Weight: ").append(getWeight());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof OriginationRoute == false)
return false;
OriginationRoute other = (OriginationRoute) obj;
if (other.getHost() == null ^ this.getHost() == null)
return false;
if (other.getHost() != null && other.getHost().equals(this.getHost()) == false)
return false;
if (other.getPort() == null ^ this.getPort() == null)
return false;
if (other.getPort() != null && other.getPort().equals(this.getPort()) == false)
return false;
if (other.getProtocol() == null ^ this.getProtocol() == null)
return false;
if (other.getProtocol() != null && other.getProtocol().equals(this.getProtocol()) == false)
return false;
if (other.getPriority() == null ^ this.getPriority() == null)
return false;
if (other.getPriority() != null && other.getPriority().equals(this.getPriority()) == false)
return false;
if (other.getWeight() == null ^ this.getWeight() == null)
return false;
if (other.getWeight() != null && other.getWeight().equals(this.getWeight()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getHost() == null) ? 0 : getHost().hashCode());
hashCode = prime * hashCode + ((getPort() == null) ? 0 : getPort().hashCode());
hashCode = prime * hashCode + ((getProtocol() == null) ? 0 : getProtocol().hashCode());
hashCode = prime * hashCode + ((getPriority() == null) ? 0 : getPriority().hashCode());
hashCode = prime * hashCode + ((getWeight() == null) ? 0 : getWeight().hashCode());
return hashCode;
}
@Override
public OriginationRoute clone() {
try {
return (OriginationRoute) 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.OriginationRouteMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}