Class User.Builder (0.63.0) 

public static final class User.Builder extends GeneratedMessage.Builder<User.Builder> implements UserOrBuilder

If your Chat app authenticates as a user, the output for a User resource (such as in the Messages and Memberships APIs) only populates the name and type fields for both internal and external users, unless they are members of the space or have prior affinity with the calling user.

Protobuf type google.chat.v1.User

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > User.Builder

Implements

UserOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

build()

public User build()
Returns
Type Description
User

buildPartial()

public User buildPartial()
Returns
Type Description
User

clear()

public User.Builder clear()
Returns
Type Description
User.Builder
Overrides

clearAvatarUrl()

public User.Builder clearAvatarUrl()

Output only. The user's avatar image URL.

When calling the Messages and Memberships APIs with user authentication, this field is populated for both internal and external users for the sender of a message, users within annotations (such as user mentions), and within Membership resources, provided the user is a member of the space or has prior affinity with the calling user.

string avatar_url = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
User.Builder

This builder for chaining.

clearDisplayName()

public User.Builder clearDisplayName()

Output only. The user's display name.

Populated for both app authentication and user authentication. This field is always populated for requests made with app authentication. When calling the Messages and Memberships APIs with user authentication, this field is populated for both internal and external users for the sender of a message, users within annotations (such as user mentions), and within Membership resources, provided the user is a member of the space or has prior affinity with the calling user.

string display_name = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
User.Builder

This builder for chaining.

clearDomainId()

public User.Builder clearDomainId()

Unique identifier of the user's Google Workspace domain.

string domain_id = 6;

Returns
Type Description
User.Builder

This builder for chaining.

clearEmail()

public User.Builder clearEmail()

Output only. The user's email address.

When calling the Messages and Memberships APIs with user authentication, this field is populated for both internal and external users for the sender of a message, users within annotations (such as user mentions), and within Membership resources, provided the user is a member of the space or has prior affinity with the calling user.

string email = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
User.Builder

This builder for chaining.

clearIsAnonymous()

public User.Builder clearIsAnonymous()

Output only. When true, the user is deleted or their profile is not visible, such as when a user is mentioned in a space without being a member and without prior affinity with the calling user.

bool is_anonymous = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
User.Builder

This builder for chaining.

clearName()

public User.Builder clearName()

Resource name for a Google Chat user.

Format: users/{user}. users/app can be used as an alias for the calling app bot user.

For human users, {user} is the same user identifier as:

  • the id for the Person in the People API. For example, users/123456789 in Chat API represents the same person as the 123456789 Person profile ID in People API.

  • the id for a user in the Admin SDK Directory API.

  • the user's email address can be used as an alias for {user} in API requests. For example, if the People API Person profile ID for user@example.com is 123456789, you can use users/user@example.com as an alias to reference users/123456789. Only the canonical resource name (for example users/123456789) will be returned from the API.

string name = 1;

Returns
Type Description
User.Builder

This builder for chaining.

clearType()

public User.Builder clearType()

User type.

.google.chat.v1.User.Type type = 5;

Returns
Type Description
User.Builder

This builder for chaining.

getAvatarUrl()

public String getAvatarUrl()

Output only. The user's avatar image URL.

When calling the Messages and Memberships APIs with user authentication, this field is populated for both internal and external users for the sender of a message, users within annotations (such as user mentions), and within Membership resources, provided the user is a member of the space or has prior affinity with the calling user.

string avatar_url = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The avatarUrl.

getAvatarUrlBytes()

public ByteString getAvatarUrlBytes()

Output only. The user's avatar image URL.

When calling the Messages and Memberships APIs with user authentication, this field is populated for both internal and external users for the sender of a message, users within annotations (such as user mentions), and within Membership resources, provided the user is a member of the space or has prior affinity with the calling user.

string avatar_url = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for avatarUrl.

getDefaultInstanceForType()

public User getDefaultInstanceForType()
Returns
Type Description
User

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDisplayName()

public String getDisplayName()

Output only. The user's display name.

Populated for both app authentication and user authentication. This field is always populated for requests made with app authentication. When calling the Messages and Memberships APIs with user authentication, this field is populated for both internal and external users for the sender of a message, users within annotations (such as user mentions), and within Membership resources, provided the user is a member of the space or has prior affinity with the calling user.

string display_name = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Output only. The user's display name.

