com.google.api.services.chat.v1.model.User Maven / Gradle / Ivy
/*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
* in compliance with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under the License
* is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
* or implied. See the License for the specific language governing permissions and limitations under
* the License.
*/
/*
* This code was generated by https://github.com/googleapis/google-api-java-client-services/
* Modify at your own risk.
*/
package com.google.api.services.chat.v1.model;
/**
* A user in Google Chat. When returned as an output from a request, if your Chat app [authenticates
* as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the
* output for a `User` resource only populates the user's `name` and `type`.
*
* This is the Java data model class that specifies how to parse/serialize into the JSON that is
* transmitted over HTTP when working with the Google Chat API. For a detailed explanation see:
* https://developers.google.com/api-client-library/java/google-http-java-client/json
*
*
* @author Google, Inc.
*/
@SuppressWarnings("javadoc")
public final class User extends com.google.api.client.json.GenericJson {
/**
* Output only. The user's display name.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String displayName;
/**
* Unique identifier of the user's Google Workspace domain.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String domainId;
/**
* Output only. When `true`, the user is deleted or their profile is not visible.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.Boolean isAnonymous;
/**
* 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](https://developers.google.com/people/api/rest/v1/people) 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](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) 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 `[email protected]` is
* `123456789`, you can use `users/[email protected]` as an alias to reference `users/123456789`.
* Only the canonical resource name (for example `users/123456789`) will be returned from the API.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String name;
/**
* User type.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String type;
/**
* Output only. The user's display name.
* @return value or {@code null} for none
*/
public java.lang.String getDisplayName() {
return displayName;
}
/**
* Output only. The user's display name.
* @param displayName displayName or {@code null} for none
*/
public User setDisplayName(java.lang.String displayName) {
this.displayName = displayName;
return this;
}
/**
* Unique identifier of the user's Google Workspace domain.
* @return value or {@code null} for none
*/
public java.lang.String getDomainId() {
return domainId;
}
/**
* Unique identifier of the user's Google Workspace domain.
* @param domainId domainId or {@code null} for none
*/
public User setDomainId(java.lang.String domainId) {
this.domainId = domainId;
return this;
}
/**
* Output only. When `true`, the user is deleted or their profile is not visible.
* @return value or {@code null} for none
*/
public java.lang.Boolean getIsAnonymous() {
return isAnonymous;
}
/**
* Output only. When `true`, the user is deleted or their profile is not visible.
* @param isAnonymous isAnonymous or {@code null} for none
*/
public User setIsAnonymous(java.lang.Boolean isAnonymous) {
this.isAnonymous = isAnonymous;
return this;
}
/**
* 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](https://developers.google.com/people/api/rest/v1/people) 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](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) 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 `[email protected]` is
* `123456789`, you can use `users/[email protected]` as an alias to reference `users/123456789`.
* Only the canonical resource name (for example `users/123456789`) will be returned from the API.
* @return value or {@code null} for none
*/
public java.lang.String getName() {
return name;
}
/**
* 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](https://developers.google.com/people/api/rest/v1/people) 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](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) 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 `[email protected]` is
* `123456789`, you can use `users/[email protected]` as an alias to reference `users/123456789`.
* Only the canonical resource name (for example `users/123456789`) will be returned from the API.
* @param name name or {@code null} for none
*/
public User setName(java.lang.String name) {
this.name = name;
return this;
}
/**
* User type.
* @return value or {@code null} for none
*/
public java.lang.String getType() {
return type;
}
/**
* User type.
* @param type type or {@code null} for none
*/
public User setType(java.lang.String type) {
this.type = type;
return this;
}
@Override
public User set(String fieldName, Object value) {
return (User) super.set(fieldName, value);
}
@Override
public User clone() {
return (User) super.clone();
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy