Person (People API v1-rev20251117-2.0.0)

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.Person

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class Person
extends com.google.api.client.json.GenericJson
```
Information about a person merged from various data sources such as the authenticated user's contacts and profile data. Most fields can have multiple items. The items in a field have no guaranteed order, but each non-empty field is guaranteed to have exactly one field with `metadata.primary` set to true.
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

Person()

Constructors
Constructor and Description
`Person()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Person`	`clone()`
`List<Address>`	`getAddresses()` The person's street addresses.
`String`	`getAgeRange()` Output only.
`List<AgeRangeType>`	`getAgeRanges()` Output only.
`List<Biography>`	`getBiographies()` The person's biographies.
`List<Birthday>`	`getBirthdays()` The person's birthdays.
`List<BraggingRights>`	`getBraggingRights()` DEPRECATED: No data will be returned The person's bragging rights.
`List<CalendarUrl>`	`getCalendarUrls()` The person's calendar URLs.
`List<ClientData>`	`getClientData()` The person's client data.
`List<CoverPhoto>`	`getCoverPhotos()` Output only.
`List<EmailAddress>`	`getEmailAddresses()` The person's email addresses.
`String`	`getEtag()` The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource.
`List<Event>`	`getEvents()` The person's events.
`List<ExternalId>`	`getExternalIds()` The person's external IDs.
`List<FileAs>`	`getFileAses()` The person's file-ases.
`List<Gender>`	`getGenders()` The person's genders.
`List<ImClient>`	`getImClients()` The person's instant messaging clients.
`List<Interest>`	`getInterests()` The person's interests.
`List<Locale>`	`getLocales()` The person's locale preferences.
`List<Location>`	`getLocations()` The person's locations.
`List<Membership>`	`getMemberships()` The person's group memberships.
`PersonMetadata`	`getMetadata()` Output only.
`List<MiscKeyword>`	`getMiscKeywords()` The person's miscellaneous keywords.
`List<Name>`	`getNames()` The person's names.
`List<Nickname>`	`getNicknames()` The person's nicknames.
`List<Occupation>`	`getOccupations()` The person's occupations.
`List<Organization>`	`getOrganizations()` The person's past or current organizations.
`List<PhoneNumber>`	`getPhoneNumbers()` The person's phone numbers.
`List<Photo>`	`getPhotos()` Output only.
`List<Relation>`	`getRelations()` The person's relations.
`List<RelationshipInterest>`	`getRelationshipInterests()` Output only.
`List<RelationshipStatus>`	`getRelationshipStatuses()` Output only.
`List<Residence>`	`getResidences()` DEPRECATED: (Please use `person.locations` instead) The person's residences.
`String`	`getResourceName()` The resource name for the person, assigned by the server.
`List<SipAddress>`	`getSipAddresses()` The person's SIP addresses.
`List<Skill>`	`getSkills()` The person's skills.
`List<Tagline>`	`getTaglines()` Output only.
`List<Url>`	`getUrls()` The person's associated URLs.
`List<UserDefined>`	`getUserDefined()` The person's user defined data.
`Person`	`set(String fieldName, Object value)`
`Person`	`setAddresses(List<Address> addresses)` The person's street addresses.
`Person`	`setAgeRange(String ageRange)` Output only.
`Person`	`setAgeRanges(List<AgeRangeType> ageRanges)` Output only.
`Person`	`setBiographies(List<Biography> biographies)` The person's biographies.
`Person`	`setBirthdays(List<Birthday> birthdays)` The person's birthdays.
`Person`	`setBraggingRights(List<BraggingRights> braggingRights)` DEPRECATED: No data will be returned The person's bragging rights.
`Person`	`setCalendarUrls(List<CalendarUrl> calendarUrls)` The person's calendar URLs.
`Person`	`setClientData(List<ClientData> clientData)` The person's client data.
`Person`	`setCoverPhotos(List<CoverPhoto> coverPhotos)` Output only.
`Person`	`setEmailAddresses(List<EmailAddress> emailAddresses)` The person's email addresses.
`Person`	`setEtag(String etag)` The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource.
`Person`	`setEvents(List<Event> events)` The person's events.
`Person`	`setExternalIds(List<ExternalId> externalIds)` The person's external IDs.
`Person`	`setFileAses(List<FileAs> fileAses)` The person's file-ases.
`Person`	`setGenders(List<Gender> genders)` The person's genders.
`Person`	`setImClients(List<ImClient> imClients)` The person's instant messaging clients.
`Person`	`setInterests(List<Interest> interests)` The person's interests.
`Person`	`setLocales(List<Locale> locales)` The person's locale preferences.
`Person`	`setLocations(List<Location> locations)` The person's locations.
`Person`	`setMemberships(List<Membership> memberships)` The person's group memberships.
`Person`	`setMetadata(PersonMetadata metadata)` Output only.
`Person`	`setMiscKeywords(List<MiscKeyword> miscKeywords)` The person's miscellaneous keywords.
`Person`	`setNames(List<Name> names)` The person's names.
`Person`	`setNicknames(List<Nickname> nicknames)` The person's nicknames.
`Person`	`setOccupations(List<Occupation> occupations)` The person's occupations.
`Person`	`setOrganizations(List<Organization> organizations)` The person's past or current organizations.
`Person`	`setPhoneNumbers(List<PhoneNumber> phoneNumbers)` The person's phone numbers.
`Person`	`setPhotos(List<Photo> photos)` Output only.
`Person`	`setRelations(List<Relation> relations)` The person's relations.
`Person`	`setRelationshipInterests(List<RelationshipInterest> relationshipInterests)` Output only.
`Person`	`setRelationshipStatuses(List<RelationshipStatus> relationshipStatuses)` Output only.
`Person`	`setResidences(List<Residence> residences)` DEPRECATED: (Please use `person.locations` instead) The person's residences.
`Person`	`setResourceName(String resourceName)` The resource name for the person, assigned by the server.
`Person`	`setSipAddresses(List<SipAddress> sipAddresses)` The person's SIP addresses.
`Person`	`setSkills(List<Skill> skills)` The person's skills.
`Person`	`setTaglines(List<Tagline> taglines)` Output only.
`Person`	`setUrls(List<Url> urls)` The person's associated URLs.
`Person`	`setUserDefined(List<UserDefined> userDefined)` The person's user defined data.

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
  - Person
```
public Person()
```
- Method Detail
  - getAddresses
```
public List<Address> getAddresses()
```
    The person's street addresses.
    
    Returns:
    
    value or null for none
  - setAddresses
```
public Person setAddresses(List<Address> addresses)
```
    The person's street addresses.
    
    Parameters:
    
    addresses - addresses or null for none
  - getAgeRange
```
public String getAgeRange()
```
    Output only. **DEPRECATED** (Please use `person.ageRanges` instead) The person's age range.
    
    Returns:
    
    value or null for none
  - setAgeRange
```
public Person setAgeRange(String ageRange)
```
    Output only. **DEPRECATED** (Please use `person.ageRanges` instead) The person's age range.
    
    Parameters:
    
    ageRange - ageRange or null for none
  - getAgeRanges
```
public List<AgeRangeType> getAgeRanges()
```
    Output only. The person's age ranges.
    
    Returns:
    
    value or null for none
  - setAgeRanges
```
public Person setAgeRanges(List<AgeRangeType> ageRanges)
```
    Output only. The person's age ranges.
    
    Parameters:
    
    ageRanges - ageRanges or null for none
  - getBiographies
```
public List<Biography> getBiographies()
```
    The person's biographies. This field is a singleton for contact sources.
    
    Returns:
    
    value or null for none
  - setBiographies
```
public Person setBiographies(List<Biography> biographies)
```
    The person's biographies. This field is a singleton for contact sources.
    
    Parameters:
    
    biographies - biographies or null for none
  - getBirthdays
```
public List<Birthday> getBirthdays()
```
    The person's birthdays. This field is a singleton for contact sources.
    
    Returns:
    
    value or null for none
  - setBirthdays
```
public Person setBirthdays(List<Birthday> birthdays)
```
    The person's birthdays. This field is a singleton for contact sources.
    
    Parameters:
    
    birthdays - birthdays or null for none
  - getBraggingRights
```
public List<BraggingRights> getBraggingRights()
```
    **DEPRECATED**: No data will be returned The person's bragging rights.
    
    Returns:
    
    value or null for none
  - setBraggingRights
```
public Person setBraggingRights(List<BraggingRights> braggingRights)
```
    **DEPRECATED**: No data will be returned The person's bragging rights.
    
    Parameters:
    
    braggingRights - braggingRights or null for none
  - getCalendarUrls
```
public List<CalendarUrl> getCalendarUrls()
```
    The person's calendar URLs.
    
    Returns:
    
    value or null for none
  - setCalendarUrls
```
public Person setCalendarUrls(List<CalendarUrl> calendarUrls)
```
    The person's calendar URLs.
    
    Parameters:
    
    calendarUrls - calendarUrls or null for none
  - getClientData
```
public List<ClientData> getClientData()
```
    The person's client data.
    
    Returns:
    
    value or null for none
  - setClientData
```
public Person setClientData(List<ClientData> clientData)
```
    The person's client data.
    
    Parameters:
    
    clientData - clientData or null for none
  - getCoverPhotos
```
public List<CoverPhoto> getCoverPhotos()
```
    Output only. The person's cover photos.
    
    Returns:
    
    value or null for none
  - setCoverPhotos
```
public Person setCoverPhotos(List<CoverPhoto> coverPhotos)
```
    Output only. The person's cover photos.
    
    Parameters:
    
    coverPhotos - coverPhotos or null for none
  - getEmailAddresses
```
public List<EmailAddress> getEmailAddresses()
```
    The person's email addresses. For `people.connections.list` and `otherContacts.list` the number of email addresses is limited to 100. If a Person has more email addresses the entire set can be obtained by calling GetPeople.
    
    Returns:
    
    value or null for none
  - setEmailAddresses
```
public Person setEmailAddresses(List<EmailAddress> emailAddresses)
```
    The person's email addresses. For `people.connections.list` and `otherContacts.list` the number of email addresses is limited to 100. If a Person has more email addresses the entire set can be obtained by calling GetPeople.
    
    Parameters:
    
    emailAddresses - emailAddresses 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 Person 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
  - getEvents
```
public List<Event> getEvents()
```
    The person's events.
    
    Returns:
    
    value or null for none
  - setEvents
```
public Person setEvents(List<Event> events)
```
    The person's events.
    
    Parameters:
    
    events - events or null for none
  - getExternalIds
```
public List<ExternalId> getExternalIds()
```
    The person's external IDs.
    
    Returns:
    
    value or null for none
  - setExternalIds
```
public Person setExternalIds(List<ExternalId> externalIds)
```
    The person's external IDs.
    
    Parameters:
    
    externalIds - externalIds or null for none
  - getFileAses
```
public List<FileAs> getFileAses()
```
    The person's file-ases.
    
    Returns:
    
    value or null for none
  - setFileAses
```
public Person setFileAses(List<FileAs> fileAses)
```
    The person's file-ases.
    
    Parameters:
    
    fileAses - fileAses or null for none
  - getGenders
```
public List<Gender> getGenders()
```
    The person's genders. This field is a singleton for contact sources.
    
    Returns:
    
    value or null for none
  - setGenders
```
public Person setGenders(List<Gender> genders)
```
    The person's genders. This field is a singleton for contact sources.
    
    Parameters:
    
    genders - genders or null for none
  - getImClients
```
public List<ImClient> getImClients()
```
    The person's instant messaging clients.
    
    Returns:
    
    value or null for none
  - setImClients
```
public Person setImClients(List<ImClient> imClients)
```
    The person's instant messaging clients.
    
    Parameters:
    
    imClients - imClients or null for none
  - getInterests
```
public List<Interest> getInterests()
```
    The person's interests.
    
    Returns:
    
    value or null for none
  - setInterests
```
public Person setInterests(List<Interest> interests)
```
    The person's interests.
    
    Parameters:
    
    interests - interests or null for none
  - getLocales
```
public List<Locale> getLocales()
```
    The person's locale preferences.
    
    Returns:
    
    value or null for none
  - setLocales
```
public Person setLocales(List<Locale> locales)
```
    The person's locale preferences.
    
    Parameters:
    
    locales - locales or null for none
  - getLocations
```
public List<Location> getLocations()
```
    The person's locations.
    
    Returns:
    
    value or null for none
  - setLocations
```
public Person setLocations(List<Location> locations)
```
    The person's locations.
    
    Parameters:
    
    locations - locations or null for none
  - getMemberships
```
public List<Membership> getMemberships()
```
    The person's group memberships.
    
    Returns:
    
    value or null for none
  - setMemberships
```
public Person setMemberships(List<Membership> memberships)
```
    The person's group memberships.
    
    Parameters:
    
    memberships - memberships or null for none
  - getMetadata
```
public PersonMetadata getMetadata()
```
    Output only. Metadata about the person.
    
    Returns:
    
    value or null for none
  - setMetadata
```
public Person setMetadata(PersonMetadata metadata)
```
    Output only. Metadata about the person.
    
    Parameters:
    
    metadata - metadata or null for none
  - getMiscKeywords
```
public List<MiscKeyword> getMiscKeywords()
```
    The person's miscellaneous keywords.
    
    Returns:
    
    value or null for none
  - setMiscKeywords
```
public Person setMiscKeywords(List<MiscKeyword> miscKeywords)
```
    The person's miscellaneous keywords.
    
    Parameters:
    
    miscKeywords - miscKeywords or null for none
  - getNames
```
public List<Name> getNames()
```
    The person's names. This field is a singleton for contact sources.
    
    Returns:
    
    value or null for none
  - setNames
```
public Person setNames(List<Name> names)
```
    The person's names. This field is a singleton for contact sources.
    
    Parameters:
    
    names - names or null for none
  - getNicknames
```
public List<Nickname> getNicknames()
```
    The person's nicknames.
    
    Returns:
    
    value or null for none
  - setNicknames
```
public Person setNicknames(List<Nickname> nicknames)
```
    The person's nicknames.
    
    Parameters:
    
    nicknames - nicknames or null for none
  - getOccupations
```
public List<Occupation> getOccupations()
```
    The person's occupations.
    
    Returns:
    
    value or null for none
  - setOccupations
```
public Person setOccupations(List<Occupation> occupations)
```
    The person's occupations.
    
    Parameters:
    
    occupations - occupations or null for none
  - getOrganizations
```
public List<Organization> getOrganizations()
```
    The person's past or current organizations.
    
    Returns:
    
    value or null for none
  - setOrganizations
```
public Person setOrganizations(List<Organization> organizations)
```
    The person's past or current organizations.
    
    Parameters:
    
    organizations - organizations or null for none
  - getPhoneNumbers
```
public List<PhoneNumber> getPhoneNumbers()
```
    The person's phone numbers. For `people.connections.list` and `otherContacts.list` the number of phone numbers is limited to 100. If a Person has more phone numbers the entire set can be obtained by calling GetPeople.
    
    Returns:
    
    value or null for none
  - setPhoneNumbers
```
public Person setPhoneNumbers(List<PhoneNumber> phoneNumbers)
```
    The person's phone numbers. For `people.connections.list` and `otherContacts.list` the number of phone numbers is limited to 100. If a Person has more phone numbers the entire set can be obtained by calling GetPeople.
    
    Parameters:
    
    phoneNumbers - phoneNumbers or null for none
  - getPhotos
```
public List<Photo> getPhotos()
```
    Output only. The person's photos.
    
    Returns:
    
    value or null for none
  - setPhotos
```
public Person setPhotos(List<Photo> photos)
```
    Output only. The person's photos.
    
    Parameters:
    
    photos - photos or null for none
  - getRelations
```
public List<Relation> getRelations()
```
    The person's relations.
    
    Returns:
    
    value or null for none
  - setRelations
```
public Person setRelations(List<Relation> relations)
```
    The person's relations.
    
    Parameters:
    
    relations - relations or null for none
  - getRelationshipInterests
```
public List<RelationshipInterest> getRelationshipInterests()
```
    Output only. **DEPRECATED**: No data will be returned The person's relationship interests.
    
    Returns:
    
    value or null for none
  - setRelationshipInterests
```
public Person setRelationshipInterests(List<RelationshipInterest> relationshipInterests)
```
    Output only. **DEPRECATED**: No data will be returned The person's relationship interests.
    
    Parameters:
    
    relationshipInterests - relationshipInterests or null for none
  - getRelationshipStatuses
```
public List<RelationshipStatus> getRelationshipStatuses()
```
    Output only. **DEPRECATED**: No data will be returned The person's relationship statuses.
    
    Returns:
    
    value or null for none
  - setRelationshipStatuses
```
public Person setRelationshipStatuses(List<RelationshipStatus> relationshipStatuses)
```
    Output only. **DEPRECATED**: No data will be returned The person's relationship statuses.
    
    Parameters:
    
    relationshipStatuses - relationshipStatuses or null for none
  - getResidences
```
public List<Residence> getResidences()
```
    **DEPRECATED**: (Please use `person.locations` instead) The person's residences.
    
    Returns:
    
    value or null for none
  - setResidences
```
public Person setResidences(List<Residence> residences)
```
    **DEPRECATED**: (Please use `person.locations` instead) The person's residences.
    
    Parameters:
    
    residences - residences or null for none
  - getResourceName
```
public String getResourceName()
```
    The resource name for the person, assigned by the server. An ASCII string in the form of `people/{person_id}`.
    
    Returns:
    
    value or null for none
  - setResourceName
```
public Person setResourceName(String resourceName)
```
    The resource name for the person, assigned by the server. An ASCII string in the form of `people/{person_id}`.
    
    Parameters:
    
    resourceName - resourceName or null for none
  - getSipAddresses
```
public List<SipAddress> getSipAddresses()
```
    The person's SIP addresses.
    
    Returns:
    
    value or null for none
  - setSipAddresses
```
public Person setSipAddresses(List<SipAddress> sipAddresses)
```
    The person's SIP addresses.
    
    Parameters:
    
    sipAddresses - sipAddresses or null for none
  - getSkills
```
public List<Skill> getSkills()
```
    The person's skills.
    
    Returns:
    
    value or null for none
  - setSkills
```
public Person setSkills(List<Skill> skills)
```
    The person's skills.
    
    Parameters:
    
    skills - skills or null for none
  - getTaglines
```
public List<Tagline> getTaglines()
```
    Output only. **DEPRECATED**: No data will be returned The person's taglines.
    
    Returns:
    
    value or null for none
  - setTaglines
```
public Person setTaglines(List<Tagline> taglines)
```
    Output only. **DEPRECATED**: No data will be returned The person's taglines.
    
    Parameters:
    
    taglines - taglines or null for none
  - getUrls
```
public List<Url> getUrls()
```
    The person's associated URLs.
    
    Returns:
    
    value or null for none
  - setUrls
```
public Person setUrls(List<Url> urls)
```
    The person's associated URLs.
    
    Parameters:
    
    urls - urls or null for none
  - getUserDefined
```
public List<UserDefined> getUserDefined()
```
    The person's user defined data.
    
    Returns:
    
    value or null for none
  - setUserDefined
```
public Person setUserDefined(List<UserDefined> userDefined)
```
    The person's user defined data.
    
    Parameters:
    
    userDefined - userDefined or null for none
  - set
```
public Person set(String fieldName,
                  Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public Person clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class Person

Nested Class Summary

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

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

Person

Method Detail

getAddresses

setAddresses

getAgeRange

setAgeRange

getAgeRanges

setAgeRanges

getBiographies

setBiographies

getBirthdays

setBirthdays

getBraggingRights

setBraggingRights

getCalendarUrls

setCalendarUrls

getClientData

setClientData

getCoverPhotos

setCoverPhotos

getEmailAddresses

setEmailAddresses

getEtag

setEtag

getEvents

setEvents

getExternalIds

setExternalIds

getFileAses

setFileAses

getGenders

setGenders

getImClients

setImClients

getInterests

setInterests

getLocales

setLocales

getLocations

setLocations

getMemberships

setMemberships

getMetadata

setMetadata

getMiscKeywords

setMiscKeywords

getNames

setNames

getNicknames

setNicknames

getOccupations

setOccupations

getOrganizations

setOrganizations

getPhoneNumbers

setPhoneNumbers

getPhotos

setPhotos

getRelations

setRelations

getRelationshipInterests

setRelationshipInterests

getRelationshipStatuses

setRelationshipStatuses

getResidences

setResidences

getResourceName