Populated for both app authentication and user authentication. This field is always populated for requests made with app authentication. When calling the Messages and Memberships APIs with user authentication, this field is populated for both internal and external users for the sender of a message, users within annotations (such as user mentions), and within Membership resources, provided the user is a member of the space or has prior affinity with the calling user.

string display_name = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for displayName.

getDomainId()

public String getDomainId()

Unique identifier of the user's Google Workspace domain.

string domain_id = 6;

Returns
Type Description
String

The domainId.

getDomainIdBytes()

public ByteString getDomainIdBytes()

Unique identifier of the user's Google Workspace domain.

string domain_id = 6;

Returns
Type Description
ByteString

The bytes for domainId.

getEmail()

public String getEmail()

Output only. The user's email address.

When calling the Messages and Memberships APIs with user authentication, this field is populated for both internal and external users for the sender of a message, users within annotations (such as user mentions), and within Membership resources, provided the user is a member of the space or has prior affinity with the calling user.

string email = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The email.

getEmailBytes()

public ByteString getEmailBytes()

Output only. The user's email address.

When calling the Messages and Memberships APIs with user authentication, this field is populated for both internal and external users for the sender of a message, users within annotations (such as user mentions), and within Membership resources, provided the user is a member of the space or has prior affinity with the calling user.

string email = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for email.

getIsAnonymous()

public boolean getIsAnonymous()

Output only. When true, the user is deleted or their profile is not visible, such as when a user is mentioned in a space without being a member and without prior affinity with the calling user.

bool is_anonymous = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The isAnonymous.

getName()

public String getName()

Resource name for a Google Chat user.

Format: users/{user}. users/app can be used as an alias for the calling app bot user.

For human users, {user} is the same user identifier as:

  • the id for the Person in the People API. For example, users/123456789 in Chat API represents the same person as the 123456789 Person profile ID in People API.

  • the id for a user in the Admin SDK Directory API.

  • the user's email address can be used as an alias for {user} in API requests. For example, if the People API Person profile ID for user@example.com is 123456789, you can use users/user@example.com as an alias to reference users/123456789. Only the canonical resource name (for example users/123456789) will be returned from the API.

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Resource name for a Google Chat user.

Format: users/{user}. users/app can be used as an alias for the calling app bot user.

For human users, {user} is the same user identifier as:

  • the id for the Person in the People API. For example, users/123456789 in Chat API represents the same person as the 123456789 Person profile ID in People API.

  • the id for a user in the Admin SDK Directory API.

  • the user's email address can be used as an alias for {user} in API requests. For example, if the People API Person profile ID for user@example.com is 123456789, you can use users/user@example.com as an alias to reference users/123456789. Only the canonical resource name (for example users/123456789) will be returned from the API.

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getType()

public User.Type getType()

User type.

.google.chat.v1.User.Type type = 5;

Returns
Type Description
User.Type

The type.

getTypeValue()

public int getTypeValue()

User type.

.google.chat.v1.User.Type type = 5;

Returns
Type Description
int

The enum numeric value on the wire for type.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(User other)

public User.Builder mergeFrom(User other)
Parameter
Name Description
other User
Returns
Type Description
User.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public User.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
User.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public User.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
User.Builder
Overrides

setAvatarUrl(String value)

public User.Builder setAvatarUrl(String value)

Output only. The user's avatar image URL.

When calling the Messages and Memberships APIs with user authentication, this field is populated for both internal and external users for the sender of a message, users within annotations (such as user mentions), and within Membership resources, provided the user is a member of the space or has prior affinity with the calling user.

string avatar_url = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The avatarUrl to set.
Returns
Type Description
User.Builder

This builder for chaining.

setAvatarUrlBytes(ByteString value)

public User.Builder setAvatarUrlBytes(ByteString value)

Output only. The user's avatar image URL.

When calling the Messages and Memberships APIs with user authentication, this field is populated for both internal and external users for the sender of a message, users within annotations (such as user mentions), and within Membership resources, provided the user is a member of the space or has prior affinity with the calling user.

string avatar_url = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for avatarUrl to set.
Returns
Type Description
User.Builder

This builder for chaining.

setDisplayName(String value)

public User.Builder setDisplayName(String value)

Output only. The user's display name.

Populated for both app authentication and user authentication. This field is always populated for requests made with app authentication. When calling the Messages and Memberships APIs with user authentication, this field is populated for both internal and external users for the sender of a message, users within annotations (such as user mentions), and within Membership resources, provided the user is a member of the space or has prior affinity with the calling user.

