AdminRespondToAuthChallengeRequest (AWS SDK for Android - Amazon Cognito Identity Provider 2.4.4 API)

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

All Implemented Interfaces:

Serializable, Cloneable
```
public class AdminRespondToAuthChallengeRequest
extends AmazonWebServiceRequest
implements Serializable
```
Responds to an authentication challenge, as an administrator.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

AdminRespondToAuthChallengeRequest()

Constructors
Constructor and Description
`AdminRespondToAuthChallengeRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AdminRespondToAuthChallengeRequest`	`addChallengeResponsesEntry(String key, String value)` The challenge response.
`AdminRespondToAuthChallengeRequest`	`clearChallengeResponsesEntries()` Removes all the entries added into ChallengeResponses.
`boolean`	`equals(Object obj)`
`String`	`getChallengeName()` The name of the challenge.
`Map<String,String>`	`getChallengeResponses()` The challenge response.
`String`	`getClientId()` The client ID.
`String`	`getSession()` The session.
`String`	`getUserPoolId()` The ID of the Amazon Cognito user pool.
`int`	`hashCode()`
`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 challenge response.
`void`	`setClientId(String clientId)` The client ID.
`void`	`setSession(String session)` The session.
`void`	`setUserPoolId(String userPoolId)` The ID of the Amazon Cognito user pool.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`AdminRespondToAuthChallengeRequest`	`withChallengeName(ChallengeNameType challengeName)` The name of the challenge.
`AdminRespondToAuthChallengeRequest`	`withChallengeName(String challengeName)` The name of the challenge.
`AdminRespondToAuthChallengeRequest`	`withChallengeResponses(Map<String,String> challengeResponses)` The challenge response.
`AdminRespondToAuthChallengeRequest`	`withClientId(String clientId)` The client ID.
`AdminRespondToAuthChallengeRequest`	`withSession(String session)` The session.
`AdminRespondToAuthChallengeRequest`	`withUserPoolId(String userPoolId)` The ID of the Amazon Cognito user pool.

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
  - AdminRespondToAuthChallengeRequest
```
public AdminRespondToAuthChallengeRequest()
```
- Method Detail
  - getUserPoolId
```
public String getUserPoolId()
```
    The ID of the Amazon Cognito user pool.
    
    Constraints:
    Length: 1 - 55
    Pattern: [\w-]+_[0-9a-zA-Z]+
    
    Returns:
    
    The ID of the Amazon Cognito user pool.
  - setUserPoolId
```
public void setUserPoolId(String userPoolId)
```
    The ID of the Amazon Cognito user pool.
    
    Constraints:
    Length: 1 - 55
    Pattern: [\w-]+_[0-9a-zA-Z]+
    
    Parameters:
    
    userPoolId -
    The ID of the Amazon Cognito user pool.
  - withUserPoolId
```
public AdminRespondToAuthChallengeRequest withUserPoolId(String userPoolId)
```
    The ID of the Amazon Cognito user pool.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 55
    Pattern: [\w-]+_[0-9a-zA-Z]+
    
    Parameters:
    
    userPoolId -
    The ID of the Amazon Cognito user pool.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - 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 AdminRespondToAuthChallengeRequest 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 AdminRespondToAuthChallengeRequest 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 AdminRespondToAuthChallengeRequest 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
  - getChallengeResponses
```
public Map<String,String> getChallengeResponses()
```
    The challenge response.
    
    Returns:
    
    The challenge response.
  - setChallengeResponses
```
public void setChallengeResponses(Map<String,String> challengeResponses)
```
    The challenge response.
    
    Parameters:
    
    challengeResponses -
    The challenge response.
  - withChallengeResponses
```
public AdminRespondToAuthChallengeRequest withChallengeResponses(Map<String,String> challengeResponses)
```
    The challenge response.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    challengeResponses -
    The challenge response.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - addChallengeResponsesEntry
```
public AdminRespondToAuthChallengeRequest addChallengeResponsesEntry(String key,
                                                                     String value)
```
    The challenge response.
    
    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 AdminRespondToAuthChallengeRequest clearChallengeResponsesEntries()
```
    Removes all the entries added into ChallengeResponses.
    Returns a reference to this object so that method calls can be chained together.
  - 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 AdminRespondToAuthChallengeRequest 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.
  - 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 AdminRespondToAuthChallengeRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

AdminRespondToAuthChallengeRequest

Method Detail

getUserPoolId

setUserPoolId

withUserPoolId

getClientId

setClientId

withClientId

getChallengeName

setChallengeName

withChallengeName

setChallengeName

withChallengeName

getChallengeResponses

setChallengeResponses

withChallengeResponses

addChallengeResponsesEntry

clearChallengeResponsesEntries

getSession

setSession

withSession

toString

hashCode

equals