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>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceSendDestinationNumberVerificationCodeRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static SendDestinationNumberVerificationCodeRequest.Builderbuilder()StringconfigurationSetName()The name of the configuration set to use.Map<String,String>context()You can specify custom data in this field.Map<DestinationCountryParameterKey,String>destinationCountryParameters()This field is used for any country-specific registration requirements.Map<String,String>destinationCountryParametersAsStrings()This field is used for any country-specific registration requirements.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasContext()For responses, this returns true if the service returned a value for the Context property.booleanhasDestinationCountryParameters()For responses, this returns true if the service returned a value for the DestinationCountryParameters property.inthashCode()LanguageCodelanguageCode()Choose the language to use for the message.StringlanguageCodeAsString()Choose the language to use for the message.StringoriginationIdentity()The origination identity of the message.List<SdkField<?>>sdkFields()static Class<? extends SendDestinationNumberVerificationCodeRequest.Builder>serializableBuilderClass()SendDestinationNumberVerificationCodeRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.VerificationChannelverificationChannel()Choose to send the verification code as an SMS or voice message.StringverificationChannelAsString()Choose to send the verification code as an SMS or voice message.StringverifiedDestinationNumberId()The unique identifier for the verified destination phone number.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
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,
verificationChannelwill returnVerificationChannel.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromverificationChannelAsString().- Returns:
- Choose to send the verification code as an SMS or voice message.
- See Also:
VerificationChannel
-
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,
verificationChannelwill returnVerificationChannel.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromverificationChannelAsString().- Returns:
- Choose to send the verification code as an SMS or voice message.
- See Also:
VerificationChannel
-
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,
languageCodewill returnLanguageCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromlanguageCodeAsString().- Returns:
- Choose the language to use for the message.
- See Also:
LanguageCode
-
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,
languageCodewill returnLanguageCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromlanguageCodeAsString().- Returns:
- Choose the language to use for the message.
- See Also:
LanguageCode
-
originationIdentity
public final String originationIdentity()
The origination identity of the message. This can be either the PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.
- Returns:
- The origination identity of the message. This can be either the PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.
-
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 theisEmpty()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 theisEmpty()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()
- Specified by:
toBuilderin interfaceToCopyableBuilder<SendDestinationNumberVerificationCodeRequest.Builder,SendDestinationNumberVerificationCodeRequest>- Specified by:
toBuilderin classPinpointSmsVoiceV2Request
-
builder
public static SendDestinationNumberVerificationCodeRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends SendDestinationNumberVerificationCodeRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
-