Interface RespondToAuthChallengeResponse.Builder
- All Superinterfaces:
AwsResponse.Builder
,Buildable
,CognitoIdentityProviderResponse.Builder
,CopyableBuilder<RespondToAuthChallengeResponse.Builder,
,RespondToAuthChallengeResponse> SdkBuilder<RespondToAuthChallengeResponse.Builder,
,RespondToAuthChallengeResponse> SdkPojo
,SdkResponse.Builder
- Enclosing class:
RespondToAuthChallengeResponse
-
Method Summary
Modifier and TypeMethodDescriptionauthenticationResult
(Consumer<AuthenticationResultType.Builder> authenticationResult) The result returned by the server in response to the request to respond to the authentication challenge.authenticationResult
(AuthenticationResultType authenticationResult) The result returned by the server in response to the request to respond to the authentication challenge.challengeName
(String challengeName) The challenge name.challengeName
(ChallengeNameType challengeName) The challenge name.challengeParameters
(Map<String, String> challengeParameters) The challenge parameters.The session that 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, responseMetadata, responseMetadata
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponse
-
Method Details
-
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:
-
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:
-
session
The session that should be passed both ways in challenge-response calls to the service. If the caller must pass 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 that should be passed both ways in challenge-response calls to the service. If the caller must pass another challenge, they return a session with other challenge parameters. This session should be passed as it is to the nextRespondToAuthChallenge
API call.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 method that creates an instance of theAuthenticationResultType.Builder
avoiding the need to create one manually viaAuthenticationResultType.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toauthenticationResult(AuthenticationResultType)
.- Parameters:
authenticationResult
- a consumer that will call methods onAuthenticationResultType.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-