software.amazon.awssdk.services.cognitoidentityprovider.model.UpdateUserAttributesRequest 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.HashMap;
import java.util.List;
import java.util.Map;
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.traits.MapTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructMap;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructMap;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Represents the request to update user attributes.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class UpdateUserAttributesRequest extends CognitoIdentityProviderRequest implements
ToCopyableBuilder {
private static final SdkField> USER_ATTRIBUTES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("UserAttributes")
.getter(getter(UpdateUserAttributesRequest::userAttributes))
.setter(setter(Builder::userAttributes))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("UserAttributes").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(AttributeType::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField ACCESS_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("AccessToken").getter(getter(UpdateUserAttributesRequest::accessToken))
.setter(setter(Builder::accessToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("AccessToken").build()).build();
private static final SdkField> CLIENT_METADATA_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("ClientMetadata")
.getter(getter(UpdateUserAttributesRequest::clientMetadata))
.setter(setter(Builder::clientMetadata))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ClientMetadata").build(),
MapTrait.builder()
.keyLocationName("key")
.valueLocationName("value")
.valueFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("value").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(USER_ATTRIBUTES_FIELD,
ACCESS_TOKEN_FIELD, CLIENT_METADATA_FIELD));
private static final Map> SDK_NAME_TO_FIELD = memberNameToFieldInitializer();
private final List userAttributes;
private final String accessToken;
private final Map clientMetadata;
private UpdateUserAttributesRequest(BuilderImpl builder) {
super(builder);
this.userAttributes = builder.userAttributes;
this.accessToken = builder.accessToken;
this.clientMetadata = builder.clientMetadata;
}
/**
* For responses, this returns true if the service returned a value for the UserAttributes 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 hasUserAttributes() {
return userAttributes != null && !(userAttributes instanceof SdkAutoConstructList);
}
/**
*
* An array of name-value pairs representing user attributes.
*
*
* For custom attributes, you must prepend the custom: prefix to the attribute name.
*
*
* If you have set an attribute to require verification before Amazon Cognito updates its value, this request
* doesn’t immediately update the value of that attribute. After your user receives and responds to a verification
* message to verify the new value, Amazon Cognito updates the attribute value. Your user can sign in and receive
* messages with the original attribute value until they verify the new value.
*
*
* 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 #hasUserAttributes} method.
*
*
* @return An array of name-value pairs representing user attributes.
*
* For custom attributes, you must prepend the custom: prefix to the attribute name.
*
*
* If you have set an attribute to require verification before Amazon Cognito updates its value, this
* request doesn’t immediately update the value of that attribute. After your user receives and responds to
* a verification message to verify the new value, Amazon Cognito updates the attribute value. Your user can
* sign in and receive messages with the original attribute value until they verify the new value.
*/
public final List userAttributes() {
return userAttributes;
}
/**
*
* A valid access token that Amazon Cognito issued to the user whose user attributes you want to update.
*
*
* @return A valid access token that Amazon Cognito issued to the user whose user attributes you want to update.
*/
public final String accessToken() {
return accessToken;
}
/**
* For responses, this returns true if the service returned a value for the ClientMetadata 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 hasClientMetadata() {
return clientMetadata != null && !(clientMetadata instanceof SdkAutoConstructMap);
}
/**
*
* A map of custom key-value pairs that you can provide as input for any custom workflows that this action
* initiates.
*
*
* You create custom workflows by assigning Lambda functions to user pool triggers. When you use the
* UpdateUserAttributes API action, Amazon Cognito invokes the function that is assigned to the custom
* message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function
* receives as input. This payload contains a clientMetadata attribute, which provides the data that
* you assigned to the ClientMetadata parameter in your UpdateUserAttributes request. In your function code in
* Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.
*
*
* For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
*
*
*
* When you use the ClientMetadata parameter, note that Amazon Cognito won't do the following:
*
*
* -
*
* Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to
* a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the
* ClientMetadata parameter serves no purpose.
*
*
* -
*
* Validate the ClientMetadata value.
*
*
* -
*
* Encrypt the ClientMetadata value. Don't send sensitive information in this parameter.
*
*
*
*
*
* 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 #hasClientMetadata} method.
*
*
* @return A map of custom key-value pairs that you can provide as input for any custom workflows that this action
* initiates.
*
* You create custom workflows by assigning Lambda functions to user pool triggers. When you use the
* UpdateUserAttributes API action, Amazon Cognito invokes the function that is assigned to the custom
* message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the
* function receives as input. This payload contains a clientMetadata attribute, which provides
* the data that you assigned to the ClientMetadata parameter in your UpdateUserAttributes request. In your
* function code in Lambda, you can process the clientMetadata value to enhance your workflow
* for your specific needs.
*
*
* For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
*
*
*
* When you use the ClientMetadata parameter, note that Amazon Cognito won't do the following:
*
*
* -
*
* Store the ClientMetadata value. This data is available only to Lambda triggers that are
* assigned to a user pool to support custom workflows. If your user pool configuration doesn't include
* triggers, the ClientMetadata parameter serves no purpose.
*
*
* -
*
* Validate the ClientMetadata value.
*
*
* -
*
* Encrypt the ClientMetadata value. Don't send sensitive information in this parameter.
*
*
*
*/
public final Map clientMetadata() {
return clientMetadata;
}
@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(hasUserAttributes() ? userAttributes() : null);
hashCode = 31 * hashCode + Objects.hashCode(accessToken());
hashCode = 31 * hashCode + Objects.hashCode(hasClientMetadata() ? clientMetadata() : 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 UpdateUserAttributesRequest)) {
return false;
}
UpdateUserAttributesRequest other = (UpdateUserAttributesRequest) obj;
return hasUserAttributes() == other.hasUserAttributes() && Objects.equals(userAttributes(), other.userAttributes())
&& Objects.equals(accessToken(), other.accessToken()) && hasClientMetadata() == other.hasClientMetadata()
&& Objects.equals(clientMetadata(), other.clientMetadata());
}
/**
* 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("UpdateUserAttributesRequest")
.add("UserAttributes", hasUserAttributes() ? userAttributes() : null)
.add("AccessToken", accessToken() == null ? null : "*** Sensitive Data Redacted ***")
.add("ClientMetadata", hasClientMetadata() ? clientMetadata() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "UserAttributes":
return Optional.ofNullable(clazz.cast(userAttributes()));
case "AccessToken":
return Optional.ofNullable(clazz.cast(accessToken()));
case "ClientMetadata":
return Optional.ofNullable(clazz.cast(clientMetadata()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Map> memberNameToFieldInitializer() {
Map> map = new HashMap<>();
map.put("UserAttributes", USER_ATTRIBUTES_FIELD);
map.put("AccessToken", ACCESS_TOKEN_FIELD);
map.put("ClientMetadata", CLIENT_METADATA_FIELD);
return Collections.unmodifiableMap(map);
}
private static Function getter(Function g) {
return obj -> g.apply((UpdateUserAttributesRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends CognitoIdentityProviderRequest.Builder, SdkPojo,
CopyableBuilder {
/**
*
* An array of name-value pairs representing user attributes.
*
*
* For custom attributes, you must prepend the custom: prefix to the attribute name.
*
*
* If you have set an attribute to require verification before Amazon Cognito updates its value, this request
* doesn’t immediately update the value of that attribute. After your user receives and responds to a
* verification message to verify the new value, Amazon Cognito updates the attribute value. Your user can sign
* in and receive messages with the original attribute value until they verify the new value.
*
*
* @param userAttributes
* An array of name-value pairs representing user attributes.
*
* For custom attributes, you must prepend the custom: prefix to the attribute name.
*
*
* If you have set an attribute to require verification before Amazon Cognito updates its value, this
* request doesn’t immediately update the value of that attribute. After your user receives and responds
* to a verification message to verify the new value, Amazon Cognito updates the attribute value. Your
* user can sign in and receive messages with the original attribute value until they verify the new
* value.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder userAttributes(Collection userAttributes);
/**
*
* An array of name-value pairs representing user attributes.
*
*
* For custom attributes, you must prepend the custom: prefix to the attribute name.
*
*
* If you have set an attribute to require verification before Amazon Cognito updates its value, this request
* doesn’t immediately update the value of that attribute. After your user receives and responds to a
* verification message to verify the new value, Amazon Cognito updates the attribute value. Your user can sign
* in and receive messages with the original attribute value until they verify the new value.
*
*
* @param userAttributes
* An array of name-value pairs representing user attributes.
*
* For custom attributes, you must prepend the custom: prefix to the attribute name.
*
*
* If you have set an attribute to require verification before Amazon Cognito updates its value, this
* request doesn’t immediately update the value of that attribute. After your user receives and responds
* to a verification message to verify the new value, Amazon Cognito updates the attribute value. Your
* user can sign in and receive messages with the original attribute value until they verify the new
* value.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder userAttributes(AttributeType... userAttributes);
/**
*
* An array of name-value pairs representing user attributes.
*
*
* For custom attributes, you must prepend the custom: prefix to the attribute name.
*
*
* If you have set an attribute to require verification before Amazon Cognito updates its value, this request
* doesn’t immediately update the value of that attribute. After your user receives and responds to a
* verification message to verify the new value, Amazon Cognito updates the attribute value. Your user can sign
* in and receive messages with the original attribute value until they verify the new value.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.cognitoidentityprovider.model.AttributeType.Builder} avoiding the need
* to create one manually via
* {@link software.amazon.awssdk.services.cognitoidentityprovider.model.AttributeType#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.cognitoidentityprovider.model.AttributeType.Builder#build()} is called
* immediately and its result is passed to {@link #userAttributes(List)}.
*
* @param userAttributes
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.cognitoidentityprovider.model.AttributeType.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #userAttributes(java.util.Collection)
*/
Builder userAttributes(Consumer... userAttributes);
/**
*
* A valid access token that Amazon Cognito issued to the user whose user attributes you want to update.
*
*
* @param accessToken
* A valid access token that Amazon Cognito issued to the user whose user attributes you want to update.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder accessToken(String accessToken);
/**
*
* A map of custom key-value pairs that you can provide as input for any custom workflows that this action
* initiates.
*
*
* You create custom workflows by assigning Lambda functions to user pool triggers. When you use the
* UpdateUserAttributes API action, Amazon Cognito invokes the function that is assigned to the custom
* message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function
* receives as input. This payload contains a clientMetadata attribute, which provides the data
* that you assigned to the ClientMetadata parameter in your UpdateUserAttributes request. In your function code
* in Lambda, you can process the clientMetadata value to enhance your workflow for your specific
* needs.
*
*
* For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
*
*
*
* When you use the ClientMetadata parameter, note that Amazon Cognito won't do the following:
*
*
* -
*
* Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned
* to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the
* ClientMetadata parameter serves no purpose.
*
*
* -
*
* Validate the ClientMetadata value.
*
*
* -
*
* Encrypt the ClientMetadata value. Don't send sensitive information in this parameter.
*
*
*
*
*
* @param clientMetadata
* A map of custom key-value pairs that you can provide as input for any custom workflows that this
* action initiates.
*
* You create custom workflows by assigning Lambda functions to user pool triggers. When you use the
* UpdateUserAttributes API action, Amazon Cognito invokes the function that is assigned to the custom
* message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the
* function receives as input. This payload contains a clientMetadata attribute, which
* provides the data that you assigned to the ClientMetadata parameter in your UpdateUserAttributes
* request. In your function code in Lambda, you can process the clientMetadata value to
* enhance your workflow for your specific needs.
*
*
* For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer
* Guide.
*
*
*
* When you use the ClientMetadata parameter, note that Amazon Cognito won't do the
* following:
*
*
* -
*
* Store the ClientMetadata value. This data is available only to Lambda triggers that are
* assigned to a user pool to support custom workflows. If your user pool configuration doesn't include
* triggers, the ClientMetadata parameter serves no purpose.
*
*
* -
*
* Validate the ClientMetadata value.
*
*
* -
*
* Encrypt the ClientMetadata value. Don't send sensitive information in this parameter.
*
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder clientMetadata(Map clientMetadata);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends CognitoIdentityProviderRequest.BuilderImpl implements Builder {
private List userAttributes = DefaultSdkAutoConstructList.getInstance();
private String accessToken;
private Map clientMetadata = DefaultSdkAutoConstructMap.getInstance();
private BuilderImpl() {
}
private BuilderImpl(UpdateUserAttributesRequest model) {
super(model);
userAttributes(model.userAttributes);
accessToken(model.accessToken);
clientMetadata(model.clientMetadata);
}
public final List getUserAttributes() {
List result = AttributeListTypeCopier.copyToBuilder(this.userAttributes);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setUserAttributes(Collection userAttributes) {
this.userAttributes = AttributeListTypeCopier.copyFromBuilder(userAttributes);
}
@Override
public final Builder userAttributes(Collection userAttributes) {
this.userAttributes = AttributeListTypeCopier.copy(userAttributes);
return this;
}
@Override
@SafeVarargs
public final Builder userAttributes(AttributeType... userAttributes) {
userAttributes(Arrays.asList(userAttributes));
return this;
}
@Override
@SafeVarargs
public final Builder userAttributes(Consumer... userAttributes) {
userAttributes(Stream.of(userAttributes).map(c -> AttributeType.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
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 Map getClientMetadata() {
if (clientMetadata instanceof SdkAutoConstructMap) {
return null;
}
return clientMetadata;
}
public final void setClientMetadata(Map clientMetadata) {
this.clientMetadata = ClientMetadataTypeCopier.copy(clientMetadata);
}
@Override
public final Builder clientMetadata(Map clientMetadata) {
this.clientMetadata = ClientMetadataTypeCopier.copy(clientMetadata);
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 UpdateUserAttributesRequest build() {
return new UpdateUserAttributesRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}