Class PhoneNumberInformation
- java.lang.Object
-
- software.amazon.awssdk.services.sns.model.PhoneNumberInformation
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<PhoneNumberInformation.Builder,PhoneNumberInformation>
@Generated("software.amazon.awssdk:codegen") public final class PhoneNumberInformation extends Object implements SdkPojo, Serializable, ToCopyableBuilder<PhoneNumberInformation.Builder,PhoneNumberInformation>
A list of phone numbers and their metadata.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfacePhoneNumberInformation.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static PhoneNumberInformation.Builderbuilder()InstantcreatedAt()The date and time when the phone number was created.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasNumberCapabilities()For responses, this returns true if the service returned a value for the NumberCapabilities property.Stringiso2CountryCode()The two-character code for the country or region, in ISO 3166-1 alpha-2 format.List<NumberCapability>numberCapabilities()The capabilities of each phone number.List<String>numberCapabilitiesAsStrings()The capabilities of each phone number.StringphoneNumber()The phone number.RouteTyperouteType()The list of supported routes.StringrouteTypeAsString()The list of supported routes.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends PhoneNumberInformation.Builder>serializableBuilderClass()Stringstatus()The status of the phone number.PhoneNumberInformation.BuildertoBuilder()StringtoString()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
-
createdAt
public final Instant createdAt()
The date and time when the phone number was created.
- Returns:
- The date and time when the phone number was created.
-
phoneNumber
public final String phoneNumber()
The phone number.
- Returns:
- The phone number.
-
status
public final String status()
The status of the phone number.
- Returns:
- The status of the phone number.
-
iso2CountryCode
public final String iso2CountryCode()
The two-character code for the country or region, in ISO 3166-1 alpha-2 format.
- Returns:
- The two-character code for the country or region, in ISO 3166-1 alpha-2 format.
-
routeType
public final RouteType routeType()
The list of supported routes.
If the service returns an enum value that is not available in the current SDK version,
routeTypewill returnRouteType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromrouteTypeAsString().- Returns:
- The list of supported routes.
- See Also:
RouteType
-
routeTypeAsString
public final String routeTypeAsString()
The list of supported routes.
If the service returns an enum value that is not available in the current SDK version,
routeTypewill returnRouteType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromrouteTypeAsString().- Returns:
- The list of supported routes.
- See Also:
RouteType
-
numberCapabilities
public final List<NumberCapability> numberCapabilities()
The capabilities of each phone number.
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:
- The capabilities of each phone number.
-
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 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.
-
numberCapabilitiesAsStrings
public final List<String> numberCapabilitiesAsStrings()
The capabilities of each phone number.
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:
- The capabilities of each phone number.
-
toBuilder
public PhoneNumberInformation.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<PhoneNumberInformation.Builder,PhoneNumberInformation>
-
builder
public static PhoneNumberInformation.Builder builder()
-
serializableBuilderClass
public static Class<? extends PhoneNumberInformation.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-