/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.chimesdkvoice.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; /** * * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class CreateSipRuleRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *
* The name of the SIP rule. *
*/ private String name; /** *
* The type of trigger assigned to the SIP rule in TriggerValue
, currently
* RequestUriHostname
or ToPhoneNumber
.
*
* 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.
*
* Disables or enables a SIP rule. You must disable SIP rules before you can delete them. *
*/ private Boolean disabled; /** ** List of SIP media applications, with priority and AWS Region. Only one SIP application per AWS Region can be * used. *
*/ private java.util.List* The name of the SIP rule. *
* * @param name * The name of the SIP rule. */ public void setName(String name) { this.name = name; } /** ** The name of the SIP rule. *
* * @return The name of the SIP rule. */ public String getName() { return this.name; } /** ** The name of the SIP rule. *
* * @param name * The name of the SIP rule. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateSipRuleRequest withName(String name) { setName(name); return this; } /** *
* The type of trigger assigned to the SIP rule in TriggerValue
, currently
* RequestUriHostname
or ToPhoneNumber
.
*
TriggerValue
, currently
* RequestUriHostname
or ToPhoneNumber
.
* @see SipRuleTriggerType
*/
public void setTriggerType(String triggerType) {
this.triggerType = triggerType;
}
/**
*
* The type of trigger assigned to the SIP rule in TriggerValue
, currently
* RequestUriHostname
or ToPhoneNumber
.
*
TriggerValue
, currently
* RequestUriHostname
or ToPhoneNumber
.
* @see SipRuleTriggerType
*/
public String getTriggerType() {
return this.triggerType;
}
/**
*
* The type of trigger assigned to the SIP rule in TriggerValue
, currently
* RequestUriHostname
or ToPhoneNumber
.
*
TriggerValue
, currently
* RequestUriHostname
or ToPhoneNumber
.
* @return Returns a reference to this object so that method calls can be chained together.
* @see SipRuleTriggerType
*/
public CreateSipRuleRequest withTriggerType(String triggerType) {
setTriggerType(triggerType);
return this;
}
/**
*
* The type of trigger assigned to the SIP rule in TriggerValue
, currently
* RequestUriHostname
or ToPhoneNumber
.
*
TriggerValue
, currently
* RequestUriHostname
or ToPhoneNumber
.
* @return Returns a reference to this object so that method calls can be chained together.
* @see SipRuleTriggerType
*/
public CreateSipRuleRequest withTriggerType(SipRuleTriggerType triggerType) {
this.triggerType = triggerType.toString();
return this;
}
/**
*
* 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.
*
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.
*/
public void setTriggerValue(String triggerValue) {
this.triggerValue = 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.
*
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.
*/
public String getTriggerValue() {
return this.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.
*
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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateSipRuleRequest withTriggerValue(String triggerValue) {
setTriggerValue(triggerValue);
return this;
}
/**
* * Disables or enables a SIP rule. You must disable SIP rules before you can delete them. *
* * @param disabled * Disables or enables a SIP rule. You must disable SIP rules before you can delete them. */ public void setDisabled(Boolean disabled) { this.disabled = disabled; } /** ** Disables or enables a SIP rule. You must disable SIP rules before you can delete them. *
* * @return Disables or enables a SIP rule. You must disable SIP rules before you can delete them. */ public Boolean getDisabled() { return this.disabled; } /** ** Disables or enables a SIP rule. You must disable SIP rules before you can delete them. *
* * @param disabled * Disables or enables a SIP rule. You must disable SIP rules before you can delete them. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateSipRuleRequest withDisabled(Boolean disabled) { setDisabled(disabled); return this; } /** ** Disables or enables a SIP rule. You must disable SIP rules before you can delete them. *
* * @return Disables or enables a SIP rule. You must disable SIP rules before you can delete them. */ public Boolean isDisabled() { return this.disabled; } /** ** List of SIP media applications, with priority and AWS Region. Only one SIP application per AWS Region can be * used. *
* * @return List of SIP media applications, with priority and AWS Region. Only one SIP application per AWS Region can * be used. */ public java.util.List* List of SIP media applications, with priority and AWS Region. Only one SIP application per AWS Region can be * used. *
* * @param targetApplications * List of SIP media applications, with priority and AWS Region. Only one SIP application per AWS Region can * be used. */ public void setTargetApplications(java.util.Collection* List of SIP media applications, with priority and AWS Region. Only one SIP application per AWS Region can be * used. *
** NOTE: This method appends the values to the existing list (if any). Use * {@link #setTargetApplications(java.util.Collection)} or {@link #withTargetApplications(java.util.Collection)} if * you want to override the existing values. *
* * @param targetApplications * List of SIP media applications, with priority and AWS Region. Only one SIP application per AWS Region can * be used. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateSipRuleRequest withTargetApplications(SipRuleTargetApplication... targetApplications) { if (this.targetApplications == null) { setTargetApplications(new java.util.ArrayList* List of SIP media applications, with priority and AWS Region. Only one SIP application per AWS Region can be * used. *
* * @param targetApplications * List of SIP media applications, with priority and AWS Region. Only one SIP application per AWS Region can * be used. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateSipRuleRequest withTargetApplications(java.util.Collection