Package software.amazon.awssdk.services.pinpointsmsvoicev2.model

Class OriginationIdentityMetadata

java.lang.Object

software.amazon.awssdk.services.pinpointsmsvoicev2.model.OriginationIdentityMetadata

All Implemented Interfaces:

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

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

The metadata for an origination identity associated with a pool.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	OriginationIdentityMetadata.Builder

Method Summary

Modifier and Type	Method	Description
static OriginationIdentityMetadata.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasNumberCapabilities()	For responses, this returns true if the service returned a value for the NumberCapabilities property.
String	isoCountryCode()	The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
List<NumberCapability>	numberCapabilities()	Describes if the origination identity can be used for text messages, voice calls or both.
List<String>	numberCapabilitiesAsStrings()	Describes if the origination identity can be used for text messages, voice calls or both.
String	originationIdentity()	The unique identifier of the origination identity.
String	originationIdentityArn()	The Amazon Resource Name (ARN) associated with the origination identity.
String	phoneNumber()	The phone number in E.164 format.
List<SdkField<?>>	sdkFields()
static Class<? extends OriginationIdentityMetadata.Builder>	serializableBuilderClass()
OriginationIdentityMetadata.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

originationIdentityArn

public final String originationIdentityArn()

The Amazon Resource Name (ARN) associated with the origination identity.

Returns:

The Amazon Resource Name (ARN) associated with the origination identity.

originationIdentity

public final String originationIdentity()

The unique identifier of the origination identity.

Returns:

The unique identifier of the origination identity.

isoCountryCode

public final String isoCountryCode()

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

Returns:

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

numberCapabilities

public final List<NumberCapability> numberCapabilities()

Describes if the origination identity can be used for text messages, voice calls or both.

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

Returns:

Describes if the origination identity can be used for text messages, voice calls or both.

hasNumberCapabilities

public final boolean hasNumberCapabilities()

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

numberCapabilitiesAsStrings

public final List<String> numberCapabilitiesAsStrings()

Describes if the origination identity can be used for text messages, voice calls or both.

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

Returns:

Describes if the origination identity can be used for text messages, voice calls or both.

phoneNumber

public final String phoneNumber()

The phone number in E.164 format.

Returns:

The phone number in E.164 format.

toBuilder

public OriginationIdentityMetadata.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<OriginationIdentityMetadata.Builder,OriginationIdentityMetadata>

builder

public static OriginationIdentityMetadata.Builder builder()

serializableBuilderClass

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