RespondToAuthChallengeRequest (AWS SDK for Android - Amazon Cognito Identity Provider 2.6.15 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.cognitoidentityprovider.model.RespondToAuthChallengeRequest

All Implemented Interfaces:

Serializable, Cloneable
```
public class RespondToAuthChallengeRequest
extends AmazonWebServiceRequest
implements Serializable
```
Responds to the authentication challenge.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

RespondToAuthChallengeRequest()

Constructors
Constructor and Description
`RespondToAuthChallengeRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RespondToAuthChallengeRequest`	`addChallengeResponsesEntry(String key, String value)` The responses to the authentication challenge.
`RespondToAuthChallengeRequest`	`clearChallengeResponsesEntries()` Removes all the entries added into ChallengeResponses.
`boolean`	`equals(Object obj)`
`AnalyticsMetadataType`	`getAnalyticsMetadata()` The pinpoint installation id.
`String`	`getChallengeName()` The name of the challenge.
`Map<String,String>`	`getChallengeResponses()` The responses to the authentication challenge.
`String`	`getClientId()` The client ID.
`String`	`getSession()` The session.
`UserContextDataType`	`getUserContextData()` Base64 encoded string for user context data collected for risk evaluation
`int`	`hashCode()`
`void`	`setAnalyticsMetadata(AnalyticsMetadataType analyticsMetadata)` The pinpoint installation id.
`void`	`setChallengeName(ChallengeNameType challengeName)` The name of the challenge.
`void`	`setChallengeName(String challengeName)` The name of the challenge.
`void`	`setChallengeResponses(Map<String,String> challengeResponses)` The responses to the authentication challenge.
`void`	`setClientId(String clientId)` The client ID.
`void`	`setSession(String session)` The session.
`void`	`setUserContextData(UserContextDataType userContextData)` Base64 encoded string for user context data collected for risk evaluation
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`RespondToAuthChallengeRequest`	`withAnalyticsMetadata(AnalyticsMetadataType analyticsMetadata)` The pinpoint installation id.
`RespondToAuthChallengeRequest`	`withChallengeName(ChallengeNameType challengeName)` The name of the challenge.
`RespondToAuthChallengeRequest`	`withChallengeName(String challengeName)` The name of the challenge.
`RespondToAuthChallengeRequest`	`withChallengeResponses(Map<String,String> challengeResponses)` The responses to the authentication challenge.
`RespondToAuthChallengeRequest`	`withClientId(String clientId)` The client ID.
`RespondToAuthChallengeRequest`	`withSession(String session)` The session.
`RespondToAuthChallengeRequest`	`withUserContextData(UserContextDataType userContextData)` Base64 encoded string for user context data collected for risk evaluation

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

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

- Constructor Detail
  - RespondToAuthChallengeRequest
```
public RespondToAuthChallengeRequest()
```
- Method Detail
  - getClientId
```
public String getClientId()
```
    The client ID.
    
    Constraints:
    Length: 1 - 128
    Pattern: [\w+]+
    
    Returns:
    
    The client ID.
  - setClientId
```
public void setClientId(String clientId)
```
    The client ID.
    
    Constraints:
    Length: 1 - 128
    Pattern: [\w+]+
    
    Parameters:
    
    clientId -
    The client ID.
  - withClientId
```
public RespondToAuthChallengeRequest withClientId(String clientId)
```
    The client ID.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 128
    Pattern: [\w+]+
    
    Parameters:
    
    clientId -
    The client ID.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getChallengeName
```
public String getChallengeName()
```
    The name of the challenge.
    
    Constraints:
    Allowed Values: SMS_MFA, PASSWORD_VERIFIER, CUSTOM_CHALLENGE, DEVICE_SRP_AUTH, DEVICE_PASSWORD_VERIFIER, ADMIN_NO_SRP_AUTH, NEW_PASSWORD_REQUIRED
    
    Returns:
    
    The name of the challenge.
    
    See Also:
    
    ChallengeNameType
  - setChallengeName
```
public void setChallengeName(String challengeName)
```
    The name of the challenge.
    
    Constraints:
    Allowed Values: SMS_MFA, PASSWORD_VERIFIER, CUSTOM_CHALLENGE, DEVICE_SRP_AUTH, DEVICE_PASSWORD_VERIFIER, ADMIN_NO_SRP_AUTH, NEW_PASSWORD_REQUIRED
    
    Parameters:
    
    challengeName -
    The name of the challenge.
    
    See Also:
    
    ChallengeNameType
  - withChallengeName
```
public RespondToAuthChallengeRequest withChallengeName(String challengeName)
```
    The name of the challenge.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: SMS_MFA, PASSWORD_VERIFIER, CUSTOM_CHALLENGE, DEVICE_SRP_AUTH, DEVICE_PASSWORD_VERIFIER, ADMIN_NO_SRP_AUTH, NEW_PASSWORD_REQUIRED
    
    Parameters:
    
    challengeName -
    The name of the challenge.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    ChallengeNameType
  - setChallengeName
```
public void setChallengeName(ChallengeNameType challengeName)
```
    The name of the challenge.
    
    Constraints:
    Allowed Values: SMS_MFA, PASSWORD_VERIFIER, CUSTOM_CHALLENGE, DEVICE_SRP_AUTH, DEVICE_PASSWORD_VERIFIER, ADMIN_NO_SRP_AUTH, NEW_PASSWORD_REQUIRED
    
    Parameters:
    
    challengeName -
    The name of the challenge.
    
    See Also:
    
    ChallengeNameType
  - withChallengeName
```
public RespondToAuthChallengeRequest withChallengeName(ChallengeNameType challengeName)
```
    The name of the challenge.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: SMS_MFA, PASSWORD_VERIFIER, CUSTOM_CHALLENGE, DEVICE_SRP_AUTH, DEVICE_PASSWORD_VERIFIER, ADMIN_NO_SRP_AUTH, NEW_PASSWORD_REQUIRED
    
    Parameters:
    
    challengeName -
    The name of the challenge.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    ChallengeNameType
  - getSession
```
public String getSession()
```
    The session.
    
    Constraints:
    Length: 20 - 2048
    
    Returns:
    
    The session.
  - setSession
```
public void setSession(String session)
```
    The session.
    
    Constraints:
    Length: 20 - 2048
    
    Parameters:
    
    session -
    The session.
  - withSession
```
public RespondToAuthChallengeRequest withSession(String session)
```
    The session.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 20 - 2048
    
    Parameters:
    
    session -
    The session.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getChallengeResponses
```
public Map<String,String> getChallengeResponses()
```
    The responses to the authentication challenge.
    
    Returns:
    
    The responses to the authentication challenge.
  - setChallengeResponses
```
public void setChallengeResponses(Map<String,String> challengeResponses)
```
    The responses to the authentication challenge.
    
    Parameters:
    
    challengeResponses -
    The responses to the authentication challenge.
  - withChallengeResponses
```
public RespondToAuthChallengeRequest withChallengeResponses(Map<String,String> challengeResponses)
```
    The responses to the authentication challenge.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    challengeResponses -
    The responses to the authentication challenge.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - addChallengeResponsesEntry
```
public RespondToAuthChallengeRequest addChallengeResponsesEntry(String key,
                                                                String value)
```
    The responses to the authentication challenge.
    
    The method adds a new key-value pair into ChallengeResponses parameter, and returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    key - The key of the entry to be added into ChallengeResponses.
    
    value - The corresponding value of the entry to be added into ChallengeResponses.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - clearChallengeResponsesEntries
```
public RespondToAuthChallengeRequest clearChallengeResponsesEntries()
```
    Removes all the entries added into ChallengeResponses.
    Returns a reference to this object so that method calls can be chained together.
  - getUserContextData
```
public UserContextDataType getUserContextData()
```
    Base64 encoded string for user context data collected for risk evaluation
    
    Returns:
    
    Base64 encoded string for user context data collected for risk evaluation
  - setUserContextData
```
public void setUserContextData(UserContextDataType userContextData)
```
    Base64 encoded string for user context data collected for risk evaluation
    
    Parameters:
    
    userContextData -
    Base64 encoded string for user context data collected for risk evaluation
  - withUserContextData
```
public RespondToAuthChallengeRequest withUserContextData(UserContextDataType userContextData)
```
    Base64 encoded string for user context data collected for risk evaluation
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    userContextData -
    Base64 encoded string for user context data collected for risk evaluation
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getAnalyticsMetadata
```
public AnalyticsMetadataType getAnalyticsMetadata()
```
    The pinpoint installation id.
    
    Returns:
    
    The pinpoint installation id.
  - setAnalyticsMetadata
```
public void setAnalyticsMetadata(AnalyticsMetadataType analyticsMetadata)
```
    The pinpoint installation id.
    
    Parameters:
    
    analyticsMetadata -
    The pinpoint installation id.
  - withAnalyticsMetadata
```
public RespondToAuthChallengeRequest withAnalyticsMetadata(AnalyticsMetadataType analyticsMetadata)
```
    The pinpoint installation id.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    analyticsMetadata -
    The pinpoint installation id.
    
    Returns:
    
    A reference to this updated 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()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Class RespondToAuthChallengeRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

RespondToAuthChallengeRequest

Method Detail

getClientId

setClientId

withClientId

getChallengeName

setChallengeName

withChallengeName

setChallengeName

withChallengeName

getSession

setSession

withSession

getChallengeResponses

setChallengeResponses

withChallengeResponses

addChallengeResponsesEntry

clearChallengeResponsesEntries

getUserContextData

setUserContextData

withUserContextData

getAnalyticsMetadata

setAnalyticsMetadata

withAnalyticsMetadata

toString

hashCode

equals