software.amazon.awssdk.services.cognitoidentityprovider.model

Interface GetUserResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CognitoIdentityProviderResponse.Builder, CopyableBuilder<GetUserResponse.Builder,GetUserResponse>, SdkBuilder<GetUserResponse.Builder,GetUserResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

GetUserResponse

public static interface GetUserResponse.Builder
extends CognitoIdentityProviderResponse.Builder, SdkPojo, CopyableBuilder<GetUserResponse.Builder,GetUserResponse>

Method Summary

Modifier and Type	Method and Description
GetUserResponse.Builder	mfaOptions(Collection<MFAOptionType> mfaOptions) This response parameter is no longer supported. It provides information only about SMS MFA configurations.
GetUserResponse.Builder	mfaOptions(Consumer<MFAOptionType.Builder>... mfaOptions) This response parameter is no longer supported. It provides information only about SMS MFA configurations.
GetUserResponse.Builder	mfaOptions(MFAOptionType... mfaOptions) This response parameter is no longer supported. It provides information only about SMS MFA configurations.
GetUserResponse.Builder	preferredMfaSetting(String preferredMfaSetting) The user's preferred MFA setting.
GetUserResponse.Builder	userAttributes(AttributeType... userAttributes) An array of name-value pairs representing user attributes.
GetUserResponse.Builder	userAttributes(Collection<AttributeType> userAttributes) An array of name-value pairs representing user attributes.
GetUserResponse.Builder	userAttributes(Consumer<AttributeType.Builder>... userAttributes) An array of name-value pairs representing user attributes.
GetUserResponse.Builder	userMFASettingList(Collection<String> userMFASettingList) The MFA options that are activated for the user.
GetUserResponse.Builder	userMFASettingList(String... userMFASettingList) The MFA options that are activated for the user.
GetUserResponse.Builder	username(String username) The user name of the user you want to retrieve from the get user request.

Methods inherited from interface software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderResponse.Builder

build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

username

GetUserResponse.Builder username(String username)

The user name of the user you want to retrieve from the get user request.

Parameters:

username - The user name of the user you want to retrieve from the get user request.

Returns:

Returns a reference to this object so that method calls can be chained together.

userAttributes

GetUserResponse.Builder userAttributes(Collection<AttributeType> userAttributes)

An array of name-value pairs representing user attributes.

For custom attributes, you must prepend the custom: prefix to the attribute name.

Parameters:

userAttributes - An array of name-value pairs representing user attributes.

For custom attributes, you must prepend the custom: prefix to the attribute name.

Returns:

Returns a reference to this object so that method calls can be chained together.

userAttributes

GetUserResponse.Builder userAttributes(AttributeType... userAttributes)

An array of name-value pairs representing user attributes.

For custom attributes, you must prepend the custom: prefix to the attribute name.

Parameters:

userAttributes - An array of name-value pairs representing user attributes.

For custom attributes, you must prepend the custom: prefix to the attribute name.

Returns:

Returns a reference to this object so that method calls can be chained together.

userAttributes

GetUserResponse.Builder userAttributes(Consumer<AttributeType.Builder>... userAttributes)

An array of name-value pairs representing user attributes.

For custom attributes, you must prepend the custom: prefix to the attribute name.

This is a convenience method that creates an instance of the AttributeType.Builder avoiding the need to create one manually via AttributeType.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #userAttributes(List).

Parameters:

userAttributes - a consumer that will call methods on AttributeType.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#userAttributes(java.util.Collection)

mfaOptions

GetUserResponse.Builder mfaOptions(Collection<MFAOptionType> mfaOptions)

This response parameter is no longer supported. It provides information only about SMS MFA configurations. It doesn't provide information about time-based one-time password (TOTP) software token MFA configurations. To look up information about either type of MFA configuration, use UserMFASettingList instead.

Parameters:

mfaOptions - This response parameter is no longer supported. It provides information only about SMS MFA configurations. It doesn't provide information about time-based one-time password (TOTP) software token MFA configurations. To look up information about either type of MFA configuration, use UserMFASettingList instead.

Returns:

Returns a reference to this object so that method calls can be chained together.

mfaOptions

GetUserResponse.Builder mfaOptions(MFAOptionType... mfaOptions)

This response parameter is no longer supported. It provides information only about SMS MFA configurations. It doesn't provide information about time-based one-time password (TOTP) software token MFA configurations. To look up information about either type of MFA configuration, use UserMFASettingList instead.

Parameters:

mfaOptions - This response parameter is no longer supported. It provides information only about SMS MFA configurations. It doesn't provide information about time-based one-time password (TOTP) software token MFA configurations. To look up information about either type of MFA configuration, use UserMFASettingList instead.

Returns:

Returns a reference to this object so that method calls can be chained together.

mfaOptions

GetUserResponse.Builder mfaOptions(Consumer<MFAOptionType.Builder>... mfaOptions)

This response parameter is no longer supported. It provides information only about SMS MFA configurations. It doesn't provide information about time-based one-time password (TOTP) software token MFA configurations. To look up information about either type of MFA configuration, use UserMFASettingList instead.

This is a convenience method that creates an instance of the MFAOptionType.Builder avoiding the need to create one manually via MFAOptionType.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #mfaOptions(List).

Parameters:

mfaOptions - a consumer that will call methods on MFAOptionType.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#mfaOptions(java.util.Collection)

preferredMfaSetting

GetUserResponse.Builder preferredMfaSetting(String preferredMfaSetting)

The user's preferred MFA setting.

Parameters:

preferredMfaSetting - The user's preferred MFA setting.

Returns:

Returns a reference to this object so that method calls can be chained together.

userMFASettingList

GetUserResponse.Builder userMFASettingList(Collection<String> userMFASettingList)

The MFA options that are activated for the user. The possible values in this list are SMS_MFA and SOFTWARE_TOKEN_MFA.

Parameters:

userMFASettingList - The MFA options that are activated for the user. The possible values in this list are SMS_MFA and SOFTWARE_TOKEN_MFA.

Returns:

Returns a reference to this object so that method calls can be chained together.

userMFASettingList

GetUserResponse.Builder userMFASettingList(String... userMFASettingList)

The MFA options that are activated for the user. The possible values in this list are SMS_MFA and SOFTWARE_TOKEN_MFA.

Parameters:

userMFASettingList - The MFA options that are activated for the user. The possible values in this list are SMS_MFA and SOFTWARE_TOKEN_MFA.

Returns:

Returns a reference to this object so that method calls can be chained together.