Package software.amazon.awssdk.services.chimesdkvoice.model

Class Termination

java.lang.Object

software.amazon.awssdk.services.chimesdkvoice.model.Termination

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Termination.Builder,Termination>

@Generated("software.amazon.awssdk:codegen")
public final class Termination
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Termination.Builder,Termination>

Termination settings enable SIP hosts to make outbound calls using an Amazon Chime SDK Voice Connector.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Termination.Builder

Method Summary

Modifier and Type	Method	Description
static Termination.Builder	builder()
List<String>	callingRegions()	The countries to which calls are allowed, in ISO 3166-1 alpha-2 format.
List<String>	cidrAllowedList()	The IP addresses allowed to make calls, in CIDR format.
Integer	cpsLimit()	The limit on calls per second.
String	defaultPhoneNumber()	The default outbound calling number.
Boolean	disabled()	When termination is disabled, outbound calls cannot be made.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasCallingRegions()	For responses, this returns true if the service returned a value for the CallingRegions property.
boolean	hasCidrAllowedList()	For responses, this returns true if the service returned a value for the CidrAllowedList property.
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends Termination.Builder>	serializableBuilderClass()
Termination.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

cpsLimit

public final Integer cpsLimit()

The limit on calls per second. Max value based on account service quota. Default value of 1.

Returns:

The limit on calls per second. Max value based on account service quota. Default value of 1.

defaultPhoneNumber

public final String defaultPhoneNumber()

The default outbound calling number.

Returns:

The default outbound calling number.

hasCallingRegions

public final boolean hasCallingRegions()

For responses, this returns true if the service returned a value for the CallingRegions 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.

callingRegions

public final List<String> callingRegions()

The countries to which calls are allowed, in ISO 3166-1 alpha-2 format. Required.

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 hasCallingRegions() method.

Returns:

The countries to which calls are allowed, in ISO 3166-1 alpha-2 format. Required.

hasCidrAllowedList

public final boolean hasCidrAllowedList()

For responses, this returns true if the service returned a value for the CidrAllowedList 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.

cidrAllowedList

public final List<String> cidrAllowedList()

The IP addresses allowed to make calls, in CIDR format.

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 hasCidrAllowedList() method.

Returns:

The IP addresses allowed to make calls, in CIDR format.

disabled

public final Boolean disabled()

When termination is disabled, outbound calls cannot be made.

Returns:

When termination is disabled, outbound calls cannot be made.

toBuilder

public Termination.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Termination.Builder,Termination>

builder

public static Termination.Builder builder()

serializableBuilderClass

public static Class<? extends Termination.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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo