Package software.amazon.awssdk.services.cognitoidentityprovider.model

Class SetUserSettingsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderRequest

software.amazon.awssdk.services.cognitoidentityprovider.model.SetUserSettingsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<SetUserSettingsRequest.Builder,SetUserSettingsRequest>

@Generated("software.amazon.awssdk:codegen")
public final class SetUserSettingsRequest
extends CognitoIdentityProviderRequest
implements ToCopyableBuilder<SetUserSettingsRequest.Builder,SetUserSettingsRequest>

Represents the request to set user settings.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SetUserSettingsRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	accessToken()	A valid access token that Amazon Cognito issued to the user whose user settings you want to configure.
static SetUserSettingsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasMfaOptions()	For responses, this returns true if the service returned a value for the MFAOptions property.
List<MFAOptionType>	mfaOptions()	You can use this parameter only to set an SMS configuration that uses SMS for delivery.
List<SdkField<?>>	sdkFields()
static Class<? extends SetUserSettingsRequest.Builder>	serializableBuilderClass()
SetUserSettingsRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

accessToken

public final String accessToken()

A valid access token that Amazon Cognito issued to the user whose user settings you want to configure.

Returns:

A valid access token that Amazon Cognito issued to the user whose user settings you want to configure.

hasMfaOptions

public final boolean hasMfaOptions()

For responses, this returns true if the service returned a value for the MFAOptions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

mfaOptions

public final List<MFAOptionType> mfaOptions()

You can use this parameter only to set an SMS configuration that uses SMS for delivery.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasMfaOptions() method.

Returns:

You can use this parameter only to set an SMS configuration that uses SMS for delivery.

toBuilder

public SetUserSettingsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SetUserSettingsRequest.Builder,SetUserSettingsRequest>

Specified by:

toBuilder in class CognitoIdentityProviderRequest

builder

public static SetUserSettingsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends SetUserSettingsRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo