software.amazon.awssdk.services.cognitoidentityprovider.model

Class VerificationMessageTemplateType

java.lang.Object

software.amazon.awssdk.services.cognitoidentityprovider.model.VerificationMessageTemplateType

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<VerificationMessageTemplateType.Builder,VerificationMessageTemplateType>

@Generated(value="software.amazon.awssdk:codegen")
public class VerificationMessageTemplateType
extends Object
implements StructuredPojo, ToCopyableBuilder<VerificationMessageTemplateType.Builder,VerificationMessageTemplateType>

The template for verification messages.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	VerificationMessageTemplateType.Builder

Method Summary

Modifier and Type	Method and Description
static VerificationMessageTemplateType.Builder	builder()
DefaultEmailOptionType	defaultEmailOption() The default email option.
String	defaultEmailOptionAsString() The default email option.
String	emailMessage() The email message template.
String	emailMessageByLink() The email message template for sending a confirmation link to the user.
String	emailSubject() The subject line for the email message template.
String	emailSubjectByLink() The subject line for the email message template for sending a confirmation link to the user.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
static Class<? extends VerificationMessageTemplateType.Builder>	serializableBuilderClass()
String	smsMessage() The SMS message template.
VerificationMessageTemplateType.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

smsMessage

public String smsMessage()

The SMS message template.

Returns:

The SMS message template.

emailMessage

public String emailMessage()

The email message template.

Returns:

The email message template.

emailSubject

public String emailSubject()

The subject line for the email message template.

Returns:

The subject line for the email message template.

emailMessageByLink

public String emailMessageByLink()

The email message template for sending a confirmation link to the user.

Returns:

The email message template for sending a confirmation link to the user.

emailSubjectByLink

public String emailSubjectByLink()

The subject line for the email message template for sending a confirmation link to the user.

Returns:

The subject line for the email message template for sending a confirmation link to the user.

defaultEmailOption

public DefaultEmailOptionType defaultEmailOption()

The default email option.

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

Returns:

The default email option.

See Also:

DefaultEmailOptionType

defaultEmailOptionAsString

public String defaultEmailOptionAsString()

The default email option.

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

Returns:

The default email option.

See Also:

DefaultEmailOptionType

toBuilder

public VerificationMessageTemplateType.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<VerificationMessageTemplateType.Builder,VerificationMessageTemplateType>

Returns:

a builder for type T

builder

public static VerificationMessageTemplateType.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.