com.amazonaws.services.chime.model

Class SipRule

java.lang.Object

com.amazonaws.services.chime.model.SipRule

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

The SIP rule details, including name, triggers, and target applications. An AWS account can have multiple SIP rules.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
SipRule()

Method Summary

Modifier and Type	Method and Description
SipRule	clone()
boolean	equals(Object obj)
Date	getCreatedTimestamp() The SIP rule created timestamp, in ISO 8601 format.
Boolean	getDisabled() Indicates if the SIP rule is enabled or disabled.
String	getName() The name of the SIP rule.
String	getSipRuleId() The SIP rule ID.
List<SipRuleTargetApplication>	getTargetApplications() List of SIP media applications with priority and AWS Region.
String	getTriggerType() The type of trigger whose value is assigned to the SIP rule in TriggerValue.
String	getTriggerValue() If TriggerType is RequestUriHostname, then the value can be the outbound host name of the Amazon Chime Voice Connector.
Date	getUpdatedTimestamp() The SIP rule updated timestamp, in ISO 8601 format.
int	hashCode()
Boolean	isDisabled() Indicates if the SIP rule is enabled or disabled.
void	marshall(ProtocolMarshaller protocolMarshaller)
void	setCreatedTimestamp(Date createdTimestamp) The SIP rule created timestamp, in ISO 8601 format.
void	setDisabled(Boolean disabled) Indicates if the SIP rule is enabled or disabled.
void	setName(String name) The name of the SIP rule.
void	setSipRuleId(String sipRuleId) The SIP rule ID.
void	setTargetApplications(Collection<SipRuleTargetApplication> targetApplications) List of SIP media applications with priority and AWS Region.
void	setTriggerType(String triggerType) The type of trigger whose value is assigned to the SIP rule in TriggerValue.
void	setTriggerValue(String triggerValue) If TriggerType is RequestUriHostname, then the value can be the outbound host name of the Amazon Chime Voice Connector.
void	setUpdatedTimestamp(Date updatedTimestamp) The SIP rule updated timestamp, in ISO 8601 format.
String	toString() Returns a string representation of this object.
SipRule	withCreatedTimestamp(Date createdTimestamp) The SIP rule created timestamp, in ISO 8601 format.
SipRule	withDisabled(Boolean disabled) Indicates if the SIP rule is enabled or disabled.
SipRule	withName(String name) The name of the SIP rule.
SipRule	withSipRuleId(String sipRuleId) The SIP rule ID.
SipRule	withTargetApplications(Collection<SipRuleTargetApplication> targetApplications) List of SIP media applications with priority and AWS Region.
SipRule	withTargetApplications(SipRuleTargetApplication... targetApplications) List of SIP media applications with priority and AWS Region.
SipRule	withTriggerType(SipRuleTriggerType triggerType) The type of trigger whose value is assigned to the SIP rule in TriggerValue.
SipRule	withTriggerType(String triggerType) The type of trigger whose value is assigned to the SIP rule in TriggerValue.
SipRule	withTriggerValue(String triggerValue) If TriggerType is RequestUriHostname, then the value can be the outbound host name of the Amazon Chime Voice Connector.
SipRule	withUpdatedTimestamp(Date updatedTimestamp) The SIP rule updated timestamp, in ISO 8601 format.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SipRule

public SipRule()

Method Detail

setSipRuleId

public void setSipRuleId(String sipRuleId)

The SIP rule ID.

Parameters:

sipRuleId - The SIP rule ID.

getSipRuleId

public String getSipRuleId()

The SIP rule ID.

Returns:

The SIP rule ID.

withSipRuleId

public SipRule withSipRuleId(String sipRuleId)

The SIP rule ID.

Parameters:

sipRuleId - The SIP rule ID.

Returns:

Returns a reference to this object so that method calls can be chained together.

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

setDisabled

public void setDisabled(Boolean disabled)

Indicates if the SIP rule is enabled or disabled. You must disable a rule before you can delete it.

Parameters:

disabled - Indicates if the SIP rule is enabled or disabled. You must disable a rule before you can delete it.

getDisabled

public Boolean getDisabled()

Indicates if the SIP rule is enabled or disabled. You must disable a rule before you can delete it.

Returns:

Indicates if the SIP rule is enabled or disabled. You must disable a rule before you can delete it.

withDisabled

public SipRule withDisabled(Boolean disabled)

Indicates if the SIP rule is enabled or disabled. You must disable a rule before you can delete it.

Parameters:

disabled - Indicates if the SIP rule is enabled or disabled. You must disable a rule before you can delete it.

Returns:

Returns a reference to this object so that method calls can be chained together.

isDisabled

public Boolean isDisabled()

Indicates if the SIP rule is enabled or disabled. You must disable a rule before you can delete it.

Returns:

Indicates if the SIP rule is enabled or disabled. You must disable a rule before you can delete it.

setTriggerType

public void setTriggerType(String triggerType)

The type of trigger whose value is assigned to the SIP rule in TriggerValue.

Parameters:

triggerType - The type of trigger whose value is assigned to the SIP rule in TriggerValue.

See Also:

SipRuleTriggerType

getTriggerType

public String getTriggerType()

The type of trigger whose value is assigned to the SIP rule in TriggerValue.

Returns:

The type of trigger whose value is assigned to the SIP rule in TriggerValue.

See Also:

SipRuleTriggerType

withTriggerType

public SipRule withTriggerType(String triggerType)

The type of trigger whose value is assigned to the SIP rule in TriggerValue.

Parameters:

triggerType - The type of trigger whose value is assigned to the SIP rule in TriggerValue.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

SipRuleTriggerType

withTriggerType

public SipRule withTriggerType(SipRuleTriggerType triggerType)

The type of trigger whose value is assigned to the SIP rule in TriggerValue.

Parameters:

triggerType - The type of trigger whose value is assigned to the SIP rule in TriggerValue.

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, then the value can be the outbound host name of the Amazon Chime Voice Connector. If TriggerType is ToPhoneNumber, then the value can be a customer-owned phone number in E164 format. SipRule is triggered when a SIP rule requests host name or ToPhoneNumber matches in the incoming SIP request.

Parameters:

triggerValue - If TriggerType is RequestUriHostname, then the value can be the outbound host name of the Amazon Chime Voice Connector. If TriggerType is ToPhoneNumber, then the value can be a customer-owned phone number in E164 format. SipRule is triggered when a SIP rule requests host name or ToPhoneNumber matches in the incoming SIP request.

getTriggerValue

public String getTriggerValue()

If TriggerType is RequestUriHostname, then the value can be the outbound host name of the Amazon Chime Voice Connector. If TriggerType is ToPhoneNumber, then the value can be a customer-owned phone number in E164 format. SipRule is triggered when a SIP rule requests host name or ToPhoneNumber matches in the incoming SIP request.

Returns:

If TriggerType is RequestUriHostname, then the value can be the outbound host name of the Amazon Chime Voice Connector. If TriggerType is ToPhoneNumber, then the value can be a customer-owned phone number in E164 format. SipRule is triggered when a SIP rule requests host name or ToPhoneNumber matches in the incoming SIP request.

withTriggerValue

public SipRule withTriggerValue(String triggerValue)

If TriggerType is RequestUriHostname, then the value can be the outbound host name of the Amazon Chime Voice Connector. If TriggerType is ToPhoneNumber, then the value can be a customer-owned phone number in E164 format. SipRule is triggered when a SIP rule requests host name or ToPhoneNumber matches in the incoming SIP request.

Parameters:

triggerValue - If TriggerType is RequestUriHostname, then the value can be the outbound host name of the Amazon Chime Voice Connector. If TriggerType is ToPhoneNumber, then the value can be a customer-owned phone number in E164 format. SipRule is triggered when a SIP rule requests host name or ToPhoneNumber matches in the incoming SIP request.

Returns:

Returns a reference to this object so that method calls can be chained together.

getTargetApplications

public List<SipRuleTargetApplication> getTargetApplications()

List of SIP media applications with priority and AWS Region. You can only use one SIP application per AWS Region and priority combination.

Returns:

List of SIP media applications with priority and AWS Region. You can only use one SIP application per AWS Region and priority combination.

setTargetApplications

public void setTargetApplications(Collection<SipRuleTargetApplication> targetApplications)

List of SIP media applications with priority and AWS Region. You can only use one SIP application per AWS Region and priority combination.

Parameters:

targetApplications - List of SIP media applications with priority and AWS Region. You can only use one SIP application per AWS Region and priority combination.

withTargetApplications

public SipRule withTargetApplications(SipRuleTargetApplication... targetApplications)

List of SIP media applications with priority and AWS Region. You can only use one SIP application per AWS Region and priority combination.

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. You can only use one SIP application per AWS Region and priority combination.

Returns:

Returns a reference to this object so that method calls can be chained together.

withTargetApplications

public SipRule withTargetApplications(Collection<SipRuleTargetApplication> targetApplications)

List of SIP media applications with priority and AWS Region. You can only use one SIP application per AWS Region and priority combination.

Parameters:

targetApplications - List of SIP media applications with priority and AWS Region. You can only use one SIP application per AWS Region and priority combination.

Returns:

Returns a reference to this object so that method calls can be chained together.

setCreatedTimestamp

public void setCreatedTimestamp(Date createdTimestamp)

The SIP rule created timestamp, in ISO 8601 format.

Parameters:

createdTimestamp - The SIP rule created timestamp, in ISO 8601 format.

getCreatedTimestamp

public Date getCreatedTimestamp()

The SIP rule created timestamp, in ISO 8601 format.

Returns:

The SIP rule created timestamp, in ISO 8601 format.

withCreatedTimestamp

public SipRule withCreatedTimestamp(Date createdTimestamp)

The SIP rule created timestamp, in ISO 8601 format.

Parameters:

createdTimestamp - The SIP rule created timestamp, in ISO 8601 format.

Returns:

Returns a reference to this object so that method calls can be chained together.

setUpdatedTimestamp

public void setUpdatedTimestamp(Date updatedTimestamp)

The SIP rule updated timestamp, in ISO 8601 format.

Parameters:

updatedTimestamp - The SIP rule updated timestamp, in ISO 8601 format.

getUpdatedTimestamp

public Date getUpdatedTimestamp()

The SIP rule updated timestamp, in ISO 8601 format.

Returns:

The SIP rule updated timestamp, in ISO 8601 format.

withUpdatedTimestamp

public SipRule withUpdatedTimestamp(Date updatedTimestamp)

The SIP rule updated timestamp, in ISO 8601 format.

Parameters:

updatedTimestamp - The SIP rule updated timestamp, in ISO 8601 format.

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 SipRule clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Specified by:

marshall in interface StructuredPojo