Class RcsFallbackConfiguration

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

Configuration for SMS or MMS fallback when RCS delivery fails or the TimeToLive expires without delivery confirmation.

See Also:

  • Method Details

    • channel

      public final RcsFallbackChannel channel()

      The fallback channel to use when RCS delivery fails. Valid values are SMS and MMS. SMS and MMS are mutually exclusive.

      If the service returns an enum value that is not available in the current SDK version, channel will return RcsFallbackChannel.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from channelAsString().

      Returns:
      The fallback channel to use when RCS delivery fails. Valid values are SMS and MMS. SMS and MMS are mutually exclusive.
      See Also:

    • channelAsString

      public final String channelAsString()

      The fallback channel to use when RCS delivery fails. Valid values are SMS and MMS. SMS and MMS are mutually exclusive.

      If the service returns an enum value that is not available in the current SDK version, channel will return RcsFallbackChannel.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from channelAsString().

      Returns:
      The fallback channel to use when RCS delivery fails. Valid values are SMS and MMS. SMS and MMS are mutually exclusive.
      See Also:

    • messageBody

      public final String messageBody()

      The text body of the fallback message. Required for SMS fallback. For MMS fallback, at least one of MessageBody or MediaUrls must be provided.

      Returns:
      The text body of the fallback message. Required for SMS fallback. For MMS fallback, at least one of MessageBody or MediaUrls must be provided.

    • hasMediaUrls

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

    • mediaUrls

      public final List<String> mediaUrls()

      An array of S3 URIs to media files for MMS fallback. Only valid when Channel is MMS.

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

      Returns:
      An array of S3 URIs to media files for MMS fallback. Only valid when Channel is MMS.

    • originationIdentity

      public final String originationIdentity()

      The origination identity to use for the fallback message. This can be a PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, or SenderIdArn. Pool IDs and pool ARNs are not accepted. If not specified and the original message was sent via a pool, the service selects a suitable number from the pool.

      Returns:
      The origination identity to use for the fallback message. This can be a PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, or SenderIdArn. Pool IDs and pool ARNs are not accepted. If not specified and the original message was sent via a pool, the service selects a suitable number from the pool.

    • toBuilder

      public RcsFallbackConfiguration.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<RcsFallbackConfiguration.Builder,RcsFallbackConfiguration>
      Returns:
      a builder for type T

    • builder

      public static RcsFallbackConfiguration.Builder builder()

    • serializableBuilderClass

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