com.amazonaws.services.cognitoidp.model

Class InitiateAuthRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitoidp.model.InitiateAuthRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class InitiateAuthRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Initiates the authentication request.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
InitiateAuthRequest()

Method Summary

Modifier and Type	Method and Description
InitiateAuthRequest	addAuthParametersEntry(String key, String value)
InitiateAuthRequest	addClientMetadataEntry(String key, String value)
InitiateAuthRequest	clearAuthParametersEntries() Removes all the entries added into AuthParameters.
InitiateAuthRequest	clearClientMetadataEntries() Removes all the entries added into ClientMetadata.
InitiateAuthRequest	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 ID.
Map<String,String>	getClientMetadata() The client app's metadata.
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 ID.
void	setClientMetadata(Map<String,String> clientMetadata) The client app's metadata.
String	toString() Returns a string representation of this object; useful for testing and debugging.
InitiateAuthRequest	withAuthFlow(AuthFlowType authFlow) The authentication flow.
InitiateAuthRequest	withAuthFlow(String authFlow) The authentication flow.
InitiateAuthRequest	withAuthParameters(Map<String,String> authParameters) The authentication parameters.
InitiateAuthRequest	withClientId(String clientId) The client ID.
InitiateAuthRequest	withClientMetadata(Map<String,String> clientMetadata) The client app's metadata.

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

InitiateAuthRequest

public InitiateAuthRequest()

Method Detail

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 InitiateAuthRequest 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 InitiateAuthRequest 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 InitiateAuthRequest 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 InitiateAuthRequest addAuthParametersEntry(String key,
                                                  String value)

clearAuthParametersEntries

public InitiateAuthRequest clearAuthParametersEntries()

Removes all the entries added into AuthParameters. <p> Returns a reference to this object so that method calls can be chained together.

getClientMetadata

public Map<String,String> getClientMetadata()

The client app's metadata.

Returns:

The client app's metadata.

setClientMetadata

public void setClientMetadata(Map<String,String> clientMetadata)

The client app's metadata.

Parameters:

clientMetadata - The client app's metadata.

withClientMetadata

public InitiateAuthRequest withClientMetadata(Map<String,String> clientMetadata)

The client app's metadata.

Parameters:

clientMetadata - The client app's metadata.

Returns:

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

addClientMetadataEntry

public InitiateAuthRequest addClientMetadataEntry(String key,
                                                  String value)

clearClientMetadataEntries

public InitiateAuthRequest clearClientMetadataEntries()

Removes all the entries added into ClientMetadata. <p> Returns a reference to this object so that method calls can be chained together.

setClientId

public void setClientId(String clientId)

The client ID.

Parameters:

clientId - The client ID.

getClientId

public String getClientId()

The client ID.

Returns:

The client ID.

withClientId

public InitiateAuthRequest withClientId(String clientId)

The client ID.

Parameters:

clientId - The client ID.

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 InitiateAuthRequest 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()