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

Class DeleteUserAttributesRequest

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

Represents the request to delete user attributes.

  • Method Details

    • hasUserAttributeNames

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

    • userAttributeNames

      public final List<String> userAttributeNames()

      An array of strings representing the user attribute names you want to delete.

      For custom attributes, you must prepend the custom: prefix to the attribute name, for example custom:department.

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

      Returns:
      An array of strings representing the user attribute names you want to delete.

      For custom attributes, you must prepend the custom: prefix to the attribute name, for example custom:department.

    • accessToken

      public final String accessToken()

      A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for aws.cognito.signin.user.admin.

      Returns:
      A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for aws.cognito.signin.user.admin.

    • toBuilder

      public DeleteUserAttributesRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<DeleteUserAttributesRequest.Builder,DeleteUserAttributesRequest>
      Specified by:
      toBuilder in class CognitoIdentityProviderRequest

    • builder

      public static DeleteUserAttributesRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DeleteUserAttributesRequest.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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo