Package software.amazon.awssdk.services.workmail.model

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>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateUserRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateUserRequest.Builder	builder()
String	displayName()	The display name for the new user.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	firstName()	The first name of the new user.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Boolean	hiddenFromGlobalAddressList()	If this parameter is enabled, the user will be hidden from the address book.
String	lastName()	The last name of the new user.
String	name()	The name for the new user.
String	organizationId()	The identifier of the organization for which the user is created.
String	password()	The password for the new user.
UserRole	role()	The role of the new user.
String	roleAsString()	The role of the new user.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateUserRequest.Builder>	serializableBuilderClass()
CreateUserRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

UserRole

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:

UserRole

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()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateUserRequest.Builder,CreateUserRequest>

Specified by:

toBuilder in class WorkMailRequest

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)

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