Class ChannelParameters

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

The channel-specific parameters used to render and deliver a one-time passcode. Each member configures the parameters for one delivery route. Populate only the channels that a configuration or send request supports. A notify code configuration can carry every channel at once, and a send request resolves to a single route that selects the matching channel at send time.

See Also:

  • Method Details

    • text

      public final TextParameters text()

      The parameters for the text channel, which delivers over SMS or RCS.

      Returns:
      The parameters for the text channel, which delivers over SMS or RCS.

    • voice

      public final VoiceParameters voice()

      The parameters for the voice channel.

      Returns:
      The parameters for the voice channel.

    • notifyValue

      public final NotifyParameters notifyValue()

      The parameters for the preapproved notify-template route over the SMS or voice channels.

      Returns:
      The parameters for the preapproved notify-template route over the SMS or voice channels.

    • whatsApp

      public final WhatsAppParameters whatsApp()

      The parameters for the WhatsApp channel.

      Returns:
      The parameters for the WhatsApp channel.

    • toBuilder

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

    • builder

      public static ChannelParameters.Builder builder()

    • serializableBuilderClass

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