Class SendDestinationNumberVerificationCodeRequest

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

  • Method Details

    • verifiedDestinationNumberId

      public final String verifiedDestinationNumberId()

      The unique identifier for the verified destination phone number.

      Returns:
      The unique identifier for the verified destination phone number.

    • verificationChannel

      public final VerificationChannel verificationChannel()

      Choose to send the verification code as an SMS or voice message.

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

      Returns:
      Choose to send the verification code as an SMS or voice message.
      See Also:

    • verificationChannelAsString

      public final String verificationChannelAsString()

      Choose to send the verification code as an SMS or voice message.

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

      Returns:
      Choose to send the verification code as an SMS or voice message.
      See Also:

    • languageCode

      public final LanguageCode languageCode()

      Choose the language to use for the message.

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

      Returns:
      Choose the language to use for the message.
      See Also:

    • languageCodeAsString

      public final String languageCodeAsString()

      Choose the language to use for the message.

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

      Returns:
      Choose the language to use for the message.
      See Also:

    • originationIdentity

      public final String originationIdentity()

      The origination identity of the message. This can be either the PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.

      If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

      Returns:
      The origination identity of the message. This can be either the PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.

      If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

    • configurationSetName

      public final String configurationSetName()

      The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.

      Returns:
      The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.

    • 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()

      You can specify custom data in this field. If you do, that data is logged to the event destination.

      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:
      You can specify custom data in this field. If you do, that data is logged to the event destination.

    • destinationCountryParameters

      public final Map<DestinationCountryParameterKey,String> destinationCountryParameters()

      This field is used for any country-specific registration requirements. Currently, this setting is only used when you send messages to recipients in India using a sender ID. For more information see Special requirements for sending SMS messages to recipients in India.

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

      Returns:
      This field is used for any country-specific registration requirements. Currently, this setting is only used when you send messages to recipients in India using a sender ID. For more information see Special requirements for sending SMS messages to recipients in India.

    • hasDestinationCountryParameters

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

    • destinationCountryParametersAsStrings

      public final Map<String,String> destinationCountryParametersAsStrings()

      This field is used for any country-specific registration requirements. Currently, this setting is only used when you send messages to recipients in India using a sender ID. For more information see Special requirements for sending SMS messages to recipients in India.

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

      Returns:
      This field is used for any country-specific registration requirements. Currently, this setting is only used when you send messages to recipients in India using a sender ID. For more information see Special requirements for sending SMS messages to recipients in India.

    • toBuilder

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

    • builder

      public static SendDestinationNumberVerificationCodeRequest.Builder builder()

    • serializableBuilderClass

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