software.amazon.awssdk.services.chime.model

Class CreateSipRuleRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.chime.model.ChimeRequest

software.amazon.awssdk.services.chime.model.CreateSipRuleRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateSipRuleRequest.Builder,CreateSipRuleRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateSipRuleRequest
extends ChimeRequest
implements ToCopyableBuilder<CreateSipRuleRequest.Builder,CreateSipRuleRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateSipRuleRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateSipRuleRequest.Builder	builder()
Boolean	disabled() Enables or disables a rule.
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() The name of the SIP rule.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateSipRuleRequest.Builder>	serializableBuilderClass()
List<SipRuleTargetApplication>	targetApplications() List of SIP media applications with priority and AWS Region.
CreateSipRuleRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
SipRuleTriggerType	triggerType() The type of trigger assigned to the SIP rule in TriggerValue, currently RequestUriHostname or ToPhoneNumber.
String	triggerTypeAsString() The type of trigger assigned to the SIP rule in TriggerValue, currently RequestUriHostname or ToPhoneNumber.
String	triggerValue() If TriggerType is RequestUriHostname, the value can be the outbound host name of an Amazon Chime Voice Connector.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

name

public final String name()

The name of the SIP rule.

Returns:

The name of the SIP rule.

triggerType

public final SipRuleTriggerType triggerType()

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

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 assigned to the SIP rule in TriggerValue, currently RequestUriHostname or ToPhoneNumber.

See Also:

SipRuleTriggerType

triggerTypeAsString

public final String triggerTypeAsString()

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

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 assigned to the SIP rule in TriggerValue, currently RequestUriHostname or ToPhoneNumber.

See Also:

SipRuleTriggerType

triggerValue

public final String triggerValue()

If TriggerType is RequestUriHostname, the value can be the outbound host name of an Amazon Chime 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 an Amazon Chime 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.

disabled

public final Boolean disabled()

Enables or disables a rule. You must disable rules before you can delete them.

Returns:

Enables or disables a rule. You must disable rules before you can delete them.

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

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

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:

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

toBuilder

public CreateSipRuleRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateSipRuleRequest.Builder,CreateSipRuleRequest>

Specified by:

toBuilder in class ChimeRequest

builder

public static CreateSipRuleRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateSipRuleRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo