com.google.api.services.directory.model.Group 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.directory.model;
/**
* Google Groups provide your users the ability to send messages to groups of people using the
* group's email address. For more information about common tasks, see the [Developer's Guide
* ](/admin-sdk/directory/v1/guides/manage-groups).
*
* 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 Admin SDK 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 Group extends com.google.api.client.json.GenericJson {
/**
* Read-only. Value is `true` if this group was created by an administrator rather than a user.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.Boolean adminCreated;
/**
* Read-only. A list of a group's alias email addresses. To add, update, or remove a group's
* aliases, use the `groups.aliases` methods. If edited in a group's POST or PUT request, the edit
* is ignored.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.util.List aliases;
/**
* An extended description to help users determine the purpose of a group. For example, you can
* include information about who should join the group, the types of messages to send to the
* group, links to FAQs about the group, or related groups. Maximum length is `4,096` characters.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String description;
/**
* The number of users that are direct members of the group. If a group is a member (child) of
* this group (the parent), members of the child group are not counted in the `directMembersCount`
* property of the parent group.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key @com.google.api.client.json.JsonString
private java.lang.Long directMembersCount;
/**
* The group's email address. If your account has multiple domains, select the appropriate domain
* for the email address. The `email` must be unique. This property is required when creating a
* group. Group email addresses are subject to the same character usage rules as usernames, see
* the [help center](https://support.google.com/a/answer/9193374) for details.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String email;
/**
* ETag of the resource.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String etag;
/**
* Read-only. The unique ID of a group. A group `id` can be used as a group request URI's
* `groupKey`.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String id;
/**
* The type of the API resource. For Groups resources, the value is `admin#directory#group`.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String kind;
/**
* The group's display name.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String name;
/**
* Read-only. A list of the group's non-editable alias email addresses that are outside of the
* account's primary domain or subdomains. These are functioning email addresses used by the
* group. This is a read-only property returned in the API's response for a group. If edited in a
* group's POST or PUT request, the edit is ignored.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.util.List nonEditableAliases;
/**
* Read-only. Value is `true` if this group was created by an administrator rather than a user.
* @return value or {@code null} for none
*/
public java.lang.Boolean getAdminCreated() {
return adminCreated;
}
/**
* Read-only. Value is `true` if this group was created by an administrator rather than a user.
* @param adminCreated adminCreated or {@code null} for none
*/
public Group setAdminCreated(java.lang.Boolean adminCreated) {
this.adminCreated = adminCreated;
return this;
}
/**
* Read-only. A list of a group's alias email addresses. To add, update, or remove a group's
* aliases, use the `groups.aliases` methods. If edited in a group's POST or PUT request, the edit
* is ignored.
* @return value or {@code null} for none
*/
public java.util.List getAliases() {
return aliases;
}
/**
* Read-only. A list of a group's alias email addresses. To add, update, or remove a group's
* aliases, use the `groups.aliases` methods. If edited in a group's POST or PUT request, the edit
* is ignored.
* @param aliases aliases or {@code null} for none
*/
public Group setAliases(java.util.List aliases) {
this.aliases = aliases;
return this;
}
/**
* An extended description to help users determine the purpose of a group. For example, you can
* include information about who should join the group, the types of messages to send to the
* group, links to FAQs about the group, or related groups. Maximum length is `4,096` characters.
* @return value or {@code null} for none
*/
public java.lang.String getDescription() {
return description;
}
/**
* An extended description to help users determine the purpose of a group. For example, you can
* include information about who should join the group, the types of messages to send to the
* group, links to FAQs about the group, or related groups. Maximum length is `4,096` characters.
* @param description description or {@code null} for none
*/
public Group setDescription(java.lang.String description) {
this.description = description;
return this;
}
/**
* The number of users that are direct members of the group. If a group is a member (child) of
* this group (the parent), members of the child group are not counted in the `directMembersCount`
* property of the parent group.
* @return value or {@code null} for none
*/
public java.lang.Long getDirectMembersCount() {
return directMembersCount;
}
/**
* The number of users that are direct members of the group. If a group is a member (child) of
* this group (the parent), members of the child group are not counted in the `directMembersCount`
* property of the parent group.
* @param directMembersCount directMembersCount or {@code null} for none
*/
public Group setDirectMembersCount(java.lang.Long directMembersCount) {
this.directMembersCount = directMembersCount;
return this;
}
/**
* The group's email address. If your account has multiple domains, select the appropriate domain
* for the email address. The `email` must be unique. This property is required when creating a
* group. Group email addresses are subject to the same character usage rules as usernames, see
* the [help center](https://support.google.com/a/answer/9193374) for details.
* @return value or {@code null} for none
*/
public java.lang.String getEmail() {
return email;
}
/**
* The group's email address. If your account has multiple domains, select the appropriate domain
* for the email address. The `email` must be unique. This property is required when creating a
* group. Group email addresses are subject to the same character usage rules as usernames, see
* the [help center](https://support.google.com/a/answer/9193374) for details.
* @param email email or {@code null} for none
*/
public Group setEmail(java.lang.String email) {
this.email = email;
return this;
}
/**
* ETag of the resource.
* @return value or {@code null} for none
*/
public java.lang.String getEtag() {
return etag;
}
/**
* ETag of the resource.
* @param etag etag or {@code null} for none
*/
public Group setEtag(java.lang.String etag) {
this.etag = etag;
return this;
}
/**
* Read-only. The unique ID of a group. A group `id` can be used as a group request URI's
* `groupKey`.
* @return value or {@code null} for none
*/
public java.lang.String getId() {
return id;
}
/**
* Read-only. The unique ID of a group. A group `id` can be used as a group request URI's
* `groupKey`.
* @param id id or {@code null} for none
*/
public Group setId(java.lang.String id) {
this.id = id;
return this;
}
/**
* The type of the API resource. For Groups resources, the value is `admin#directory#group`.
* @return value or {@code null} for none
*/
public java.lang.String getKind() {
return kind;
}
/**
* The type of the API resource. For Groups resources, the value is `admin#directory#group`.
* @param kind kind or {@code null} for none
*/
public Group setKind(java.lang.String kind) {
this.kind = kind;
return this;
}
/**
* The group's display name.
* @return value or {@code null} for none
*/
public java.lang.String getName() {
return name;
}
/**
* The group's display name.
* @param name name or {@code null} for none
*/
public Group setName(java.lang.String name) {
this.name = name;
return this;
}
/**
* Read-only. A list of the group's non-editable alias email addresses that are outside of the
* account's primary domain or subdomains. These are functioning email addresses used by the
* group. This is a read-only property returned in the API's response for a group. If edited in a
* group's POST or PUT request, the edit is ignored.
* @return value or {@code null} for none
*/
public java.util.List getNonEditableAliases() {
return nonEditableAliases;
}
/**
* Read-only. A list of the group's non-editable alias email addresses that are outside of the
* account's primary domain or subdomains. These are functioning email addresses used by the
* group. This is a read-only property returned in the API's response for a group. If edited in a
* group's POST or PUT request, the edit is ignored.
* @param nonEditableAliases nonEditableAliases or {@code null} for none
*/
public Group setNonEditableAliases(java.util.List nonEditableAliases) {
this.nonEditableAliases = nonEditableAliases;
return this;
}
@Override
public Group set(String fieldName, Object value) {
return (Group) super.set(fieldName, value);
}
@Override
public Group clone() {
return (Group) super.clone();
}
}