Class SipRule

java.lang.Object
software.amazon.awssdk.services.chime.model.SipRule
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<SipRule.Builder,SipRule>
@Generated("software.amazon.awssdk:codegen") public final class SipRule extends Object implements SdkPojo, Serializable, ToCopyableBuilder<SipRule.Builder,SipRule>

The SIP rule details, including name, triggers, and target applications. An AWS account can have multiple SIP rules.

See Also:

  • Method Details

    • sipRuleId

      public final String sipRuleId()

      The SIP rule ID.

      Returns:
      The SIP rule ID.

    • name

      public final String name()

      The name of the SIP rule.

      Returns:
      The name of the SIP rule.

    • disabled

      public final Boolean disabled()

      Indicates whether the SIP rule is enabled or disabled. You must disable a rule before you can delete it.

      Returns:
      Indicates whether the SIP rule is enabled or disabled. You must disable a rule before you can delete it.

    • triggerType

      public final SipRuleTriggerType triggerType()

      The type of trigger assigned to the SIP rule in TriggerValue, currently RequestUriHostname or ToPhoneNumber.

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

      Returns:
      The type of trigger assigned to the SIP rule in TriggerValue, currently RequestUriHostname or ToPhoneNumber.
      See Also:

    • triggerTypeAsString

      public final String triggerTypeAsString()

      The type of trigger assigned to the SIP rule in TriggerValue, currently RequestUriHostname or ToPhoneNumber.

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

      Returns:
      The type of trigger assigned to the SIP rule in TriggerValue, currently RequestUriHostname or ToPhoneNumber.
      See Also:

    • triggerValue

      public final String triggerValue()

      If TriggerType is RequestUriHostname, then the value can be the outbound host name of the Amazon Chime Voice Connector. If TriggerType is ToPhoneNumber, then the value can be a customer-owned phone number in E164 format. SipRule is triggered when a SIP rule requests host name or ToPhoneNumber matches in the incoming SIP request.

      Returns:
      If TriggerType is RequestUriHostname, then the value can be the outbound host name of the Amazon Chime Voice Connector. If TriggerType is ToPhoneNumber, then the value can be a customer-owned phone number in E164 format. SipRule is triggered when a SIP rule requests host name or ToPhoneNumber matches in the incoming SIP request.

    • hasTargetApplications

      public final boolean hasTargetApplications()
      For responses, this returns true if the service returned a value for the TargetApplications property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • targetApplications

      public final List<SipRuleTargetApplication> targetApplications()

      Target SIP media application and other details, such as priority and AWS Region, to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTargetApplications() method.

      Returns:
      Target SIP media application and other details, such as priority and AWS Region, to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided.

    • createdTimestamp

      public final Instant createdTimestamp()

      The time at which the SIP rule was created, in ISO 8601 format.

      Returns:
      The time at which the SIP rule was created, in ISO 8601 format.

    • updatedTimestamp

      public final Instant updatedTimestamp()

      The time at which the SIP rule was last updated, in ISO 8601 format.

      Returns:
      The time at which the SIP rule was last updated, in ISO 8601 format.

    • toBuilder

      public SipRule.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<SipRule.Builder,SipRule>
      Returns:
      a builder for type T

    • builder

      public static SipRule.Builder builder()

    • serializableBuilderClass

      public static Class<? extends SipRule.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.