Class NotifyCountryInformation

java.lang.Object
software.amazon.awssdk.services.pinpointsmsvoicev2.model.NotifyCountryInformation
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<NotifyCountryInformation.Builder,NotifyCountryInformation>
@Generated("software.amazon.awssdk:codegen") public final class NotifyCountryInformation extends Object implements SdkPojo, Serializable, ToCopyableBuilder<NotifyCountryInformation.Builder,NotifyCountryInformation>

The information for a country that supports notify messaging.

See Also:

  • Method Details

    • 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.

    • countryName

      public final String countryName()

      The name of the country.

      Returns:
      The name of the country.

    • supportedChannels

      public final List<NumberCapability> supportedChannels()

      An array of supported channels for the country. Supported values include SMS and VOICE.

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

      Returns:
      An array of supported channels for the country. Supported values include SMS and VOICE.

    • hasSupportedChannels

      public final boolean hasSupportedChannels()
      For responses, this returns true if the service returned a value for the SupportedChannels 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.

    • supportedChannelsAsStrings

      public final List<String> supportedChannelsAsStrings()

      An array of supported channels for the country. Supported values include SMS and VOICE.

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

      Returns:
      An array of supported channels for the country. Supported values include SMS and VOICE.

    • supportedUseCases

      public final List<NotifyConfigurationUseCase> supportedUseCases()

      An array of supported use cases for the country.

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

      Returns:
      An array of supported use cases for the country.

    • hasSupportedUseCases

      public final boolean hasSupportedUseCases()
      For responses, this returns true if the service returned a value for the SupportedUseCases 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.

    • supportedUseCasesAsStrings

      public final List<String> supportedUseCasesAsStrings()

      An array of supported use cases for the country.

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

      Returns:
      An array of supported use cases for the country.

    • supportedTiers

      public final List<NotifyConfigurationTier> supportedTiers()

      An array of supported tiers for the country.

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

      Returns:
      An array of supported tiers for the country.

    • hasSupportedTiers

      public final boolean hasSupportedTiers()
      For responses, this returns true if the service returned a value for the SupportedTiers 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.

    • supportedTiersAsStrings

      public final List<String> supportedTiersAsStrings()

      An array of supported tiers for the country.

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

      Returns:
      An array of supported tiers for the country.

    • customerOwnedIdentityRequired

      public final Boolean customerOwnedIdentityRequired()

      Whether a customer-owned identity is required to send notify messages to this country.

      Returns:
      Whether a customer-owned identity is required to send notify messages to this country.

    • toBuilder

      public NotifyCountryInformation.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<NotifyCountryInformation.Builder,NotifyCountryInformation>
      Returns:
      a builder for type T

    • builder

      public static NotifyCountryInformation.Builder builder()

    • serializableBuilderClass

      public static Class<? extends NotifyCountryInformation.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.