SipRule (AWS Java SDK :: Services :: Chime SDK Voice 2.20.68 API)

java.lang.Object
- software.amazon.awssdk.services.chimesdkvoice.model.SipRule

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<SipRule.Builder,SipRule>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class SipRule
extends Object
implements SdkPojo, Serializable, 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:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface SipRule.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`SipRule.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static SipRule.Builder`	`builder()`
`Instant`	`createdTimestamp()` The time at which the SIP rule was created, in ISO 8601 format.
`Boolean`	`disabled()` Indicates whether the SIP rule is enabled or disabled.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasTargetApplications()` For responses, this returns true if the service returned a value for the TargetApplications property.
`String`	`name()` A SIP rule's name.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends SipRule.Builder>`	`serializableBuilderClass()`
`String`	`sipRuleId()` A SIP rule's ID.
`List<SipRuleTargetApplication>`	`targetApplications()` The target SIP media application and other details, such as priority and AWS Region, to be specified in the SIP rule.
`SipRule.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`SipRuleTriggerType`	`triggerType()` The type of trigger set for a SIP rule, either a phone number or a URI request host name.
`String`	`triggerTypeAsString()` The type of trigger set for a SIP rule, either a phone number or a URI request host name.
`String`	`triggerValue()` The value set for a SIP rule's trigger type.
`Instant`	`updatedTimestamp()` The time at which the SIP rule was updated, in ISO 8601 format.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - sipRuleId
```
public final String sipRuleId()
```
    A SIP rule's ID.
    
    Returns:
    
    A SIP rule's ID.
  - name
```
public final String name()
```
    A SIP rule's name.
    
    Returns:
    
    A SIP rule's name.
  - disabled
```
public final Boolean 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
```
public final SipRuleTriggerType 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 return SipRuleTriggerType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from triggerTypeAsString().
    
    Returns:
    
    The type of trigger set for a SIP rule, either a phone number or a URI request host name.
    
    See Also:
    
    SipRuleTriggerType
  - triggerTypeAsString
```
public final String 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 return SipRuleTriggerType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from triggerTypeAsString().
    
    Returns:
    
    The type of trigger set for a SIP rule, either a phone number or a URI request host name.
    
    See Also:
    
    SipRuleTriggerType
  - triggerValue
```
public final String 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 the isEmpty() 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
```
public final List<SipRuleTargetApplication> 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
```
public final Instant 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
```
public final Instant 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
```
public SipRule.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<SipRule.Builder,SipRule>
  - builder
```
public static SipRule.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends SipRule.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class SipRule

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

sipRuleId

name

disabled

triggerType

triggerTypeAsString

triggerValue

hasTargetApplications

targetApplications

createdTimestamp

updatedTimestamp

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields