public final class User extends GeneratedMessageV3 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
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > UserImplements
UserOrBuilderStatic Fields
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
DOMAIN_ID_FIELD_NUMBER
public static final int DOMAIN_ID_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
IS_ANONYMOUS_FIELD_NUMBER
public static final int IS_ANONYMOUS_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
TYPE_FIELD_NUMBER
public static final int TYPE_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
Static Methods
getDefaultInstance()
public static User getDefaultInstance()
Returns | |
---|---|
Type | Description |
User |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
newBuilder()
public static User.Builder newBuilder()
Returns | |
---|---|
Type | Description |
User.Builder |
newBuilder(User prototype)
public static User.Builder newBuilder(User prototype)
Parameter | |
---|---|
Name | Description |
prototype | User |
Returns | |
---|---|
Type | Description |
User.Builder |
parseDelimitedFrom(InputStream input)
public static User parseDelimitedFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input | InputStream |
Returns | |
---|---|
Type | Description |
User |
Exceptions | |
---|---|
Type | Description |
IOException |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static User parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
User |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(byte[] data)
public static User parseFrom(byte[] data)
Parameter | |
---|---|
Name | Description |
data | byte[] |
Returns | |
---|---|
Type | Description |
User |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static User parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data | byte[] |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
User |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data)
public static User parseFrom(ByteString data)
Parameter | |
---|---|
Name | Description |
data | ByteString |
Returns | |
---|---|
Type | Description |
User |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static User parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data | ByteString |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
User |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
public static User parseFrom(CodedInputStream input)
Parameter | |
---|---|
Name | Description |
input | CodedInputStream |
Returns | |
---|---|
Type | Description |
User |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static User parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
User |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input)
public static User parseFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input | InputStream |
Returns | |
---|---|
Type | Description |
User |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static User parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
User |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(ByteBuffer data)
public static User parseFrom(ByteBuffer data)
Parameter | |
---|---|
Name | Description |
data | ByteBuffer |
Returns | |
---|---|
Type | Description |
User |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static User parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data | ByteBuffer |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
User |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parser()
public static Parser<User> parser()
Returns | |
---|---|
Type | Description |
Parser<User> |
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter | |
---|---|
Name | Description |
obj | Object |
Returns | |
---|---|
Type | Description |
boolean |
getDefaultInstanceForType()
public User getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
User |
getDisplayName()
public String getDisplayName()
Output only. The user's display name.
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.
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. |
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 |
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 the123456789
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 foruser@example.com
is123456789
, you can useusers/user@example.com
as an alias to referenceusers/123456789
. Only the canonical resource name (for exampleusers/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 the123456789
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 foruser@example.com
is123456789
, you can useusers/user@example.com
as an alias to referenceusers/123456789
. Only the canonical resource name (for exampleusers/123456789
) will be returned from the API.
string name = 1;
Returns | |
---|---|
Type | Description |
ByteString | The bytes for name. |
getParserForType()
public Parser<User> getParserForType()
Returns | |
---|---|
Type | Description |
Parser<User> |
getSerializedSize()
public int getSerializedSize()
Returns | |
---|---|
Type | Description |
int |
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. |
hashCode()
public int hashCode()
Returns | |
---|---|
Type | Description |
int |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
newBuilderForType()
public User.Builder newBuilderForType()
Returns | |
---|---|
Type | Description |
User.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected User.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter | |
---|---|
Name | Description |
parent | BuilderParent |
Returns | |
---|---|
Type | Description |
User.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter | |
---|---|
Name | Description |
unused | UnusedPrivateParameter |
Returns | |
---|---|
Type | Description |
Object |
toBuilder()
public User.Builder toBuilder()
Returns | |
---|---|
Type | Description |
User.Builder |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter | |
---|---|
Name | Description |
output | CodedOutputStream |
Exceptions | |
---|---|
Type | Description |
IOException |