Package com.amazonaws.services.cognitoidp.model

Class SetUserSettingsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitoidp.model.SetUserSettingsRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class SetUserSettingsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Represents the request to set user settings.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor	Description
SetUserSettingsRequest()

Method Summary

Modifier and Type	Method	Description
SetUserSettingsRequest	clone()	Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getAccessToken()	The access token for the set user settings request.
List<MFAOptionType>	getMFAOptions()	Specifies the options for MFA (e.g., email or phone number).
int	hashCode()
void	setAccessToken(String accessToken)	The access token for the set user settings request.
void	setMFAOptions(Collection<MFAOptionType> mFAOptions)	Specifies the options for MFA (e.g., email or phone number).
String	toString()	Returns a string representation of this object; useful for testing and debugging.
SetUserSettingsRequest	withAccessToken(String accessToken)	The access token for the set user settings request.
SetUserSettingsRequest	withMFAOptions(MFAOptionType... mFAOptions)	Specifies the options for MFA (e.g., email or phone number).
SetUserSettingsRequest	withMFAOptions(Collection<MFAOptionType> mFAOptions)	Specifies the options for MFA (e.g., email or phone number).

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, 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

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SetUserSettingsRequest

public SetUserSettingsRequest()

Method Detail

setAccessToken

public void setAccessToken(String accessToken)

The access token for the set user settings request.

Parameters:

accessToken - The access token for the set user settings request.

getAccessToken

public String getAccessToken()

The access token for the set user settings request.

Returns:

The access token for the set user settings request.

withAccessToken

public SetUserSettingsRequest withAccessToken(String accessToken)

The access token for the set user settings request.

Parameters:

accessToken - The access token for the set user settings request.

Returns:

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

getMFAOptions

public List<MFAOptionType> getMFAOptions()

Specifies the options for MFA (e.g., email or phone number).

Returns:

Specifies the options for MFA (e.g., email or phone number).

setMFAOptions

public void setMFAOptions(Collection<MFAOptionType> mFAOptions)

Specifies the options for MFA (e.g., email or phone number).

Parameters:

mFAOptions - Specifies the options for MFA (e.g., email or phone number).

withMFAOptions

public SetUserSettingsRequest withMFAOptions(MFAOptionType... mFAOptions)

Specifies the options for MFA (e.g., email or phone number).

NOTE: This method appends the values to the existing list (if any). Use setMFAOptions(java.util.Collection) or withMFAOptions(java.util.Collection) if you want to override the existing values.

Parameters:

mFAOptions - Specifies the options for MFA (e.g., email or phone number).

Returns:

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

withMFAOptions

public SetUserSettingsRequest withMFAOptions(Collection<MFAOptionType> mFAOptions)

Specifies the options for MFA (e.g., email or phone number).

Parameters:

mFAOptions - Specifies the options for MFA (e.g., email or phone number).

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