software.amazon.awssdk.services.amplifybackend.model

Class UpdateBackendAuthForgotPasswordConfig

java.lang.Object

software.amazon.awssdk.services.amplifybackend.model.UpdateBackendAuthForgotPasswordConfig

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<UpdateBackendAuthForgotPasswordConfig.Builder,UpdateBackendAuthForgotPasswordConfig>

@Generated(value="software.amazon.awssdk:codegen")
public final class UpdateBackendAuthForgotPasswordConfig
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<UpdateBackendAuthForgotPasswordConfig.Builder,UpdateBackendAuthForgotPasswordConfig>

Describes the forgot password policy for authenticating into the Amplify app.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateBackendAuthForgotPasswordConfig.Builder

Method Summary

Modifier and Type	Method and Description
static UpdateBackendAuthForgotPasswordConfig.Builder	builder()
DeliveryMethod	deliveryMethod() Describes which method to use (either SMS or email) to deliver messages to app users that want to recover their password.
String	deliveryMethodAsString() Describes which method to use (either SMS or email) to deliver messages to app users that want to recover their password.
EmailSettings	emailSettings() The configuration for the email sent when an app user forgets their password.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateBackendAuthForgotPasswordConfig.Builder>	serializableBuilderClass()
SmsSettings	smsSettings() The configuration for the SMS message sent when an Amplify app user forgets their password.
UpdateBackendAuthForgotPasswordConfig.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.

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

deliveryMethod

public final DeliveryMethod deliveryMethod()

Describes which method to use (either SMS or email) to deliver messages to app users that want to recover their password.

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

Returns:

Describes which method to use (either SMS or email) to deliver messages to app users that want to recover their password.

See Also:

DeliveryMethod

deliveryMethodAsString

public final String deliveryMethodAsString()

Describes which method to use (either SMS or email) to deliver messages to app users that want to recover their password.

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

Returns:

Describes which method to use (either SMS or email) to deliver messages to app users that want to recover their password.

See Also:

DeliveryMethod

emailSettings

public final EmailSettings emailSettings()

The configuration for the email sent when an app user forgets their password.

Returns:

The configuration for the email sent when an app user forgets their password.

smsSettings

public final SmsSettings smsSettings()

The configuration for the SMS message sent when an Amplify app user forgets their password.

Returns:

The configuration for the SMS message sent when an Amplify app user forgets their password.

toBuilder

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

Returns:

a builder for type T

builder

public static UpdateBackendAuthForgotPasswordConfig.Builder builder()

serializableBuilderClass

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