com.google.api.services.people.v1.model

Class ContactGroup

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.people.v1.model.ContactGroup

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class ContactGroup
extends com.google.api.client.json.GenericJson

A contact group.

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 People 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

com.google.api.client.util.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
ContactGroup()

Method Summary

Modifier and Type	Method and Description
ContactGroup	clone()
List<GroupClientData>	getClientData() The group's client data.
String	getEtag() The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource.
String	getFormattedName() Output only.
String	getGroupType() Output only.
Integer	getMemberCount() Output only.
List<String>	getMemberResourceNames() Output only.
ContactGroupMetadata	getMetadata() Output only.
String	getName() The contact group name set by the group owner or a system provided name for system groups.
String	getResourceName() The resource name for the contact group, assigned by the server.
ContactGroup	set(String fieldName, Object value)
ContactGroup	setClientData(List<GroupClientData> clientData) The group's client data.
ContactGroup	setEtag(String etag) The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource.
ContactGroup	setFormattedName(String formattedName) Output only.
ContactGroup	setGroupType(String groupType) Output only.
ContactGroup	setMemberCount(Integer memberCount) Output only.
ContactGroup	setMemberResourceNames(List<String> memberResourceNames) Output only.
ContactGroup	setMetadata(ContactGroupMetadata metadata) Output only.
ContactGroup	setName(String name) The contact group name set by the group owner or a system provided name for system groups.
ContactGroup	setResourceName(String resourceName) The resource name for the contact group, assigned by the server.

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

ContactGroup

public ContactGroup()

Method Detail

getClientData

public List<GroupClientData> getClientData()

The group's client data.

Returns:

value or null for none

setClientData

public ContactGroup setClientData(List<GroupClientData> clientData)

The group's client data.

Parameters:

clientData - clientData or null for none

getEtag

public String getEtag()

The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.

Returns:

value or null for none

setEtag

public ContactGroup setEtag(String etag)

The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.

Parameters:

etag - etag or null for none

getFormattedName

public String getFormattedName()

Output only. The name translated and formatted in the viewer's account locale or the `Accept- Language` HTTP header locale for system groups names. Group names set by the owner are the same as name.

Returns:

value or null for none

setFormattedName

public ContactGroup setFormattedName(String formattedName)

Output only. The name translated and formatted in the viewer's account locale or the `Accept- Language` HTTP header locale for system groups names. Group names set by the owner are the same as name.

Parameters:

formattedName - formattedName or null for none

getGroupType

public String getGroupType()

Output only. The contact group type.

Returns:

value or null for none

setGroupType

public ContactGroup setGroupType(String groupType)

Output only. The contact group type.

Parameters:

groupType - groupType or null for none

getMemberCount

public Integer getMemberCount()

Output only. The total number of contacts in the group irrespective of max members in specified in the request.

Returns:

value or null for none

setMemberCount

public ContactGroup setMemberCount(Integer memberCount)

Output only. The total number of contacts in the group irrespective of max members in specified in the request.

Parameters:

memberCount - memberCount or null for none

getMemberResourceNames

public List<String> getMemberResourceNames()

Output only. The list of contact person resource names that are members of the contact group. The field is only populated for GET requests and will only return as many members as `maxMembers` in the get request.

Returns:

value or null for none

setMemberResourceNames

public ContactGroup setMemberResourceNames(List<String> memberResourceNames)

Output only. The list of contact person resource names that are members of the contact group. The field is only populated for GET requests and will only return as many members as `maxMembers` in the get request.

Parameters:

memberResourceNames - memberResourceNames or null for none

getMetadata

public ContactGroupMetadata getMetadata()

Output only. Metadata about the contact group.

Returns:

value or null for none

setMetadata

public ContactGroup setMetadata(ContactGroupMetadata metadata)

Output only. Metadata about the contact group.

Parameters:

metadata - metadata or null for none

getName

public String getName()

The contact group name set by the group owner or a system provided name for system groups. For [`contactGroups.create`](/people/api/rest/v1/contactGroups/create) or [`contactGroups.update`](/people/api/rest/v1/contactGroups/update) the name must be unique to the users contact groups. Attempting to create a group with a duplicate name will return a HTTP 409 error.

Returns:

value or null for none

setName

public ContactGroup setName(String name)

The contact group name set by the group owner or a system provided name for system groups. For [`contactGroups.create`](/people/api/rest/v1/contactGroups/create) or [`contactGroups.update`](/people/api/rest/v1/contactGroups/update) the name must be unique to the users contact groups. Attempting to create a group with a duplicate name will return a HTTP 409 error.

Parameters:

name - name or null for none

getResourceName

public String getResourceName()

The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`.

Returns:

value or null for none

setResourceName

public ContactGroup setResourceName(String resourceName)

The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`.

Parameters:

resourceName - resourceName or null for none

set

public ContactGroup set(String fieldName,
                        Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public ContactGroup clone()

Overrides:

clone in class com.google.api.client.json.GenericJson