Class CreateSipRuleRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.chimesdkvoice.model.ChimeSdkVoiceRequest
software.amazon.awssdk.services.chimesdkvoice.model.CreateSipRuleRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateSipRuleRequest.Builder,CreateSipRuleRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateSipRuleRequest extends ChimeSdkVoiceRequest implements ToCopyableBuilder<CreateSipRuleRequest.Builder,CreateSipRuleRequest>

  • Method Details

    • name

      public final String name()

      The name of the SIP rule.

      Returns:
      The name of the SIP rule.

    • 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, the value can be the outbound host name of a Voice Connector. If TriggerType is ToPhoneNumber, the value can be a customer-owned phone number in the E164 format. The SipMediaApplication specified in the SipRule is triggered if the request URI in an incoming SIP request matches the RequestUriHostname, or if the To header in the incoming SIP request matches the ToPhoneNumber value.

      Returns:
      If TriggerType is RequestUriHostname, the value can be the outbound host name of a Voice Connector. If TriggerType is ToPhoneNumber, the value can be a customer-owned phone number in the E164 format. The SipMediaApplication specified in the SipRule is triggered if the request URI in an incoming SIP request matches the RequestUriHostname, or if the To header in the incoming SIP request matches the ToPhoneNumber value.

    • disabled

      public final Boolean disabled()

      Disables or enables a SIP rule. You must disable SIP rules before you can delete them.

      Returns:
      Disables or enables a SIP rule. You must disable SIP rules before you can delete them.

    • 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()

      List of SIP media applications, with priority and AWS Region. Only one SIP application per AWS Region can be used.

      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:
      List of SIP media applications, with priority and AWS Region. Only one SIP application per AWS Region can be used.

    • toBuilder

      public CreateSipRuleRequest.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<CreateSipRuleRequest.Builder,CreateSipRuleRequest>
      Specified by:
      toBuilder in class ChimeSdkVoiceRequest
      Returns:
      a builder for type T

    • builder

      public static CreateSipRuleRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • 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.