Interface CreateSipRuleRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, ChimeSdkVoiceRequest.Builder, CopyableBuilder<CreateSipRuleRequest.Builder,CreateSipRuleRequest>, SdkBuilder<CreateSipRuleRequest.Builder,CreateSipRuleRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateSipRuleRequest
@Mutable @NotThreadSafe public static interface CreateSipRuleRequest.Builder extends ChimeSdkVoiceRequest.Builder, SdkPojo, CopyableBuilder<CreateSipRuleRequest.Builder,CreateSipRuleRequest>

  • Method Details

    • name

      CreateSipRuleRequest.Builder name(String name)

      The name of the SIP rule.

      Parameters:
      name - The name of the SIP rule.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • triggerType

      CreateSipRuleRequest.Builder triggerType(String triggerType)

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

      Parameters:
      triggerType - The type of trigger assigned to the SIP rule in TriggerValue, currently RequestUriHostname or ToPhoneNumber.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • triggerType

      CreateSipRuleRequest.Builder triggerType(SipRuleTriggerType triggerType)

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

      Parameters:
      triggerType - The type of trigger assigned to the SIP rule in TriggerValue, currently RequestUriHostname or ToPhoneNumber.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • triggerValue

      CreateSipRuleRequest.Builder triggerValue(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • disabled

      CreateSipRuleRequest.Builder disabled(Boolean disabled)

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

      Parameters:
      disabled - Disables or enables a SIP rule. You must disable SIP rules before you can delete them.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • targetApplications

      CreateSipRuleRequest.Builder targetApplications(Collection<SipRuleTargetApplication> targetApplications)

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

      Parameters:
      targetApplications - List of SIP media applications, with priority and AWS Region. Only one SIP application per AWS Region can be used.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • targetApplications

      CreateSipRuleRequest.Builder targetApplications(SipRuleTargetApplication... targetApplications)

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

      Parameters:
      targetApplications - List of SIP media applications, with priority and AWS Region. Only one SIP application per AWS Region can be used.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • targetApplications

      CreateSipRuleRequest.Builder targetApplications(Consumer<SipRuleTargetApplication.Builder>... targetApplications)

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

      This is a convenience method that creates an instance of the SipRuleTargetApplication.Builder avoiding the need to create one manually via SipRuleTargetApplication.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to targetApplications(List<SipRuleTargetApplication>).

      Parameters:
      targetApplications - a consumer that will call methods on SipRuleTargetApplication.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      CreateSipRuleRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateSipRuleRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.