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(value="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 and Description
static interface	SetUserSettingsRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	accessToken() The access token for the set user settings request.
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() Returns true if the MFAOptions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
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()

The access token for the set user settings request.

Returns:

The access token for the set user settings request.

hasMfaOptions

public final boolean hasMfaOptions()

Returns true if the MFAOptions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

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.

You can use hasMfaOptions() to see if a value was sent in this field.

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