RespondToAuthChallengeResult (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<ResponseMetadata>
- - com.amazonaws.services.cognitoidp.model.RespondToAuthChallengeResult

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class RespondToAuthChallengeResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

The response to respond to the authentication challenge.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

RespondToAuthChallengeResult()

Constructors
Constructor and Description
`RespondToAuthChallengeResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RespondToAuthChallengeResult`	`addChallengeParametersEntry(String key, String value)` Add a single ChallengeParameters entry
`RespondToAuthChallengeResult`	`clearChallengeParametersEntries()` Removes all the entries added into ChallengeParameters.
`RespondToAuthChallengeResult`	`clone()`
`boolean`	`equals(Object obj)`
`AuthenticationResultType`	`getAuthenticationResult()` The result returned by the server in response to the request to respond to the authentication challenge.
`String`	`getChallengeName()` The challenge name.
`Map<String,String>`	`getChallengeParameters()` The challenge parameters.
`String`	`getSession()` The session that should be passed both ways in challenge-response calls to the service.
`int`	`hashCode()`
`void`	`setAuthenticationResult(AuthenticationResultType authenticationResult)` The result returned by the server in response to the request to respond to the authentication challenge.
`void`	`setChallengeName(ChallengeNameType challengeName)` The challenge name.
`void`	`setChallengeName(String challengeName)` The challenge name.
`void`	`setChallengeParameters(Map<String,String> challengeParameters)` The challenge parameters.
`void`	`setSession(String session)` The session that should be passed both ways in challenge-response calls to the service.
`String`	`toString()` Returns a string representation of this object.
`RespondToAuthChallengeResult`	`withAuthenticationResult(AuthenticationResultType authenticationResult)` The result returned by the server in response to the request to respond to the authentication challenge.
`RespondToAuthChallengeResult`	`withChallengeName(ChallengeNameType challengeName)` The challenge name.
`RespondToAuthChallengeResult`	`withChallengeName(String challengeName)` The challenge name.
`RespondToAuthChallengeResult`	`withChallengeParameters(Map<String,String> challengeParameters)` The challenge parameters.
`RespondToAuthChallengeResult`	`withSession(String session)` The session that should be passed both ways in challenge-response calls to the service.

Methods inherited from class com.amazonaws.AmazonWebServiceResult
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - RespondToAuthChallengeResult
```
public RespondToAuthChallengeResult()
```
- Method Detail
  - setChallengeName
```
public void setChallengeName(String challengeName)
```
    The challenge name. For more information, see InitiateAuth.
    
    Parameters:
    
    challengeName - The challenge name. For more information, see InitiateAuth.
    
    See Also:
    
    ChallengeNameType
  - getChallengeName
```
public String getChallengeName()
```
    The challenge name. For more information, see InitiateAuth.
    
    Returns:
    
    The challenge name. For more information, see InitiateAuth.
    
    See Also:
    
    ChallengeNameType
  - withChallengeName
```
public RespondToAuthChallengeResult withChallengeName(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
  - setChallengeName
```
public void setChallengeName(ChallengeNameType challengeName)
```
    The challenge name. For more information, see InitiateAuth.
    
    Parameters:
    
    challengeName - The challenge name. For more information, see InitiateAuth.
    
    See Also:
    
    ChallengeNameType
  - withChallengeName
```
public RespondToAuthChallengeResult withChallengeName(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
  - setSession
```
public void setSession(String 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 next RespondToAuthChallenge API call.
  - getSession
```
public String getSession()
```
    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.
    
    Returns:
    
    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.
  - withSession
```
public RespondToAuthChallengeResult withSession(String 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 next RespondToAuthChallenge API call.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getChallengeParameters
```
public Map<String,String> getChallengeParameters()
```
    The challenge parameters. For more information, see InitiateAuth.
    
    Returns:
    
    The challenge parameters. For more information, see InitiateAuth.
  - setChallengeParameters
```
public void setChallengeParameters(Map<String,String> challengeParameters)
```
    The challenge parameters. For more information, see InitiateAuth.
    
    Parameters:
    
    challengeParameters - The challenge parameters. For more information, see InitiateAuth.
  - withChallengeParameters
```
public RespondToAuthChallengeResult withChallengeParameters(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.
  - addChallengeParametersEntry
```
public RespondToAuthChallengeResult addChallengeParametersEntry(String key,
                                                                String value)
```
    Add a single ChallengeParameters entry
    
    See Also:
    
    withChallengeParameters(java.util.Map<java.lang.String, java.lang.String>)
  - clearChallengeParametersEntries
```
public RespondToAuthChallengeResult clearChallengeParametersEntries()
```
    Removes all the entries added into ChallengeParameters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAuthenticationResult
```
public void setAuthenticationResult(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.
  - getAuthenticationResult
```
public AuthenticationResultType getAuthenticationResult()
```
    The result returned by the server in response to the request to respond to the authentication challenge.
    
    Returns:
    
    The result returned by the server in response to the request to respond to the authentication challenge.
  - withAuthenticationResult
```
public RespondToAuthChallengeResult withAuthenticationResult(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.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public RespondToAuthChallengeResult clone()
```
    Overrides:
    
    clone in class Object

AWS SDK for Java 1.x API Reference - 1.12.780

Class RespondToAuthChallengeResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

RespondToAuthChallengeResult

Method Detail

setChallengeName

getChallengeName

withChallengeName

setChallengeName

withChallengeName

setSession

getSession

withSession

getChallengeParameters

setChallengeParameters

withChallengeParameters

addChallengeParametersEntry

clearChallengeParametersEntries

setAuthenticationResult

getAuthenticationResult

withAuthenticationResult

toString

equals

hashCode

clone