Class OriginationRoute

java.lang.Object
software.amazon.awssdk.services.chime.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 your Amazon Chime Voice Connector. Limit: Ten origination routes for each Amazon Chime Voice Connector.

The parameters listed below are not required, but you must use at least one.

See Also:
  • Method Details

    • 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 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 Voice Connectors use TCP protocol by default.
      See Also:
    • protocolAsString

      public final String protocolAsString()

      The protocol to use for the origination route. Encryption-enabled Amazon Chime 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 Voice Connectors use TCP protocol by default.
      See Also:
    • 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 associated with the host. If hosts are equal in priority, calls are redistributed among them based on their relative weight.

      Returns:
      The weight associated with the host. If hosts are equal in priority, calls are redistributed among them based on their relative weight.
    • toBuilder

      public OriginationRoute.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<OriginationRoute.Builder,OriginationRoute>
      Returns:
      a builder for type T
    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.
    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.