Class User.Builder (0.7.0)

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

A user in Google Chat. When returned as an output from a request, if your Chat app authenticates as a user , the output for a User resource only populates the user's name and type .

Protobuf type google.chat.v1.User

Implements

UserOrBuilder

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

  public 
  
 User 
 . 
 Builder 
  
 addRepeatedField 
 ( 
 Descriptors 
 . 
 FieldDescriptor 
  
 field 
 , 
  
 Object 
  
 value 
 ) 
 
Parameters
Name
Description
value
Returns
Type
Description
Overrides

build()

  public 
  
 User 
  
 build 
 () 
 
Returns
Type
Description

buildPartial()

  public 
  
 User 
  
 buildPartial 
 () 
 
Returns
Type
Description

clear()

  public 
  
 User 
 . 
 Builder 
  
 clear 
 () 
 
Returns
Type
Description
Overrides

clearDisplayName()

  public 
  
 User 
 . 
 Builder 
  
 clearDisplayName 
 () 
 

Output only. The user's display name.

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

Returns
Type
Description

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

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

  public 
  
 User 
 . 
 Builder 
  
 clearField 
 ( 
 Descriptors 
 . 
 FieldDescriptor 
  
 field 
 ) 
 
Parameter
Name
Description
Returns
Type
Description
Overrides

clearIsAnonymous()

  public 
  
 User 
 . 
 Builder 
  
 clearIsAnonymous 
 () 
 

Output only. When true , the user is deleted or their profile is not visible.

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

Returns
Type
Description

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

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

  public 
  
 User 
 . 
 Builder 
  
 clearOneof 
 ( 
 Descriptors 
 . 
 OneofDescriptor 
  
 oneof 
 ) 
 
Parameter
Name
Description
Returns
Type
Description
Overrides

clearType()

  public 
  
 User 
 . 
 Builder 
  
 clearType 
 () 
 

User type.

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

Returns
Type
Description

This builder for chaining.

clone()

  public 
  
 User 
 . 
 Builder 
  
 clone 
 () 
 
Returns
Type
Description
Overrides

getDefaultInstanceForType()

  public 
  
 User 
  
 getDefaultInstanceForType 
 () 
 
Returns
Type
Description

getDescriptorForType()

  public 
  
 Descriptors 
 . 
 Descriptor 
  
 getDescriptorForType 
 () 
 
Returns
Type
Description
Overrides

getDisplayName()

  public 
  
 String 
  
 getDisplayName 
 () 
 

Output only. The user's display name.

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

Returns
Type
Description

The displayName.

getDisplayNameBytes()

  public 
  
 ByteString 
  
 getDisplayNameBytes 
 () 
 

Output only. The user's display name.

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

Returns
Type
Description

The bytes for displayName.

getDomainId()

  public 
  
 String 
  
 getDomainId 
 () 
 

Unique identifier of the user's Google Workspace domain.

string domain_id = 6;

Returns
Type
Description

The domainId.

getDomainIdBytes()

  public 
  
 ByteString 
  
 getDomainIdBytes 
 () 
 

Unique identifier of the user's Google Workspace domain.

string domain_id = 6;

Returns
Type
Description

The bytes for domainId.

getIsAnonymous()

  public 
  
 boolean 
  
 getIsAnonymous 
 () 
 

Output only. When true , the user is deleted or their profile is not visible.

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

Returns
Type
Description

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

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

The bytes for name.

getType()

  public 
  
 User 
 . 
 Type 
  
 getType 
 () 
 

User type.

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

Returns
Type
Description

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 
  
 GeneratedMessageV3 
 . 
 FieldAccessorTable 
  
 internalGetFieldAccessorTable 
 () 
 
Returns
Type
Description
Overrides

isInitialized()

  public 
  
 final 
  
 boolean 
  
 isInitialized 
 () 
 
Returns
Type
Description
Overrides

mergeFrom(User other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

  public 
  
 final 
  
 User 
 . 
 Builder 
  
 mergeUnknownFields 
 ( 
 UnknownFieldSet 
  
 unknownFields 
 ) 
 
Parameter
Name
Description
unknownFields
Returns
Type
Description
Overrides

setDisplayName(String value)

  public 
  
 User 
 . 
 Builder 
  
 setDisplayName 
 ( 
 String 
  
 value 
 ) 
 

Output only. The user's display name.

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

Parameter
Name
Description
value
String

The displayName to set.

Returns
Type
Description

This builder for chaining.

setDisplayNameBytes(ByteString value)

  public 
  
 User 
 . 
 Builder 
  
 setDisplayNameBytes 
 ( 
 ByteString 
  
 value 
 ) 
 

Output only. The user's display name.

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

Parameter
Name
Description
value
ByteString

The bytes for displayName to set.

Returns
Type
Description

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

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

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

  public 
  
 User 
 . 
 Builder 
  
 setField 
 ( 
 Descriptors 
 . 
 FieldDescriptor 
  
 field 
 , 
  
 Object 
  
 value 
 ) 
 
Parameters
Name
Description
value
Returns
Type
Description
Overrides

setIsAnonymous(boolean value)

  public 
  
 User 
 . 
 Builder 
  
 setIsAnonymous 
 ( 
 boolean 
  
 value 
 ) 
 

Output only. When true , the user is deleted or their profile is not visible.

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

Parameter
Name
Description
value
boolean

The isAnonymous to set.

Returns
Type
Description

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

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

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

  public 
  
 User 
 . 
 Builder 
  
 setRepeatedField 
 ( 
 Descriptors 
 . 
 FieldDescriptor 
  
 field 
 , 
  
 int 
  
 index 
 , 
  
 Object 
  
 value 
 ) 
 
Parameters
Name
Description
index
int
value
Returns
Type
Description
Overrides

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

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

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

  public 
  
 final 
  
 User 
 . 
 Builder 
  
 setUnknownFields 
 ( 
 UnknownFieldSet 
  
 unknownFields 
 ) 
 
Parameter
Name
Description
unknownFields
Returns
Type
Description
Overrides
Design a Mobile Site
View Site in Mobile | Classic
Share by: