Class SipRule
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<SipRule.Builder,
SipRule>
The details of a SIP rule, including name, triggers, and target applications. An AWS account can have multiple SIP rules.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic SipRule.Builder
builder()
final Instant
The time at which the SIP rule was created, in ISO 8601 format.final Boolean
disabled()
Indicates whether the SIP rule is enabled or disabled.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the TargetApplications property.final String
name()
A SIP rule's name.static Class
<? extends SipRule.Builder> final String
A SIP rule's ID.final List
<SipRuleTargetApplication> The target SIP media application and other details, such as priority and AWS Region, to be specified in the SIP rule.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final SipRuleTriggerType
The type of trigger set for a SIP rule, either a phone number or a URI request host name.final String
The type of trigger set for a SIP rule, either a phone number or a URI request host name.final String
The value set for a SIP rule's trigger type.final Instant
The time at which the SIP rule was updated, in ISO 8601 format.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
sipRuleId
A SIP rule's ID.
- Returns:
- A SIP rule's ID.
-
name
A SIP rule's name.
- Returns:
- A SIP rule's name.
-
disabled
Indicates whether the SIP rule is enabled or disabled. You must disable a rule before you can delete it.
- Returns:
- Indicates whether the SIP rule is enabled or disabled. You must disable a rule before you can delete it.
-
triggerType
The type of trigger set for a SIP rule, either a phone number or a URI request host name.
If the service returns an enum value that is not available in the current SDK version,
triggerType
will returnSipRuleTriggerType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtriggerTypeAsString()
.- Returns:
- The type of trigger set for a SIP rule, either a phone number or a URI request host name.
- See Also:
-
triggerTypeAsString
The type of trigger set for a SIP rule, either a phone number or a URI request host name.
If the service returns an enum value that is not available in the current SDK version,
triggerType
will returnSipRuleTriggerType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtriggerTypeAsString()
.- Returns:
- The type of trigger set for a SIP rule, either a phone number or a URI request host name.
- See Also:
-
triggerValue
The value set for a SIP rule's trigger type. Either a phone number or a URI hostname.
- Returns:
- The value set for a SIP rule's trigger type. Either a phone number or a URI hostname.
-
hasTargetApplications
public final boolean hasTargetApplications()For responses, this returns true if the service returned a value for the TargetApplications property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
targetApplications
The target SIP media application and other details, such as priority and AWS Region, to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTargetApplications()
method.- Returns:
- The target SIP media application and other details, such as priority and AWS Region, to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided.
-
createdTimestamp
The time at which the SIP rule was created, in ISO 8601 format.
- Returns:
- The time at which the SIP rule was created, in ISO 8601 format.
-
updatedTimestamp
The time at which the SIP rule was updated, in ISO 8601 format.
- Returns:
- The time at which the SIP rule was updated, in ISO 8601 format.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<SipRule.Builder,
SipRule> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-