com.amplifyframework.auth.cognito.options

Class AWSCognitoAuthUpdateUserAttributesOptions.CognitoBuilder

java.lang.Object

com.amplifyframework.auth.options.AuthUpdateUserAttributesOptions.Builder<AWSCognitoAuthUpdateUserAttributesOptions.CognitoBuilder>

com.amplifyframework.auth.cognito.options.AWSCognitoAuthUpdateUserAttributesOptions.CognitoBuilder

Enclosing class:

AWSCognitoAuthUpdateUserAttributesOptions

public static final class AWSCognitoAuthUpdateUserAttributesOptions.CognitoBuilder
extends com.amplifyframework.auth.options.AuthUpdateUserAttributesOptions.Builder<AWSCognitoAuthUpdateUserAttributesOptions.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
AWSCognitoAuthUpdateUserAttributesOptions	build() Construct and return the object with the values set in the builder.
AWSCognitoAuthUpdateUserAttributesOptions.CognitoBuilder	getThis() Returns the type of builder this is to support proper flow with it being an extended class.
AWSCognitoAuthUpdateUserAttributesOptions.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 AWSCognitoAuthUpdateUserAttributesOptions.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.AuthUpdateUserAttributesOptions.Builder<AWSCognitoAuthUpdateUserAttributesOptions.CognitoBuilder>

Returns:

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

metadata

@NonNull
public AWSCognitoAuthUpdateUserAttributesOptions.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 update user attributes request.

Returns:

The builder object to continue building.

build

@NonNull
public AWSCognitoAuthUpdateUserAttributesOptions build()

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

Specified by:

build in class com.amplifyframework.auth.options.AuthUpdateUserAttributesOptions.Builder<AWSCognitoAuthUpdateUserAttributesOptions.CognitoBuilder>

Returns:

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