Class AddCustomAttributesRequest

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.AddCustomAttributesRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<AddCustomAttributesRequest.Builder,AddCustomAttributesRequest>
@Generated("software.amazon.awssdk:codegen") public final class AddCustomAttributesRequest extends CognitoIdentityProviderRequest implements ToCopyableBuilder<AddCustomAttributesRequest.Builder,AddCustomAttributesRequest>

Represents the request to add custom attributes.

  • Method Details

    • userPoolId

      public final String userPoolId()

      The ID of the user pool where you want to add custom attributes.

      Returns:
      The ID of the user pool where you want to add custom attributes.

    • hasCustomAttributes

      public final boolean hasCustomAttributes()
      For responses, this returns true if the service returned a value for the CustomAttributes 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.

    • customAttributes

      public final List<SchemaAttributeType> customAttributes()

      An array of custom attribute names and other properties. Sets the following characteristics:

      AttributeDataType

      The expected data type. Can be a string, a number, a date and time, or a boolean.

      Mutable

      If true, you can grant app clients write access to the attribute value. If false, the attribute value can only be set up on sign-up or administrator creation of users.

      Name

      The attribute name. For an attribute like custom:myAttribute, enter myAttribute for this field.

      Required

      When true, users who sign up or are created must set a value for the attribute.

      NumberAttributeConstraints

      The minimum and maximum length of accepted values for a Number-type attribute.

      StringAttributeConstraints

      The minimum and maximum length of accepted values for a String-type attribute.

      DeveloperOnlyAttribute

      This legacy option creates an attribute with a dev: prefix. You can only set the value of a developer-only attribute with administrative IAM credentials.

      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 hasCustomAttributes() method.

      Returns:
      An array of custom attribute names and other properties. Sets the following characteristics:

      AttributeDataType

      The expected data type. Can be a string, a number, a date and time, or a boolean.

      Mutable

      If true, you can grant app clients write access to the attribute value. If false, the attribute value can only be set up on sign-up or administrator creation of users.

      Name

      The attribute name. For an attribute like custom:myAttribute, enter myAttribute for this field.

      Required

      When true, users who sign up or are created must set a value for the attribute.

      NumberAttributeConstraints

      The minimum and maximum length of accepted values for a Number-type attribute.

      StringAttributeConstraints

      The minimum and maximum length of accepted values for a String-type attribute.

      DeveloperOnlyAttribute

      This legacy option creates an attribute with a dev: prefix. You can only set the value of a developer-only attribute with administrative IAM credentials.

    • toBuilder

      public AddCustomAttributesRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<AddCustomAttributesRequest.Builder,AddCustomAttributesRequest>
      Specified by:
      toBuilder in class CognitoIdentityProviderRequest
      Returns:
      a builder for type T

    • builder

      public static AddCustomAttributesRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends AddCustomAttributesRequest.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.