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

Interface User.Builder

All Superinterfaces:

Buildable, CopyableBuilder<User.Builder,User>, SdkBuilder<User.Builder,User>, SdkPojo

Enclosing class:

User

public static interface User.Builder
extends SdkPojo, CopyableBuilder<User.Builder,User>

Method Summary

Modifier and Type	Method	Description
User.Builder	disabledDate(Instant disabledDate)	The date indicating when the user was disabled from WorkMail use.
User.Builder	displayName(String displayName)	The display name of the user.
User.Builder	email(String email)	The email of the user.
User.Builder	enabledDate(Instant enabledDate)	The date indicating when the user was enabled for WorkMail use.
User.Builder	id(String id)	The identifier of the user.
User.Builder	identityProviderIdentityStoreId(String identityProviderIdentityStoreId)	Identity store ID from the IAM Identity Center.
User.Builder	identityProviderUserId(String identityProviderUserId)	User ID from the IAM Identity Center.
User.Builder	name(String name)	The name of the user.
User.Builder	state(String state)	The state of the user, which can be ENABLED, DISABLED, or DELETED.
User.Builder	state(EntityState state)	The state of the user, which can be ENABLED, DISABLED, or DELETED.
User.Builder	userRole(String userRole)	The role of the user.
User.Builder	userRole(UserRole userRole)	The role of the user.

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

id

User.Builder id(String id)

The identifier of the user.

Parameters:

id - The identifier of the user.

Returns:

Returns a reference to this object so that method calls can be chained together.

email

User.Builder email(String email)

The email of the user.

Parameters:

email - The email of the user.

Returns:

Returns a reference to this object so that method calls can be chained together.

name

User.Builder name(String name)

The name of the user.

Parameters:

name - The name of the user.

Returns:

Returns a reference to this object so that method calls can be chained together.

displayName

User.Builder displayName(String displayName)

The display name of the user.

Parameters:

displayName - The display name of the user.

Returns:

Returns a reference to this object so that method calls can be chained together.

state

User.Builder state(String state)

The state of the user, which can be ENABLED, DISABLED, or DELETED.

Parameters:

state - The state of the user, which can be ENABLED, DISABLED, or DELETED.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

EntityState, EntityState

state

User.Builder state(EntityState state)

The state of the user, which can be ENABLED, DISABLED, or DELETED.

Parameters:

state - The state of the user, which can be ENABLED, DISABLED, or DELETED.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

EntityState, EntityState

userRole

User.Builder userRole(String userRole)

The role of the user.

Parameters:

userRole - The role of the user.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

UserRole, UserRole

userRole

User.Builder userRole(UserRole userRole)

The role of the user.

Parameters:

userRole - The role of the user.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

UserRole, UserRole

enabledDate

User.Builder enabledDate(Instant enabledDate)

The date indicating when the user was enabled for WorkMail use.

Parameters:

enabledDate - The date indicating when the user was enabled for WorkMail use.

Returns:

Returns a reference to this object so that method calls can be chained together.

disabledDate

User.Builder disabledDate(Instant disabledDate)

The date indicating when the user was disabled from WorkMail use.

Parameters:

disabledDate - The date indicating when the user was disabled from WorkMail use.

Returns:

Returns a reference to this object so that method calls can be chained together.

identityProviderUserId

User.Builder identityProviderUserId(String identityProviderUserId)

User ID from the IAM Identity Center. If this parameter is empty it will be updated automatically when the user logs in for the first time to the mailbox associated with WorkMail.

Parameters:

identityProviderUserId - User ID from the IAM Identity Center. If this parameter is empty it will be updated automatically when the user logs in for the first time to the mailbox associated with WorkMail.

Returns:

Returns a reference to this object so that method calls can be chained together.

identityProviderIdentityStoreId

User.Builder identityProviderIdentityStoreId(String identityProviderIdentityStoreId)

Identity store ID from the IAM Identity Center. If this parameter is empty it will be updated automatically when the user logs in for the first time to the mailbox associated with WorkMail.

Parameters:

identityProviderIdentityStoreId - Identity store ID from the IAM Identity Center. If this parameter is empty it will be updated automatically when the user logs in for the first time to the mailbox associated with WorkMail.

Returns:

Returns a reference to this object so that method calls can be chained together.