string display_name = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The displayName to set.
Returns
Type Description
User.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public User.Builder setDisplayNameBytes(ByteString value)

Output only. The user's display name.

Populated for both app authentication and user authentication. This field is always populated for requests made with app authentication. When calling the Messages and Memberships APIs with user authentication, this field is populated for both internal and external users for the sender of a message, users within annotations (such as user mentions), and within Membership resources, provided the user is a member of the space or has prior affinity with the calling user.

string display_name = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for displayName to set.
Returns
Type Description
User.Builder

This builder for chaining.

setDomainId(String value)

public User.Builder setDomainId(String value)

Unique identifier of the user's Google Workspace domain.

string domain_id = 6;

Parameter
Name Description
value String

The domainId to set.
Returns
Type Description
User.Builder

This builder for chaining.

setDomainIdBytes(ByteString value)

public User.Builder setDomainIdBytes(ByteString value)

Unique identifier of the user's Google Workspace domain.

string domain_id = 6;

Parameter
Name Description
value ByteString

The bytes for domainId to set.
Returns
Type Description
User.Builder

This builder for chaining.

setEmail(String value)

public User.Builder setEmail(String value)

Output only. The user's email address.

When calling the Messages and Memberships APIs with user authentication, this field is populated for both internal and external users for the sender of a message, users within annotations (such as user mentions), and within Membership resources, provided the user is a member of the space or has prior affinity with the calling user.

string email = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The email to set.
Returns
Type Description
User.Builder

This builder for chaining.

setEmailBytes(ByteString value)

public User.Builder setEmailBytes(ByteString value)

Output only. The user's email address.

When calling the Messages and Memberships APIs with user authentication, this field is populated for both internal and external users for the sender of a message, users within annotations (such as user mentions), and within Membership resources, provided the user is a member of the space or has prior affinity with the calling user.

string email = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for email to set.
Returns
Type Description
User.Builder

This builder for chaining.

setIsAnonymous(boolean value)

public User.Builder setIsAnonymous(boolean value)

Output only. When true, the user is deleted or their profile is not visible, such as when a user is mentioned in a space without being a member and without prior affinity with the calling user.

bool is_anonymous = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value boolean

The isAnonymous to set.
Returns
Type Description
User.Builder

This builder for chaining.

setName(String value)

public User.Builder setName(String value)

Resource name for a Google Chat user.

Format: users/{user}. users/app can be used as an alias for the calling app bot user.

For human users, {user} is the same user identifier as:

  • the id for the Person in the People API. For example, users/123456789 in Chat API represents the same person as the 123456789 Person profile ID in People API.

  • the id for a user in the Admin SDK Directory API.

  • the user's email address can be used as an alias for {user} in API requests. For example, if the People API Person profile ID for user@example.com is 123456789, you can use users/user@example.com as an alias to reference users/123456789. Only the canonical resource name (for example users/123456789) will be returned from the API.

string name = 1;

Parameter
Name Description
value String

The name to set.
Returns
Type Description
User.Builder

This builder for chaining.

setNameBytes(ByteString value)

public User.Builder setNameBytes(ByteString value)

Resource name for a Google Chat user.

Format: users/{user}. users/app can be used as an alias for the calling app bot user.

For human users, {user} is the same user identifier as:

  • the id for the Person in the People API. For example, users/123456789 in Chat API represents the same person as the 123456789 Person profile ID in People API.

  • the id for a user in the Admin SDK Directory API.

  • the user's email address can be used as an alias for {user} in API requests. For example, if the People API Person profile ID for user@example.com is 123456789, you can use users/user@example.com as an alias to reference users/123456789. Only the canonical resource name (for example users/123456789) will be returned from the API.

string name = 1;

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
User.Builder

This builder for chaining.

setType(User.Type value)

public User.Builder setType(User.Type value)

User type.

.google.chat.v1.User.Type type = 5;

Parameter
Name Description
value User.Type

The type to set.
Returns
Type Description
User.Builder

This builder for chaining.

setTypeValue(int value)

public User.Builder setTypeValue(int value)

User type.

.google.chat.v1.User.Type type = 5;

Parameter
Name Description
value int

The enum numeric value on the wire for type to set.
Returns
Type Description
User.Builder

This builder for chaining.