Package software.amazon.awssdk.services.chimesdkvoice.model

Class OriginationRoute

java.lang.Object

software.amazon.awssdk.services.chimesdkvoice.model.OriginationRoute

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<OriginationRoute.Builder,OriginationRoute>

@Generated("software.amazon.awssdk:codegen")
public final class OriginationRoute
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<OriginationRoute.Builder,OriginationRoute>

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 Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	OriginationRoute.Builder

Method Summary

Modifier and Type	Method	Description
static OriginationRoute.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	host()	The FQDN or IP address to contact for origination traffic.
Integer	port()	The designated origination route port.
Integer	priority()	The priority associated with the host, with 1 being the highest priority.
OriginationRouteProtocol	protocol()	The protocol to use for the origination route.
String	protocolAsString()	The protocol to use for the origination route.
List<SdkField<?>>	sdkFields()
static Class<? extends OriginationRoute.Builder>	serializableBuilderClass()
OriginationRoute.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Integer	weight()	The weight assigned to an origination route.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

host

public final String host()

The FQDN or IP address to contact for origination traffic.

Returns:

The FQDN or IP address to contact for origination traffic.

port

public final Integer port()

The designated origination route port. Defaults to 5060.

Returns:

The designated origination route port. Defaults to 5060.

protocol

public final OriginationRouteProtocol protocol()

The protocol to use for the origination route. Encryption-enabled Amazon Chime SDK Voice Connectors use TCP protocol by default.

If the service returns an enum value that is not available in the current SDK version, protocol will return OriginationRouteProtocol.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from protocolAsString().

Returns:

The protocol to use for the origination route. Encryption-enabled Amazon Chime SDK Voice Connectors use TCP protocol by default.

See Also:

OriginationRouteProtocol

protocolAsString

public final String protocolAsString()

The protocol to use for the origination route. Encryption-enabled Amazon Chime SDK Voice Connectors use TCP protocol by default.

If the service returns an enum value that is not available in the current SDK version, protocol will return OriginationRouteProtocol.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from protocolAsString().

Returns:

The protocol to use for the origination route. Encryption-enabled Amazon Chime SDK Voice Connectors use TCP protocol by default.

See Also:

OriginationRouteProtocol

priority

public final Integer priority()

The priority associated with the host, with 1 being the highest priority. Higher priority hosts are attempted first.

Returns:

The priority associated with the host, with 1 being the highest priority. Higher priority hosts are attempted first.

weight

public final Integer weight()

The weight assigned to an origination route. When hosts have equal priority, calls are distributed between them based on their relative weights.

Returns:

The weight assigned to an origination route. When hosts have equal priority, calls are distributed between them based on their relative weights.

toBuilder

public OriginationRoute.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<OriginationRoute.Builder,OriginationRoute>

builder

public static OriginationRoute.Builder builder()

serializableBuilderClass

public static Class<? extends OriginationRoute.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo