com.amplifyframework.auth.cognito.options

Class AWSCognitoAuthResetPasswordOptions.CognitoBuilder

java.lang.Object

com.amplifyframework.auth.options.AuthResetPasswordOptions.Builder<AWSCognitoAuthResetPasswordOptions.CognitoBuilder>

com.amplifyframework.auth.cognito.options.AWSCognitoAuthResetPasswordOptions.CognitoBuilder

Enclosing class:

AWSCognitoAuthResetPasswordOptions

public static final class AWSCognitoAuthResetPasswordOptions.CognitoBuilder
extends com.amplifyframework.auth.options.AuthResetPasswordOptions.Builder<AWSCognitoAuthResetPasswordOptions.CognitoBuilder>

The builder for this class.

Constructor Summary

Constructors

Constructor and Description
CognitoBuilder() Constructor for the builder.

Method Summary

Modifier and Type	Method and Description
AWSCognitoAuthResetPasswordOptions	build() Construct and return the object with the values set in the builder.
AWSCognitoAuthResetPasswordOptions.CognitoBuilder	getThis() Returns the type of builder this is to support proper flow with it being an extended class.
AWSCognitoAuthResetPasswordOptions.CognitoBuilder	metadata(java.util.Map<java.lang.String,java.lang.String> metadata) Set the metadata field for the object being built.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CognitoBuilder

public CognitoBuilder()

Constructor for the builder.

Method Detail

getThis

public AWSCognitoAuthResetPasswordOptions.CognitoBuilder getThis()

Returns the type of builder this is to support proper flow with it being an extended class.

Specified by:

getThis in class com.amplifyframework.auth.options.AuthResetPasswordOptions.Builder<AWSCognitoAuthResetPasswordOptions.CognitoBuilder>

Returns:

the type of builder this is to support proper flow with it being an extended class.

metadata

@NonNull
public AWSCognitoAuthResetPasswordOptions.CognitoBuilder metadata(@NonNull
                                                                           java.util.Map<java.lang.String,java.lang.String> metadata)

Set the metadata field for the object being built.

Parameters:

metadata - Custom user metadata to be sent with the reset password request.

Returns:

The builder object to continue building.

build

@NonNull
public AWSCognitoAuthResetPasswordOptions build()

Construct and return the object with the values set in the builder.

Specified by:

build in class com.amplifyframework.auth.options.AuthResetPasswordOptions.Builder<AWSCognitoAuthResetPasswordOptions.CognitoBuilder>

Returns:

a new instance of AWSCognitoAuthResetPasswordOptions with the values specified in the builder.