com.amazonaws.services.cognitoidp.model

Class AdminInitiateAuthRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitoidp.model.AdminInitiateAuthRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AdminInitiateAuthRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Initiates the authorization request, as an administrator.

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
AdminInitiateAuthRequest()

Method Summary

Modifier and Type	Method and Description
AdminInitiateAuthRequest	addAuthParametersEntry(String key, String value)
AdminInitiateAuthRequest	addClientMetadataEntry(String key, String value)
AdminInitiateAuthRequest	clearAuthParametersEntries() Removes all the entries added into AuthParameters.
AdminInitiateAuthRequest	clearClientMetadataEntries() Removes all the entries added into ClientMetadata.
AdminInitiateAuthRequest	clone() Creates a shallow clone of this request.
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

getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AdminInitiateAuthRequest

public AdminInitiateAuthRequest()

Method Detail

setUserPoolId

public void setUserPoolId(String userPoolId)

The ID of the Amazon Cognito user pool.

Parameters:

userPoolId - The ID of the Amazon Cognito user pool.

getUserPoolId

public String getUserPoolId()

The ID of the Amazon Cognito user pool.

Returns:

The ID of the Amazon Cognito user pool.

withUserPoolId

public AdminInitiateAuthRequest withUserPoolId(String userPoolId)

The ID of the Amazon Cognito user pool.

Parameters:

userPoolId - The ID of the Amazon Cognito user pool.

Returns:

Returns a reference to this object so that method calls can be chained together.

setClientId

public void setClientId(String clientId)

The client app ID.

Parameters:

clientId - The client app ID.

getClientId

public String getClientId()

The client app ID.

Returns:

The client app ID.

withClientId

public AdminInitiateAuthRequest withClientId(String clientId)

The client app ID.

Parameters:

clientId - The client app ID.

Returns:

Returns a reference to this object so that method calls can be chained together.

setAuthFlow

public void setAuthFlow(String authFlow)

The authentication flow.

Parameters:

authFlow - The authentication flow.

See Also:

AuthFlowType

getAuthFlow

public String getAuthFlow()

The authentication flow.

Returns:

The authentication flow.

See Also:

AuthFlowType

withAuthFlow

public AdminInitiateAuthRequest withAuthFlow(String authFlow)

The authentication flow.

Parameters:

authFlow - The authentication flow.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AuthFlowType

setAuthFlow

public void setAuthFlow(AuthFlowType authFlow)

The authentication flow.

Parameters:

authFlow - The authentication flow.

See Also:

AuthFlowType

withAuthFlow

public AdminInitiateAuthRequest withAuthFlow(AuthFlowType authFlow)

The authentication flow.

Parameters:

authFlow - The authentication flow.

Returns:

Returns a reference to this 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.

Parameters:

authParameters - The authentication parameters.

Returns:

Returns a reference to this object so that method calls can be chained together.

addAuthParametersEntry

public AdminInitiateAuthRequest addAuthParametersEntry(String key,
                                                       String value)

clearAuthParametersEntries

public AdminInitiateAuthRequest clearAuthParametersEntries()

Removes all the entries added into AuthParameters.

Returns:

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.

Parameters:

clientMetadata - The client app metadata.

Returns:

Returns a reference to this object so that method calls can be chained together.

addClientMetadataEntry

public AdminInitiateAuthRequest addClientMetadataEntry(String key,
                                                       String value)

clearClientMetadataEntries

public AdminInitiateAuthRequest clearClientMetadataEntries()

Removes all the entries added into ClientMetadata.

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 AdminInitiateAuthRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()