Class SMSChannelResponse

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

Provides information about the status and settings of the SMS channel for an application.

See Also:

  • Method Details

    • applicationId

      public final String applicationId()

      The unique identifier for the application that the SMS channel applies to.

      Returns:
      The unique identifier for the application that the SMS channel applies to.

    • creationDate

      public final String creationDate()

      The date and time, in ISO 8601 format, when the SMS channel was enabled.

      Returns:
      The date and time, in ISO 8601 format, when the SMS channel was enabled.

    • enabled

      public final Boolean enabled()

      Specifies whether the SMS channel is enabled for the application.

      Returns:
      Specifies whether the SMS channel is enabled for the application.

    • hasCredential

      public final Boolean hasCredential()

      (Not used) This property is retained only for backward compatibility.

      Returns:
      (Not used) This property is retained only for backward compatibility.

    • id

      public final String id()

      (Deprecated) An identifier for the SMS channel. This property is retained only for backward compatibility.

      Returns:
      (Deprecated) An identifier for the SMS channel. This property is retained only for backward compatibility.

    • isArchived

      public final Boolean isArchived()

      Specifies whether the SMS channel is archived.

      Returns:
      Specifies whether the SMS channel is archived.

    • lastModifiedBy

      public final String lastModifiedBy()

      The user who last modified the SMS channel.

      Returns:
      The user who last modified the SMS channel.

    • lastModifiedDate

      public final String lastModifiedDate()

      The date and time, in ISO 8601 format, when the SMS channel was last modified.

      Returns:
      The date and time, in ISO 8601 format, when the SMS channel was last modified.

    • platform

      public final String platform()

      The type of messaging or notification platform for the channel. For the SMS channel, this value is SMS.

      Returns:
      The type of messaging or notification platform for the channel. For the SMS channel, this value is SMS.

    • promotionalMessagesPerSecond

      public final Integer promotionalMessagesPerSecond()

      The maximum number of promotional messages that you can send through the SMS channel each second.

      Returns:
      The maximum number of promotional messages that you can send through the SMS channel each second.

    • senderId

      public final String senderId()

      The identity that displays on recipients' devices when they receive messages from the SMS channel.

      Returns:
      The identity that displays on recipients' devices when they receive messages from the SMS channel.

    • shortCode

      public final String shortCode()

      The registered short code to use when you send messages through the SMS channel.

      Returns:
      The registered short code to use when you send messages through the SMS channel.

    • transactionalMessagesPerSecond

      public final Integer transactionalMessagesPerSecond()

      The maximum number of transactional messages that you can send through the SMS channel each second.

      Returns:
      The maximum number of transactional messages that you can send through the SMS channel each second.

    • version

      public final Integer version()

      The current version of the SMS channel.

      Returns:
      The current version of the SMS channel.

    • toBuilder

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

    • builder

      public static SMSChannelResponse.Builder builder()

    • serializableBuilderClass

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