software.amazon.awssdk.services.cognitoidentityprovider.model.SetUserSettingsRequest Maven / Gradle / Ivy
Show all versions of cognitoidentityprovider Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.cognitoidentityprovider.model;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Represents the request to set user settings.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class SetUserSettingsRequest extends CognitoIdentityProviderRequest implements
ToCopyableBuilder {
private static final SdkField ACCESS_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("AccessToken").getter(getter(SetUserSettingsRequest::accessToken)).setter(setter(Builder::accessToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("AccessToken").build()).build();
private static final SdkField> MFA_OPTIONS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("MFAOptions")
.getter(getter(SetUserSettingsRequest::mfaOptions))
.setter(setter(Builder::mfaOptions))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MFAOptions").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(MFAOptionType::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ACCESS_TOKEN_FIELD,
MFA_OPTIONS_FIELD));
private final String accessToken;
private final List mfaOptions;
private SetUserSettingsRequest(BuilderImpl builder) {
super(builder);
this.accessToken = builder.accessToken;
this.mfaOptions = builder.mfaOptions;
}
/**
*
* A valid access token that Amazon Cognito issued to the user whose user settings you want to configure.
*
*
* @return A valid access token that Amazon Cognito issued to the user whose user settings you want to configure.
*/
public final String accessToken() {
return accessToken;
}
/**
* 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 {@code 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.
*/
public final boolean hasMfaOptions() {
return mfaOptions != null && !(mfaOptions instanceof SdkAutoConstructList);
}
/**
*
* 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 {@link #hasMfaOptions} method.
*
*
* @return You can use this parameter only to set an SMS configuration that uses SMS for delivery.
*/
public final List mfaOptions() {
return mfaOptions;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(accessToken());
hashCode = 31 * hashCode + Objects.hashCode(hasMfaOptions() ? mfaOptions() : null);
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof SetUserSettingsRequest)) {
return false;
}
SetUserSettingsRequest other = (SetUserSettingsRequest) obj;
return Objects.equals(accessToken(), other.accessToken()) && hasMfaOptions() == other.hasMfaOptions()
&& Objects.equals(mfaOptions(), other.mfaOptions());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("SetUserSettingsRequest")
.add("AccessToken", accessToken() == null ? null : "*** Sensitive Data Redacted ***")
.add("MFAOptions", hasMfaOptions() ? mfaOptions() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "AccessToken":
return Optional.ofNullable(clazz.cast(accessToken()));
case "MFAOptions":
return Optional.ofNullable(clazz.cast(mfaOptions()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((SetUserSettingsRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends CognitoIdentityProviderRequest.Builder, SdkPojo,
CopyableBuilder {
/**
*
* A valid access token that Amazon Cognito issued to the user whose user settings you want to configure.
*
*
* @param accessToken
* A valid access token that Amazon Cognito issued to the user whose user settings you want to configure.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder accessToken(String accessToken);
/**
*
* You can use this parameter only to set an SMS configuration that uses SMS for delivery.
*
*
* @param mfaOptions
* You can use this parameter only to set an SMS configuration that uses SMS for delivery.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder mfaOptions(Collection mfaOptions);
/**
*
* You can use this parameter only to set an SMS configuration that uses SMS for delivery.
*
*
* @param mfaOptions
* You can use this parameter only to set an SMS configuration that uses SMS for delivery.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder mfaOptions(MFAOptionType... mfaOptions);
/**
*
* You can use this parameter only to set an SMS configuration that uses SMS for delivery.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.cognitoidentityprovider.model.MFAOptionType.Builder} avoiding the need
* to create one manually via
* {@link software.amazon.awssdk.services.cognitoidentityprovider.model.MFAOptionType#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.cognitoidentityprovider.model.MFAOptionType.Builder#build()} is called
* immediately and its result is passed to {@link #mfaOptions(List)}.
*
* @param mfaOptions
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.cognitoidentityprovider.model.MFAOptionType.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #mfaOptions(java.util.Collection)
*/
Builder mfaOptions(Consumer... mfaOptions);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends CognitoIdentityProviderRequest.BuilderImpl implements Builder {
private String accessToken;
private List mfaOptions = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(SetUserSettingsRequest model) {
super(model);
accessToken(model.accessToken);
mfaOptions(model.mfaOptions);
}
public final String getAccessToken() {
return accessToken;
}
public final void setAccessToken(String accessToken) {
this.accessToken = accessToken;
}
@Override
public final Builder accessToken(String accessToken) {
this.accessToken = accessToken;
return this;
}
public final List getMfaOptions() {
List result = MFAOptionListTypeCopier.copyToBuilder(this.mfaOptions);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setMfaOptions(Collection mfaOptions) {
this.mfaOptions = MFAOptionListTypeCopier.copyFromBuilder(mfaOptions);
}
@Override
public final Builder mfaOptions(Collection mfaOptions) {
this.mfaOptions = MFAOptionListTypeCopier.copy(mfaOptions);
return this;
}
@Override
@SafeVarargs
public final Builder mfaOptions(MFAOptionType... mfaOptions) {
mfaOptions(Arrays.asList(mfaOptions));
return this;
}
@Override
@SafeVarargs
public final Builder mfaOptions(Consumer... mfaOptions) {
mfaOptions(Stream.of(mfaOptions).map(c -> MFAOptionType.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public SetUserSettingsRequest build() {
return new SetUserSettingsRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}