software.amazon.awssdk.services.chimesdkvoice.model

Interface CreateSipRuleRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, ChimeSdkVoiceRequest.Builder, CopyableBuilder<CreateSipRuleRequest.Builder,CreateSipRuleRequest>, SdkBuilder<CreateSipRuleRequest.Builder,CreateSipRuleRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateSipRuleRequest

public static interface CreateSipRuleRequest.Builder
extends ChimeSdkVoiceRequest.Builder, SdkPojo, CopyableBuilder<CreateSipRuleRequest.Builder,CreateSipRuleRequest>

Method Summary

Modifier and Type	Method and Description
CreateSipRuleRequest.Builder	disabled(Boolean disabled) Disables or enables a SIP rule.
CreateSipRuleRequest.Builder	name(String name) The name of the SIP rule.
CreateSipRuleRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateSipRuleRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreateSipRuleRequest.Builder	targetApplications(Collection<SipRuleTargetApplication> targetApplications) List of SIP media applications, with priority and AWS Region.
CreateSipRuleRequest.Builder	targetApplications(Consumer<SipRuleTargetApplication.Builder>... targetApplications) List of SIP media applications, with priority and AWS Region.
CreateSipRuleRequest.Builder	targetApplications(SipRuleTargetApplication... targetApplications) List of SIP media applications, with priority and AWS Region.
CreateSipRuleRequest.Builder	triggerType(SipRuleTriggerType triggerType) The type of trigger assigned to the SIP rule in TriggerValue, currently RequestUriHostname or ToPhoneNumber.
CreateSipRuleRequest.Builder	triggerType(String triggerType) The type of trigger assigned to the SIP rule in TriggerValue, currently RequestUriHostname or ToPhoneNumber.
CreateSipRuleRequest.Builder	triggerValue(String triggerValue) If TriggerType is RequestUriHostname, the value can be the outbound host name of a Voice Connector.

Methods inherited from interface software.amazon.awssdk.services.chimesdkvoice.model.ChimeSdkVoiceRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

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:

SipRuleTriggerType, SipRuleTriggerType

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:

SipRuleTriggerType, SipRuleTriggerType

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

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:

#targetApplications(java.util.Collection)

overrideConfiguration

CreateSipRuleRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

CreateSipRuleRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder