com.google.api.services.directory.model

Class Group

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.directory.model.Group

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class Group
extends GenericJson

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.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
Group()

Method Summary

Modifier and Type	Method and Description
Group	clone()
Boolean	getAdminCreated() Value is `true` if this group was created by an administrator rather than a user.
List<String>	getAliases() List of a group's alias email addresses.
String	getDescription() An extended description to help users determine the purpose of a group.
Long	getDirectMembersCount() The number of users that are direct members of the group.
String	getEmail() The group's email address.
String	getEtag() ETag of the resource.
String	getId() The unique ID of a group.
String	getKind() The type of the API resource.
String	getName() The group's display name.
List<String>	getNonEditableAliases() List of the group's non-editable alias email addresses that are outside of the account's primary domain or subdomains.
Group	set(String fieldName, Object value)
Group	setAdminCreated(Boolean adminCreated) Value is `true` if this group was created by an administrator rather than a user.
Group	setAliases(List<String> aliases) List of a group's alias email addresses.
Group	setDescription(String description) An extended description to help users determine the purpose of a group.
Group	setDirectMembersCount(Long directMembersCount) The number of users that are direct members of the group.
Group	setEmail(String email) The group's email address.
Group	setEtag(String etag) ETag of the resource.
Group	setId(String id) The unique ID of a group.
Group	setKind(String kind) The type of the API resource.
Group	setName(String name) The group's display name.
Group	setNonEditableAliases(List<String> nonEditableAliases) List of the group's non-editable alias email addresses that are outside of the account's primary domain or subdomains.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

Group

public Group()

Method Detail

getAdminCreated

public Boolean getAdminCreated()

Value is `true` if this group was created by an administrator rather than a user.

Returns:

value or null for none

setAdminCreated

public Group setAdminCreated(Boolean adminCreated)

Value is `true` if this group was created by an administrator rather than a user.

Parameters:

adminCreated - adminCreated or null for none

getAliases

public List<String> getAliases()

List of a group's alias email addresses.

Returns:

value or null for none

setAliases

public Group setAliases(List<String> aliases)

List of a group's alias email addresses.

Parameters:

aliases - aliases or null for none

getDescription

public String getDescription()

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.

Returns:

value or null for none

setDescription

public Group setDescription(String 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.

Parameters:

description - description or null for none

getDirectMembersCount

public Long getDirectMembersCount()

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.

Returns:

value or null for none

setDirectMembersCount

public Group setDirectMembersCount(Long 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.

Parameters:

directMembersCount - directMembersCount or null for none

getEmail

public String getEmail()

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.

Returns:

value or null for none

setEmail

public Group setEmail(String 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.

Parameters:

email - email or null for none

getEtag

public String getEtag()

ETag of the resource.

Returns:

value or null for none

setEtag

public Group setEtag(String etag)

ETag of the resource.

Parameters:

etag - etag or null for none

getId

public String getId()

The unique ID of a group. A group `id` can be used as a group request URI's `groupKey`.

Returns:

value or null for none

setId

public Group setId(String id)

The unique ID of a group. A group `id` can be used as a group request URI's `groupKey`.

Parameters:

id - id or null for none

getKind

public String getKind()

The type of the API resource. For Groups resources, the value is `admin#directory#group`.

Returns:

value or null for none

setKind

public Group setKind(String kind)

The type of the API resource. For Groups resources, the value is `admin#directory#group`.

Parameters:

kind - kind or null for none

getName

public String getName()

The group's display name.

Returns:

value or null for none

setName

public Group setName(String name)

The group's display name.

Parameters:

name - name or null for none

getNonEditableAliases

public List<String> getNonEditableAliases()

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 by the API service.

Returns:

value or null for none

setNonEditableAliases

public Group setNonEditableAliases(List<String> nonEditableAliases)

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 by the API service.

Parameters:

nonEditableAliases - nonEditableAliases or null for none

set

public Group set(String fieldName,
                 Object value)

Overrides:

set in class GenericJson

clone

public Group clone()

Overrides:

clone in class GenericJson