InitiateAuthResult (AWS SDK for Java

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

All Implemented Interfaces:: Serializable, Cloneable

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

Initiates the authentication response.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

InitiateAuthResult()

Constructors
Constructor and Description
`InitiateAuthResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`InitiateAuthResult`	`addChallengeParametersEntry(String key, String value)`
`InitiateAuthResult`	`clearChallengeParametersEntries()` Removes all the entries added into ChallengeParameters.
`InitiateAuthResult`	`clone()`
`boolean`	`equals(Object obj)`
`AuthenticationResultType`	`getAuthenticationResult()` The result returned by the server in response to the request to initiate authentication.
`String`	`getChallengeName()` The name of the challenge.
`Map<String,String>`	`getChallengeParameters()` The challenge parameters.
`String`	`getSession()` The session.
`int`	`hashCode()`
`void`	`setAuthenticationResult(AuthenticationResultType authenticationResult)` The result returned by the server in response to the request to initiate authentication.
`void`	`setChallengeName(ChallengeNameType challengeName)` The name of the challenge.
`void`	`setChallengeName(String challengeName)` The name of the challenge.
`void`	`setChallengeParameters(Map<String,String> challengeParameters)` The challenge parameters.
`void`	`setSession(String session)` The session.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`InitiateAuthResult`	`withAuthenticationResult(AuthenticationResultType authenticationResult)` The result returned by the server in response to the request to initiate authentication.
`InitiateAuthResult`	`withChallengeName(ChallengeNameType challengeName)` The name of the challenge.
`InitiateAuthResult`	`withChallengeName(String challengeName)` The name of the challenge.
`InitiateAuthResult`	`withChallengeParameters(Map<String,String> challengeParameters)` The challenge parameters.
`InitiateAuthResult`	`withSession(String session)` The session.

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
  - InitiateAuthResult
```
public InitiateAuthResult()
```
- Method Detail
  - setChallengeName
```
public void setChallengeName(String challengeName)
```
    The name of the challenge.
    
    Parameters:
    
    challengeName - The name of the challenge.
    
    See Also:
    
    ChallengeNameType
  - getChallengeName
```
public String getChallengeName()
```
    The name of the challenge.
    
    Returns:
    
    The name of the challenge.
    
    See Also:
    
    ChallengeNameType
  - withChallengeName
```
public InitiateAuthResult withChallengeName(String challengeName)
```
    The name of the challenge.
    
    Parameters:
    
    challengeName - The name of the challenge.
    
    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 name of the challenge.
    
    Parameters:
    
    challengeName - The name of the challenge.
    
    See Also:
    
    ChallengeNameType
  - withChallengeName
```
public InitiateAuthResult withChallengeName(ChallengeNameType challengeName)
```
    The name of the challenge.
    
    Parameters:
    
    challengeName - The name of the challenge.
    
    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.
    
    Parameters:
    
    session - The session.
  - getSession
```
public String getSession()
```
    The session.
    
    Returns:
    
    The session.
  - withSession
```
public InitiateAuthResult withSession(String session)
```
    The session.
    
    Parameters:
    
    session - The session.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getChallengeParameters
```
public Map<String,String> getChallengeParameters()
```
    The challenge parameters.
    
    Returns:
    
    The challenge parameters.
  - setChallengeParameters
```
public void setChallengeParameters(Map<String,String> challengeParameters)
```
    The challenge parameters.
    
    Parameters:
    
    challengeParameters - The challenge parameters.
  - withChallengeParameters
```
public InitiateAuthResult withChallengeParameters(Map<String,String> challengeParameters)
```
    The challenge parameters.
    
    Parameters:
    
    challengeParameters - The challenge parameters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addChallengeParametersEntry
```
public InitiateAuthResult addChallengeParametersEntry(String key,
                                                      String value)
```
  - clearChallengeParametersEntries
```
public InitiateAuthResult 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 initiate authentication.
    
    Parameters:
    
    authenticationResult - The result returned by the server in response to the request to initiate authentication.
  - getAuthenticationResult
```
public AuthenticationResultType getAuthenticationResult()
```
    The result returned by the server in response to the request to initiate authentication.
    
    Returns:
    
    The result returned by the server in response to the request to initiate authentication.
  - withAuthenticationResult
```
public InitiateAuthResult withAuthenticationResult(AuthenticationResultType authenticationResult)
```
    The result returned by the server in response to the request to initiate authentication.
    
    Parameters:
    
    authenticationResult - The result returned by the server in response to the request to initiate authentication.
    
    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; useful for testing and debugging.
    
    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 InitiateAuthResult clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class InitiateAuthResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

InitiateAuthResult

Method Detail

setChallengeName

getChallengeName

withChallengeName

setChallengeName

withChallengeName

setSession

getSession

withSession

getChallengeParameters

setChallengeParameters

withChallengeParameters

addChallengeParametersEntry

clearChallengeParametersEntries

setAuthenticationResult

getAuthenticationResult

withAuthenticationResult

toString

equals

hashCode

clone