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

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

All Implemented Interfaces:

Serializable, Cloneable
```
public class AdminInitiateAuthRequest
extends AmazonWebServiceRequest
implements Serializable
```
Initiates the authentication flow, as an administrator.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

AdminInitiateAuthRequest()

Constructors
Constructor and Description
`AdminInitiateAuthRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AdminInitiateAuthRequest`	`addAuthParametersEntry(String key, String value)` The authentication parameters.
`AdminInitiateAuthRequest`	`addClientMetadataEntry(String key, String value)` The client app metadata.
`AdminInitiateAuthRequest`	`clearAuthParametersEntries()` Removes all the entries added into AuthParameters.
`AdminInitiateAuthRequest`	`clearClientMetadataEntries()` Removes all the entries added into ClientMetadata.
`boolean`	`equals(Object obj)`
`String`	`getAuthFlow()` The authentication flow.
`Map<String,String>`	`getAuthParameters()` The authentication parameters.
`String`	`getClientId()` The client app ID.
`Map<String,String>`	`getClientMetadata()` The client app metadata.
`String`	`getUserPoolId()` The ID of the Amazon Cognito user pool.
`int`	`hashCode()`
`void`	`setAuthFlow(AuthFlowType authFlow)` The authentication flow.
`void`	`setAuthFlow(String authFlow)` The authentication flow.
`void`	`setAuthParameters(Map<String,String> authParameters)` The authentication parameters.
`void`	`setClientId(String clientId)` The client app ID.
`void`	`setClientMetadata(Map<String,String> clientMetadata)` The client app metadata.
`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.
`AdminInitiateAuthRequest`	`withAuthFlow(AuthFlowType authFlow)` The authentication flow.
`AdminInitiateAuthRequest`	`withAuthFlow(String authFlow)` The authentication flow.
`AdminInitiateAuthRequest`	`withAuthParameters(Map<String,String> authParameters)` The authentication parameters.
`AdminInitiateAuthRequest`	`withClientId(String clientId)` The client app ID.
`AdminInitiateAuthRequest`	`withClientMetadata(Map<String,String> clientMetadata)` The client app metadata.
`AdminInitiateAuthRequest`	`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
  - AdminInitiateAuthRequest
```
public AdminInitiateAuthRequest()
```
- 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 AdminInitiateAuthRequest 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 app ID.
    
    Constraints:
    Length: 1 - 128
    Pattern: [\w+]+
    
    Returns:
    
    The client app ID.
  - setClientId
```
public void setClientId(String clientId)
```
    The client app ID.
    
    Constraints:
    Length: 1 - 128
    Pattern: [\w+]+
    
    Parameters:
    
    clientId -
    The client app ID.
  - withClientId
```
public AdminInitiateAuthRequest withClientId(String clientId)
```
    The client app 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 app ID.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getAuthFlow
```
public String getAuthFlow()
```
    The authentication flow.
    
    Constraints:
    Allowed Values: USER_SRP_AUTH, REFRESH_TOKEN_AUTH, REFRESH_TOKEN, CUSTOM_AUTH, ADMIN_NO_SRP_AUTH
    
    Returns:
    
    The authentication flow.
    
    See Also:
    
    AuthFlowType
  - setAuthFlow
```
public void setAuthFlow(String authFlow)
```
    The authentication flow.
    
    Constraints:
    Allowed Values: USER_SRP_AUTH, REFRESH_TOKEN_AUTH, REFRESH_TOKEN, CUSTOM_AUTH, ADMIN_NO_SRP_AUTH
    
    Parameters:
    
    authFlow -
    The authentication flow.
    
    See Also:
    
    AuthFlowType
  - withAuthFlow
```
public AdminInitiateAuthRequest withAuthFlow(String authFlow)
```
    The authentication flow.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: USER_SRP_AUTH, REFRESH_TOKEN_AUTH, REFRESH_TOKEN, CUSTOM_AUTH, ADMIN_NO_SRP_AUTH
    
    Parameters:
    
    authFlow -
    The authentication flow.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    AuthFlowType
  - setAuthFlow
```
public void setAuthFlow(AuthFlowType authFlow)
```
    The authentication flow.
    
    Constraints:
    Allowed Values: USER_SRP_AUTH, REFRESH_TOKEN_AUTH, REFRESH_TOKEN, CUSTOM_AUTH, ADMIN_NO_SRP_AUTH
    
    Parameters:
    
    authFlow -
    The authentication flow.
    
    See Also:
    
    AuthFlowType
  - withAuthFlow
```
public AdminInitiateAuthRequest withAuthFlow(AuthFlowType authFlow)
```
    The authentication flow.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: USER_SRP_AUTH, REFRESH_TOKEN_AUTH, REFRESH_TOKEN, CUSTOM_AUTH, ADMIN_NO_SRP_AUTH
    
    Parameters:
    
    authFlow -
    The authentication flow.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    AuthFlowType
  - getAuthParameters
```
public Map<String,String> getAuthParameters()
```
    The authentication parameters.
    
    Returns:
    
    The authentication parameters.
  - setAuthParameters
```
public void setAuthParameters(Map<String,String> authParameters)
```
    The authentication parameters.
    
    Parameters:
    
    authParameters -
    The authentication parameters.
  - withAuthParameters
```
public AdminInitiateAuthRequest withAuthParameters(Map<String,String> authParameters)
```
    The authentication parameters.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    authParameters -
    The authentication parameters.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - addAuthParametersEntry
```
public AdminInitiateAuthRequest addAuthParametersEntry(String key,
                                                       String value)
```
    The authentication parameters.
    
    The method adds a new key-value pair into AuthParameters 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 AuthParameters.
    
    value - The corresponding value of the entry to be added into AuthParameters.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - clearAuthParametersEntries
```
public AdminInitiateAuthRequest clearAuthParametersEntries()
```
    Removes all the entries added into AuthParameters.
    Returns a reference to this object so that method calls can be chained together.
  - getClientMetadata
```
public Map<String,String> getClientMetadata()
```
    The client app metadata.
    
    Returns:
    
    The client app metadata.
  - setClientMetadata
```
public void setClientMetadata(Map<String,String> clientMetadata)
```
    The client app metadata.
    
    Parameters:
    
    clientMetadata -
    The client app metadata.
  - withClientMetadata
```
public AdminInitiateAuthRequest withClientMetadata(Map<String,String> clientMetadata)
```
    The client app metadata.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    clientMetadata -
    The client app metadata.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - addClientMetadataEntry
```
public AdminInitiateAuthRequest addClientMetadataEntry(String key,
                                                       String value)
```
    The client app metadata.
    
    The method adds a new key-value pair into ClientMetadata 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 ClientMetadata.
    
    value - The corresponding value of the entry to be added into ClientMetadata.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - clearClientMetadataEntries
```
public AdminInitiateAuthRequest clearClientMetadataEntries()
```
    Removes all the entries added into ClientMetadata.
    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()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Class AdminInitiateAuthRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

AdminInitiateAuthRequest

Method Detail

getUserPoolId

setUserPoolId

withUserPoolId

getClientId

setClientId

withClientId

getAuthFlow

setAuthFlow

withAuthFlow

setAuthFlow

withAuthFlow

getAuthParameters

setAuthParameters

withAuthParameters

addAuthParametersEntry

clearAuthParametersEntries

getClientMetadata

setClientMetadata

withClientMetadata

addClientMetadataEntry

clearClientMetadataEntries

toString

hashCode

equals