Class SendNotifyCodeVerificationRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.endusermessaging.model.EndUserMessagingRequest
software.amazon.awssdk.services.endusermessaging.model.SendNotifyCodeVerificationRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<SendNotifyCodeVerificationRequest.Builder,SendNotifyCodeVerificationRequest>
@Generated("software.amazon.awssdk:codegen") public final class SendNotifyCodeVerificationRequest extends EndUserMessagingRequest implements ToCopyableBuilder<SendNotifyCodeVerificationRequest.Builder,SendNotifyCodeVerificationRequest>

  • Method Details

    • channel

      public final NotifyChannel channel()

      The channel used to deliver the one-time passcode to the recipient.

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

      Returns:
      The channel used to deliver the one-time passcode to the recipient.
      See Also:

    • channelAsString

      public final String channelAsString()

      The channel used to deliver the one-time passcode to the recipient.

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

      Returns:
      The channel used to deliver the one-time passcode to the recipient.
      See Also:

    • destinationIdentity

      public final String destinationIdentity()

      The recipient identifier. For the TEXT and VOICE channels, specify an E.164 phone number. For the WhatsApp channel, specify a WhatsApp address.

      Returns:
      The recipient identifier. For the TEXT and VOICE channels, specify an E.164 phone number. For the WhatsApp channel, specify a WhatsApp address.

    • originationIdentity

      public final String originationIdentity()

      The identity used to send the message, such as a phone number, sender ID, or pool that is owned by your account.

      Returns:
      The identity used to send the message, such as a phone number, sender ID, or pool that is owned by your account.

    • notifyCodeConfiguration

      public final String notifyCodeConfiguration()

      The identifier or Amazon Resource Name (ARN) of the notify code configuration that supplies the passcode policy and template defaults. When you do not specify a configuration, you must supply the template in the request.

      Returns:
      The identifier or Amazon Resource Name (ARN) of the notify code configuration that supplies the passcode policy and template defaults. When you do not specify a configuration, you must supply the template in the request.

    • overrideChannelParameters

      public final ChannelParameters overrideChannelParameters()

      The channel-specific parameters used to render and deliver the one-time passcode for this request. The route that is derived from the channel and the origination identity selects the matching channel. When you do not specify channel parameters, the service uses the parameters from the referenced notify code configuration.

      Returns:
      The channel-specific parameters used to render and deliver the one-time passcode for this request. The route that is derived from the channel and the origination identity selects the matching channel. When you do not specify channel parameters, the service uses the parameters from the referenced notify code configuration.

    • overrideCodeConfigurationParameters

      public final CodeConfigurationParameters overrideCodeConfigurationParameters()

      The per-send overrides for the passcode policy parameters, including the code type, length, validity period, and maximum number of attempts. These values override the values from the referenced notify code configuration. When you do not specify a value, the value from the configuration is used, and if neither is set, the service default applies.

      Returns:
      The per-send overrides for the passcode policy parameters, including the code type, length, validity period, and maximum number of attempts. These values override the values from the referenced notify code configuration. When you do not specify a value, the value from the configuration is used, and if neither is set, the service default applies.

    • configurationSetName

      public final String configurationSetName()

      The name of the configuration set used to control how delivery events for the message are handled.

      Returns:
      The name of the configuration set used to control how delivery events for the message are handled.

    • hasContext

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

    • context

      public final Map<String,String> context()

      A map of custom key and value pairs that are propagated to the delivery events for this verification.

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

      Returns:
      A map of custom key and value pairs that are propagated to the delivery events for this verification.

    • referenceId

      public final String referenceId()

      A caller-supplied reference identifier that binds a send request to a later validate request. Specify the same value in both requests.

      Returns:
      A caller-supplied reference identifier that binds a send request to a later validate request. Specify the same value in both requests.

    • toBuilder

      public SendNotifyCodeVerificationRequest.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<SendNotifyCodeVerificationRequest.Builder,SendNotifyCodeVerificationRequest>
      Specified by:
      toBuilder in class EndUserMessagingRequest
      Returns:
      a builder for type T

    • builder

      public static SendNotifyCodeVerificationRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends SendNotifyCodeVerificationRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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