software.amazon.awssdk.services.cognitoidentityprovider.model

Interface RespondToAuthChallengeResponse.Builder

All Superinterfaces:

CognitoIdentityProviderResponse.Builder, CopyableBuilder<RespondToAuthChallengeResponse.Builder,RespondToAuthChallengeResponse>, SdkBuilder<RespondToAuthChallengeResponse.Builder,RespondToAuthChallengeResponse>

Enclosing class:

RespondToAuthChallengeResponse

public static interface RespondToAuthChallengeResponse.Builder
extends CognitoIdentityProviderResponse.Builder, CopyableBuilder<RespondToAuthChallengeResponse.Builder,RespondToAuthChallengeResponse>

Method Summary

Modifier and Type	Method and Description
RespondToAuthChallengeResponse.Builder	authenticationResult(AuthenticationResultType authenticationResult) The result returned by the server in response to the request to respond to the authentication challenge.
default RespondToAuthChallengeResponse.Builder	authenticationResult(Consumer<AuthenticationResultType.Builder> authenticationResult) The result returned by the server in response to the request to respond to the authentication challenge.
RespondToAuthChallengeResponse.Builder	challengeName(ChallengeNameType challengeName) The challenge name.
RespondToAuthChallengeResponse.Builder	challengeName(String challengeName) The challenge name.
RespondToAuthChallengeResponse.Builder	challengeParameters(Map<String,String> challengeParameters) The challenge parameters.
RespondToAuthChallengeResponse.Builder	session(String session) The session which should be passed both ways in challenge-response calls to the service.

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

build

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

sdkHttpResponse, sdkHttpResponse

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

copy

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

apply, build

Method Detail

challengeName

RespondToAuthChallengeResponse.Builder challengeName(String challengeName)

The challenge name. For more information, see InitiateAuth.

Parameters:

challengeName - The challenge name. For more information, see InitiateAuth.

Returns:

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

See Also:

ChallengeNameType, ChallengeNameType

challengeName

RespondToAuthChallengeResponse.Builder challengeName(ChallengeNameType challengeName)

The challenge name. For more information, see InitiateAuth.

Parameters:

challengeName - The challenge name. For more information, see InitiateAuth.

Returns:

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

See Also:

ChallengeNameType, ChallengeNameType

session

RespondToAuthChallengeResponse.Builder session(String session)

The session which should be passed both ways in challenge-response calls to the service. If the InitiateAuth or RespondToAuthChallenge API call determines that the caller needs to go through another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge API call.

Parameters:

session - The session which should be passed both ways in challenge-response calls to the service. If the InitiateAuth or RespondToAuthChallenge API call determines that the caller needs to go through another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge API call.

Returns:

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

challengeParameters

RespondToAuthChallengeResponse.Builder challengeParameters(Map<String,String> challengeParameters)

The challenge parameters. For more information, see InitiateAuth.

Parameters:

challengeParameters - The challenge parameters. For more information, see InitiateAuth.

Returns:

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

authenticationResult

RespondToAuthChallengeResponse.Builder authenticationResult(AuthenticationResultType authenticationResult)

The result returned by the server in response to the request to respond to the authentication challenge.

Parameters:

authenticationResult - The result returned by the server in response to the request to respond to the authentication challenge.

Returns:

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

authenticationResult

default RespondToAuthChallengeResponse.Builder authenticationResult(Consumer<AuthenticationResultType.Builder> authenticationResult)

The result returned by the server in response to the request to respond to the authentication challenge.

This is a convenience that creates an instance of the AuthenticationResultType.Builder avoiding the need to create one manually via AuthenticationResultType.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to authenticationResult(AuthenticationResultType).

Parameters:

authenticationResult - a consumer that will call methods on AuthenticationResultType.Builder

Returns:

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

See Also:

authenticationResult(AuthenticationResultType)