Package software.amazon.awssdk.services.identitystore.model

Class CreateUserRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.identitystore.model.IdentitystoreRequest
software.amazon.awssdk.services.identitystore.model.CreateUserRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateUserRequest.Builder,CreateUserRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateUserRequest extends IdentitystoreRequest implements ToCopyableBuilder<CreateUserRequest.Builder,CreateUserRequest>

  • Method Details

    • identityStoreId

      public final String identityStoreId()

      The globally unique identifier for the identity store.

      Returns:
      The globally unique identifier for the identity store.

    • userName

      public final String userName()

      A unique string used to identify the user. The length limit is 128 characters. This value can consist of letters, accented characters, symbols, numbers, and punctuation. This value is specified at the time the user is created and stored as an attribute of the user object in the identity store. Administrator and AWSAdministrators are reserved names and can't be used for users or groups.

      Returns:
      A unique string used to identify the user. The length limit is 128 characters. This value can consist of letters, accented characters, symbols, numbers, and punctuation. This value is specified at the time the user is created and stored as an attribute of the user object in the identity store. Administrator and AWSAdministrators are reserved names and can't be used for users or groups.

    • name

      public final Name name()

      An object containing the name of the user.

      Returns:
      An object containing the name of the user.

    • displayName

      public final String displayName()

      A string containing the name of the user. This value is typically formatted for display when the user is referenced. For example, "John Doe."

      Returns:
      A string containing the name of the user. This value is typically formatted for display when the user is referenced. For example, "John Doe."

    • nickName

      public final String nickName()

      A string containing an alternate name for the user.

      Returns:
      A string containing an alternate name for the user.

    • profileUrl

      public final String profileUrl()

      A string containing a URL that might be associated with the user.

      Returns:
      A string containing a URL that might be associated with the user.

    • hasEmails

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

    • emails

      public final List<Email> emails()

      A list of Email objects containing email addresses associated with the user.

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

      Returns:
      A list of Email objects containing email addresses associated with the user.

    • hasAddresses

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

    • addresses

      public final List<Address> addresses()

      A list of Address objects containing addresses associated with the user.

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

      Returns:
      A list of Address objects containing addresses associated with the user.

    • hasPhoneNumbers

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

    • phoneNumbers

      public final List<PhoneNumber> phoneNumbers()

      A list of PhoneNumber objects containing phone numbers associated with the user.

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

      Returns:
      A list of PhoneNumber objects containing phone numbers associated with the user.

    • userType

      public final String userType()

      A string indicating the type of user. Possible values are left unspecified. The value can vary based on your specific use case.

      Returns:
      A string indicating the type of user. Possible values are left unspecified. The value can vary based on your specific use case.

    • title

      public final String title()

      A string containing the title of the user. Possible values are left unspecified. The value can vary based on your specific use case.

      Returns:
      A string containing the title of the user. Possible values are left unspecified. The value can vary based on your specific use case.

    • preferredLanguage

      public final String preferredLanguage()

      A string containing the preferred language of the user. For example, "American English" or "en-us."

      Returns:
      A string containing the preferred language of the user. For example, "American English" or "en-us."

    • locale

      public final String locale()

      A string containing the geographical region or location of the user.

      Returns:
      A string containing the geographical region or location of the user.

    • timezone

      public final String timezone()

      A string containing the time zone of the user.

      Returns:
      A string containing the time zone of the user.

    • toBuilder

      public CreateUserRequest.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<CreateUserRequest.Builder,CreateUserRequest>
      Specified by:
      toBuilder in class IdentitystoreRequest
      Returns:
      a builder for type T

    • builder

      public static CreateUserRequest.Builder builder()

    • serializableBuilderClass

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