com.amazonaws.services.chimesdkvoice.model

Class CreateSipRuleRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.chimesdkvoice.model.CreateSipRuleRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateSipRuleRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateSipRuleRequest()

Method Summary

Modifier and Type	Method and Description
CreateSipRuleRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Boolean	getDisabled() Disables or enables a SIP rule.
String	getName() The name of the SIP rule.
List<SipRuleTargetApplication>	getTargetApplications() List of SIP media applications, with priority and AWS Region.
String	getTriggerType() The type of trigger assigned to the SIP rule in TriggerValue, currently RequestUriHostname or ToPhoneNumber.
String	getTriggerValue() If TriggerType is RequestUriHostname, the value can be the outbound host name of a Voice Connector.
int	hashCode()
Boolean	isDisabled() Disables or enables a SIP rule.
void	setDisabled(Boolean disabled) Disables or enables a SIP rule.
void	setName(String name) The name of the SIP rule.
void	setTargetApplications(Collection<SipRuleTargetApplication> targetApplications) List of SIP media applications, with priority and AWS Region.
void	setTriggerType(String triggerType) The type of trigger assigned to the SIP rule in TriggerValue, currently RequestUriHostname or ToPhoneNumber.
void	setTriggerValue(String triggerValue) If TriggerType is RequestUriHostname, the value can be the outbound host name of a Voice Connector.
String	toString() Returns a string representation of this object.
CreateSipRuleRequest	withDisabled(Boolean disabled) Disables or enables a SIP rule.
CreateSipRuleRequest	withName(String name) The name of the SIP rule.
CreateSipRuleRequest	withTargetApplications(Collection<SipRuleTargetApplication> targetApplications) List of SIP media applications, with priority and AWS Region.
CreateSipRuleRequest	withTargetApplications(SipRuleTargetApplication... targetApplications) List of SIP media applications, with priority and AWS Region.
CreateSipRuleRequest	withTriggerType(SipRuleTriggerType triggerType) The type of trigger assigned to the SIP rule in TriggerValue, currently RequestUriHostname or ToPhoneNumber.
CreateSipRuleRequest	withTriggerType(String triggerType) The type of trigger assigned to the SIP rule in TriggerValue, currently RequestUriHostname or ToPhoneNumber.
CreateSipRuleRequest	withTriggerValue(String triggerValue) If TriggerType is RequestUriHostname, the value can be the outbound host name of a Voice Connector.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateSipRuleRequest

public CreateSipRuleRequest()

Method Detail

setName

public void setName(String name)

The name of the SIP rule.

Parameters:

name - The name of the SIP rule.

getName

public String getName()

The name of the SIP rule.

Returns:

The name of the SIP rule.

withName

public CreateSipRuleRequest withName(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.

setTriggerType

public void setTriggerType(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.

See Also:

SipRuleTriggerType

getTriggerType

public String getTriggerType()

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

Returns:

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

See Also:

SipRuleTriggerType

withTriggerType

public CreateSipRuleRequest withTriggerType(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

withTriggerType

public CreateSipRuleRequest withTriggerType(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

setTriggerValue

public void setTriggerValue(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.

getTriggerValue

public String getTriggerValue()

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.

withTriggerValue

public CreateSipRuleRequest withTriggerValue(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.

setDisabled

public void setDisabled(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.

getDisabled

public Boolean getDisabled()

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.

withDisabled

public CreateSipRuleRequest withDisabled(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.

isDisabled

public Boolean isDisabled()

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.

getTargetApplications

public List<SipRuleTargetApplication> getTargetApplications()

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

Returns:

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

setTargetApplications

public void setTargetApplications(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.

withTargetApplications

public CreateSipRuleRequest withTargetApplications(SipRuleTargetApplication... targetApplications)

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 setTargetApplications(java.util.Collection) or withTargetApplications(java.util.Collection) if you want to override the existing values.

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.

withTargetApplications

public CreateSipRuleRequest withTargetApplications(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.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateSipRuleRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()