pub struct CreateSipRuleFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to CreateSipRule
.
Creates a SIP rule which can be used to run a SIP media application as a target for a specific trigger type.
This API is is no longer supported and will not be updated. We recommend using the latest version, CreateSipRule, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Implementationsยง
sourceยงimpl CreateSipRuleFluentBuilder
impl CreateSipRuleFluentBuilder
sourcepub fn as_input(&self) -> &CreateSipRuleInputBuilder
pub fn as_input(&self) -> &CreateSipRuleInputBuilder
Access the CreateSipRule as a reference.
sourcepub async fn send(
self
) -> Result<CreateSipRuleOutput, SdkError<CreateSipRuleError, HttpResponse>>
pub async fn send( self ) -> Result<CreateSipRuleOutput, SdkError<CreateSipRuleError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
sourcepub fn customize(
self
) -> CustomizableOperation<CreateSipRuleOutput, CreateSipRuleError, Self>
pub fn customize( self ) -> CustomizableOperation<CreateSipRuleOutput, CreateSipRuleError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
sourcepub fn trigger_type(self, input: SipRuleTriggerType) -> Self
pub fn trigger_type(self, input: SipRuleTriggerType) -> Self
The type of trigger assigned to the SIP rule in TriggerValue
, currently RequestUriHostname
or ToPhoneNumber
.
sourcepub fn set_trigger_type(self, input: Option<SipRuleTriggerType>) -> Self
pub fn set_trigger_type(self, input: Option<SipRuleTriggerType>) -> Self
The type of trigger assigned to the SIP rule in TriggerValue
, currently RequestUriHostname
or ToPhoneNumber
.
sourcepub fn get_trigger_type(&self) -> &Option<SipRuleTriggerType>
pub fn get_trigger_type(&self) -> &Option<SipRuleTriggerType>
The type of trigger assigned to the SIP rule in TriggerValue
, currently RequestUriHostname
or ToPhoneNumber
.
sourcepub fn trigger_value(self, input: impl Into<String>) -> Self
pub fn trigger_value(self, input: impl Into<String>) -> Self
If TriggerType
is RequestUriHostname
, the value can be the outbound host name of an Amazon Chime 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.
sourcepub fn set_trigger_value(self, input: Option<String>) -> Self
pub fn set_trigger_value(self, input: Option<String>) -> Self
If TriggerType
is RequestUriHostname
, the value can be the outbound host name of an Amazon Chime 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.
sourcepub fn get_trigger_value(&self) -> &Option<String>
pub fn get_trigger_value(&self) -> &Option<String>
If TriggerType
is RequestUriHostname
, the value can be the outbound host name of an Amazon Chime 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.
sourcepub fn disabled(self, input: bool) -> Self
pub fn disabled(self, input: bool) -> Self
Enables or disables a rule. You must disable rules before you can delete them.
sourcepub fn set_disabled(self, input: Option<bool>) -> Self
pub fn set_disabled(self, input: Option<bool>) -> Self
Enables or disables a rule. You must disable rules before you can delete them.
sourcepub fn get_disabled(&self) -> &Option<bool>
pub fn get_disabled(&self) -> &Option<bool>
Enables or disables a rule. You must disable rules before you can delete them.
sourcepub fn target_applications(self, input: SipRuleTargetApplication) -> Self
pub fn target_applications(self, input: SipRuleTargetApplication) -> Self
Appends an item to TargetApplications
.
To override the contents of this collection use set_target_applications
.
List of SIP media applications with priority and AWS Region. Only one SIP application per AWS Region can be used.
sourcepub fn set_target_applications(
self,
input: Option<Vec<SipRuleTargetApplication>>
) -> Self
pub fn set_target_applications( self, input: Option<Vec<SipRuleTargetApplication>> ) -> Self
List of SIP media applications with priority and AWS Region. Only one SIP application per AWS Region can be used.
sourcepub fn get_target_applications(&self) -> &Option<Vec<SipRuleTargetApplication>>
pub fn get_target_applications(&self) -> &Option<Vec<SipRuleTargetApplication>>
List of SIP media applications with priority and AWS Region. Only one SIP application per AWS Region can be used.
Trait Implementationsยง
sourceยงimpl Clone for CreateSipRuleFluentBuilder
impl Clone for CreateSipRuleFluentBuilder
sourceยงfn clone(&self) -> CreateSipRuleFluentBuilder
fn clone(&self) -> CreateSipRuleFluentBuilder
1.0.0 ยท sourceยงfn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementationsยง
impl Freeze for CreateSipRuleFluentBuilder
impl !RefUnwindSafe for CreateSipRuleFluentBuilder
impl Send for CreateSipRuleFluentBuilder
impl Sync for CreateSipRuleFluentBuilder
impl Unpin for CreateSipRuleFluentBuilder
impl !UnwindSafe for CreateSipRuleFluentBuilder
Blanket Implementationsยง
sourceยงimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
sourceยงfn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
sourceยงimpl<T> Instrument for T
impl<T> Instrument for T
sourceยงfn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourceยงfn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceยงimpl<T> IntoEither for T
impl<T> IntoEither for T
sourceยงfn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresourceยงfn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more