software.amazon.awssdk.services.workmail.model

Interface DescribeUserResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<DescribeUserResponse.Builder,DescribeUserResponse>, SdkBuilder<DescribeUserResponse.Builder,DescribeUserResponse>, SdkPojo, SdkResponse.Builder, WorkMailResponse.Builder

Enclosing class:

DescribeUserResponse

public static interface DescribeUserResponse.Builder
extends WorkMailResponse.Builder, SdkPojo, CopyableBuilder<DescribeUserResponse.Builder,DescribeUserResponse>

Method Summary

Modifier and Type	Method and Description
DescribeUserResponse.Builder	city(String city) City where the user is located.
DescribeUserResponse.Builder	company(String company) Company of the user.
DescribeUserResponse.Builder	country(String country) Country where the user is located.
DescribeUserResponse.Builder	department(String department) Department of the user.
DescribeUserResponse.Builder	disabledDate(Instant disabledDate) The date and time at which the user was disabled for WorkMail usage, in UNIX epoch time format.
DescribeUserResponse.Builder	displayName(String displayName) The display name of the user.
DescribeUserResponse.Builder	email(String email) The email of the user.
DescribeUserResponse.Builder	enabledDate(Instant enabledDate) The date and time at which the user was enabled for WorkMailusage, in UNIX epoch time format.
DescribeUserResponse.Builder	firstName(String firstName) First name of the user.
DescribeUserResponse.Builder	hiddenFromGlobalAddressList(Boolean hiddenFromGlobalAddressList) If enabled, the user is hidden from the global address list.
DescribeUserResponse.Builder	initials(String initials) Initials of the user.
DescribeUserResponse.Builder	jobTitle(String jobTitle) Job title of the user.
DescribeUserResponse.Builder	lastName(String lastName) Last name of the user.
DescribeUserResponse.Builder	mailboxDeprovisionedDate(Instant mailboxDeprovisionedDate) The date when the mailbox was removed for the user.
DescribeUserResponse.Builder	mailboxProvisionedDate(Instant mailboxProvisionedDate) The date when the mailbox was created for the user.
DescribeUserResponse.Builder	name(String name) The name for the user.
DescribeUserResponse.Builder	office(String office) Office where the user is located.
DescribeUserResponse.Builder	state(EntityState state) The state of a user: enabled (registered to WorkMail) or disabled (deregistered or never registered to WorkMail).
DescribeUserResponse.Builder	state(String state) The state of a user: enabled (registered to WorkMail) or disabled (deregistered or never registered to WorkMail).
DescribeUserResponse.Builder	street(String street) Street where the user is located.
DescribeUserResponse.Builder	telephone(String telephone) User's contact number.
DescribeUserResponse.Builder	userId(String userId) The identifier for the described user.
DescribeUserResponse.Builder	userRole(String userRole) In certain cases, other entities are modeled as users.
DescribeUserResponse.Builder	userRole(UserRole userRole) In certain cases, other entities are modeled as users.
DescribeUserResponse.Builder	zipCode(String zipCode) Zip code of the user.

Methods inherited from interface software.amazon.awssdk.services.workmail.model.WorkMailResponse.Builder

build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

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

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

userId

DescribeUserResponse.Builder userId(String userId)

The identifier for the described user.

Parameters:

userId - The identifier for the described user.

Returns:

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

name

DescribeUserResponse.Builder name(String name)

The name for the user.

Parameters:

name - The name for the user.

Returns:

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

email

DescribeUserResponse.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.

displayName

DescribeUserResponse.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

DescribeUserResponse.Builder state(String state)

The state of a user: enabled (registered to WorkMail) or disabled (deregistered or never registered to WorkMail).

Parameters:

state - The state of a user: enabled (registered to WorkMail) or disabled (deregistered or never registered to WorkMail).

Returns:

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

See Also:

EntityState, EntityState

state

DescribeUserResponse.Builder state(EntityState state)

The state of a user: enabled (registered to WorkMail) or disabled (deregistered or never registered to WorkMail).

Parameters:

state - The state of a user: enabled (registered to WorkMail) or disabled (deregistered or never registered to WorkMail).

Returns:

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

See Also:

EntityState, EntityState

userRole

DescribeUserResponse.Builder userRole(String userRole)

In certain cases, other entities are modeled as users. If interoperability is enabled, resources are imported into WorkMail as users. Because different WorkMail organizations rely on different directory types, administrators can distinguish between an unregistered user (account is disabled and has a user role) and the directory administrators. The values are USER, RESOURCE, SYSTEM_USER, and REMOTE_USER.

Parameters:

userRole - In certain cases, other entities are modeled as users. If interoperability is enabled, resources are imported into WorkMail as users. Because different WorkMail organizations rely on different directory types, administrators can distinguish between an unregistered user (account is disabled and has a user role) and the directory administrators. The values are USER, RESOURCE, SYSTEM_USER, and REMOTE_USER.

Returns:

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

See Also:

UserRole, UserRole

userRole

DescribeUserResponse.Builder userRole(UserRole userRole)

In certain cases, other entities are modeled as users. If interoperability is enabled, resources are imported into WorkMail as users. Because different WorkMail organizations rely on different directory types, administrators can distinguish between an unregistered user (account is disabled and has a user role) and the directory administrators. The values are USER, RESOURCE, SYSTEM_USER, and REMOTE_USER.

Parameters:

userRole - In certain cases, other entities are modeled as users. If interoperability is enabled, resources are imported into WorkMail as users. Because different WorkMail organizations rely on different directory types, administrators can distinguish between an unregistered user (account is disabled and has a user role) and the directory administrators. The values are USER, RESOURCE, SYSTEM_USER, and REMOTE_USER.

Returns:

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

See Also:

UserRole, UserRole

enabledDate

DescribeUserResponse.Builder enabledDate(Instant enabledDate)

The date and time at which the user was enabled for WorkMailusage, in UNIX epoch time format.

Parameters:

enabledDate - The date and time at which the user was enabled for WorkMailusage, in UNIX epoch time format.

Returns:

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

disabledDate

DescribeUserResponse.Builder disabledDate(Instant disabledDate)

The date and time at which the user was disabled for WorkMail usage, in UNIX epoch time format.

Parameters:

disabledDate - The date and time at which the user was disabled for WorkMail usage, in UNIX epoch time format.

Returns:

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

mailboxProvisionedDate

DescribeUserResponse.Builder mailboxProvisionedDate(Instant mailboxProvisionedDate)

The date when the mailbox was created for the user.

Parameters:

mailboxProvisionedDate - The date when the mailbox was created for the user.

Returns:

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

mailboxDeprovisionedDate

DescribeUserResponse.Builder mailboxDeprovisionedDate(Instant mailboxDeprovisionedDate)

The date when the mailbox was removed for the user.

Parameters:

mailboxDeprovisionedDate - The date when the mailbox was removed for the user.

Returns:

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

firstName

DescribeUserResponse.Builder firstName(String firstName)

First name of the user.

Parameters:

firstName - First name of the user.

Returns:

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

lastName

DescribeUserResponse.Builder lastName(String lastName)

Last name of the user.

Parameters:

lastName - Last name of the user.

Returns:

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

hiddenFromGlobalAddressList

DescribeUserResponse.Builder hiddenFromGlobalAddressList(Boolean hiddenFromGlobalAddressList)

If enabled, the user is hidden from the global address list.

Parameters:

hiddenFromGlobalAddressList - If enabled, the user is hidden from the global address list.

Returns:

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

initials

DescribeUserResponse.Builder initials(String initials)

Initials of the user.

Parameters:

initials - Initials of the user.

Returns:

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

telephone

DescribeUserResponse.Builder telephone(String telephone)

User's contact number.

Parameters:

telephone - User's contact number.

Returns:

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

street

DescribeUserResponse.Builder street(String street)

Street where the user is located.

Parameters:

street - Street where the user is located.

Returns:

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

jobTitle

DescribeUserResponse.Builder jobTitle(String jobTitle)

Job title of the user.

Parameters:

jobTitle - Job title of the user.

Returns:

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

city

DescribeUserResponse.Builder city(String city)

City where the user is located.

Parameters:

city - City where the user is located.

Returns:

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

company

DescribeUserResponse.Builder company(String company)

Company of the user.

Parameters:

company - Company of the user.

Returns:

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

zipCode

DescribeUserResponse.Builder zipCode(String zipCode)

Zip code of the user.

Parameters:

zipCode - Zip code of the user.

Returns:

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

department

DescribeUserResponse.Builder department(String department)

Department of the user.

Parameters:

department - Department of the user.

Returns:

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

country

DescribeUserResponse.Builder country(String country)

Country where the user is located.

Parameters:

country - Country where the user is located.

Returns:

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

office

DescribeUserResponse.Builder office(String office)

Office where the user is located.

Parameters:

office - Office where the user is located.

Returns:

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