Class CreateUserRequest

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

  • Method Details

    • organizationId

      public final String organizationId()

      The identifier of the organization for which the user is created.

      Returns:
      The identifier of the organization for which the user is created.

    • name

      public final String name()

      The name for the new user. WorkMail directory user names have a maximum length of 64. All others have a maximum length of 20.

      Returns:
      The name for the new user. WorkMail directory user names have a maximum length of 64. All others have a maximum length of 20.

    • displayName

      public final String displayName()

      The display name for the new user.

      Returns:
      The display name for the new user.

    • password

      public final String password()

      The password for the new user.

      Returns:
      The password for the new user.

    • role

      public final UserRole role()

      The role of the new user.

      You cannot pass SYSTEM_USER or RESOURCE role in a single request. When a user role is not selected, the default role of USER is selected.

      If the service returns an enum value that is not available in the current SDK version, role will return UserRole.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from roleAsString().

      Returns:
      The role of the new user.

      You cannot pass SYSTEM_USER or RESOURCE role in a single request. When a user role is not selected, the default role of USER is selected.

      See Also:

    • roleAsString

      public final String roleAsString()

      The role of the new user.

      You cannot pass SYSTEM_USER or RESOURCE role in a single request. When a user role is not selected, the default role of USER is selected.

      If the service returns an enum value that is not available in the current SDK version, role will return UserRole.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from roleAsString().

      Returns:
      The role of the new user.

      You cannot pass SYSTEM_USER or RESOURCE role in a single request. When a user role is not selected, the default role of USER is selected.

      See Also:

    • firstName

      public final String firstName()

      The first name of the new user.

      Returns:
      The first name of the new user.

    • lastName

      public final String lastName()

      The last name of the new user.

      Returns:
      The last name of the new user.

    • hiddenFromGlobalAddressList

      public final Boolean hiddenFromGlobalAddressList()

      If this parameter is enabled, the user will be hidden from the address book.

      Returns:
      If this parameter is enabled, the user will be hidden from the address book.

    • 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 WorkMailRequest
      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.