Person (People API v1 (Rev. 543) 1.25.0)

java.lang.Object
- java.util.AbstractMap<java.lang.String,java.lang.Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.people.v1.model.Person

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.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
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.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()`
`java.util.List<Address>`	`getAddresses()` The person's street addresses.
`java.lang.String`	`getAgeRange()` Output only.
`java.util.List<AgeRangeType>`	`getAgeRanges()` Output only.
`java.util.List<Biography>`	`getBiographies()` The person's biographies.
`java.util.List<Birthday>`	`getBirthdays()` The person's birthdays.
`java.util.List<BraggingRights>`	`getBraggingRights()` DEPRECATED: No data will be returned The person's bragging rights.
`java.util.List<CoverPhoto>`	`getCoverPhotos()` Output only.
`java.util.List<EmailAddress>`	`getEmailAddresses()` The person's email addresses.
`java.lang.String`	`getEtag()` The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource.
`java.util.List<Event>`	`getEvents()` The person's events.
`java.util.List<Gender>`	`getGenders()` The person's genders.
`java.util.List<ImClient>`	`getImClients()` The person's instant messaging clients.
`java.util.List<Interest>`	`getInterests()` The person's interests.
`java.util.List<Locale>`	`getLocales()` The person's locale preferences.
`java.util.List<Membership>`	`getMemberships()` The person's group memberships.
`PersonMetadata`	`getMetadata()` Output only.
`java.util.List<Name>`	`getNames()` The person's names.
`java.util.List<Nickname>`	`getNicknames()` The person's nicknames.
`java.util.List<Occupation>`	`getOccupations()` The person's occupations.
`java.util.List<Organization>`	`getOrganizations()` The person's past or current organizations.
`java.util.List<PhoneNumber>`	`getPhoneNumbers()` The person's phone numbers.
`java.util.List<Photo>`	`getPhotos()` Output only.
`java.util.List<Relation>`	`getRelations()` The person's relations.
`java.util.List<RelationshipInterest>`	`getRelationshipInterests()` Output only.
`java.util.List<RelationshipStatus>`	`getRelationshipStatuses()` Output only.
`java.util.List<Residence>`	`getResidences()` The person's residences.
`java.lang.String`	`getResourceName()` The resource name for the person, assigned by the server.
`java.util.List<SipAddress>`	`getSipAddresses()` The person's SIP addresses.
`java.util.List<Skill>`	`getSkills()` The person's skills.
`java.util.List<Tagline>`	`getTaglines()` Output only.
`java.util.List<Url>`	`getUrls()` The person's associated URLs.
`java.util.List<UserDefined>`	`getUserDefined()` The person's user defined data.
`Person`	`set(java.lang.String fieldName, java.lang.Object value)`
`Person`	`setAddresses(java.util.List<Address> addresses)` The person's street addresses.
`Person`	`setAgeRange(java.lang.String ageRange)` Output only.
`Person`	`setAgeRanges(java.util.List<AgeRangeType> ageRanges)` Output only.
`Person`	`setBiographies(java.util.List<Biography> biographies)` The person's biographies.
`Person`	`setBirthdays(java.util.List<Birthday> birthdays)` The person's birthdays.
`Person`	`setBraggingRights(java.util.List<BraggingRights> braggingRights)` DEPRECATED: No data will be returned The person's bragging rights.
`Person`	`setCoverPhotos(java.util.List<CoverPhoto> coverPhotos)` Output only.
`Person`	`setEmailAddresses(java.util.List<EmailAddress> emailAddresses)` The person's email addresses.
`Person`	`setEtag(java.lang.String etag)` The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource.
`Person`	`setEvents(java.util.List<Event> events)` The person's events.
`Person`	`setGenders(java.util.List<Gender> genders)` The person's genders.
`Person`	`setImClients(java.util.List<ImClient> imClients)` The person's instant messaging clients.
`Person`	`setInterests(java.util.List<Interest> interests)` The person's interests.
`Person`	`setLocales(java.util.List<Locale> locales)` The person's locale preferences.
`Person`	`setMemberships(java.util.List<Membership> memberships)` The person's group memberships.
`Person`	`setMetadata(PersonMetadata metadata)` Output only.
`Person`	`setNames(java.util.List<Name> names)` The person's names.
`Person`	`setNicknames(java.util.List<Nickname> nicknames)` The person's nicknames.
`Person`	`setOccupations(java.util.List<Occupation> occupations)` The person's occupations.
`Person`	`setOrganizations(java.util.List<Organization> organizations)` The person's past or current organizations.
`Person`	`setPhoneNumbers(java.util.List<PhoneNumber> phoneNumbers)` The person's phone numbers.
`Person`	`setPhotos(java.util.List<Photo> photos)` Output only.
`Person`	`setRelations(java.util.List<Relation> relations)` The person's relations.
`Person`	`setRelationshipInterests(java.util.List<RelationshipInterest> relationshipInterests)` Output only.
`Person`	`setRelationshipStatuses(java.util.List<RelationshipStatus> relationshipStatuses)` Output only.
`Person`	`setResidences(java.util.List<Residence> residences)` The person's residences.
`Person`	`setResourceName(java.lang.String resourceName)` The resource name for the person, assigned by the server.
`Person`	`setSipAddresses(java.util.List<SipAddress> sipAddresses)` The person's SIP addresses.
`Person`	`setSkills(java.util.List<Skill> skills)` The person's skills.
`Person`	`setTaglines(java.util.List<Tagline> taglines)` Output only.
`Person`	`setUrls(java.util.List<Url> urls)` The person's associated URLs.
`Person`	`setUserDefined(java.util.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, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, 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 java.util.List<Address> getAddresses()
```
    The person's street addresses.
    
    Returns:
    
    value or null for none
  - setAddresses
```
public Person setAddresses(java.util.List<Address> addresses)
```
    The person's street addresses.
    
    Parameters:
    
    addresses - addresses or null for none
  - getAgeRange
```
public java.lang.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(java.lang.String ageRange)
```
    Output only. **DEPRECATED** (Please use `person.ageRanges` instead) The person's age range.
    
    Parameters:
    
    ageRange - ageRange or null for none
  - getAgeRanges
```
public java.util.List<AgeRangeType> getAgeRanges()
```
    Output only. The person's age ranges.
    
    Returns:
    
    value or null for none
  - setAgeRanges
```
public Person setAgeRanges(java.util.List<AgeRangeType> ageRanges)
```
    Output only. The person's age ranges.
    
    Parameters:
    
    ageRanges - ageRanges or null for none
  - getBiographies
```
public java.util.List<Biography> getBiographies()
```
    The person's biographies.
    
    Returns:
    
    value or null for none
  - setBiographies
```
public Person setBiographies(java.util.List<Biography> biographies)
```
    The person's biographies.
    
    Parameters:
    
    biographies - biographies or null for none
  - getBirthdays
```
public java.util.List<Birthday> getBirthdays()
```
    The person's birthdays.
    
    Returns:
    
    value or null for none
  - setBirthdays
```
public Person setBirthdays(java.util.List<Birthday> birthdays)
```
    The person's birthdays.
    
    Parameters:
    
    birthdays - birthdays or null for none
  - getBraggingRights
```
public java.util.List<BraggingRights> getBraggingRights()
```
    **DEPRECATED**: No data will be returned The person's bragging rights.
    
    Returns:
    
    value or null for none
  - setBraggingRights
```
public Person setBraggingRights(java.util.List<BraggingRights> braggingRights)
```
    **DEPRECATED**: No data will be returned The person's bragging rights.
    
    Parameters:
    
    braggingRights - braggingRights or null for none
  - getCoverPhotos
```
public java.util.List<CoverPhoto> getCoverPhotos()
```
    Output only. The person's cover photos.
    
    Returns:
    
    value or null for none
  - setCoverPhotos
```
public Person setCoverPhotos(java.util.List<CoverPhoto> coverPhotos)
```
    Output only. The person's cover photos.
    
    Parameters:
    
    coverPhotos - coverPhotos or null for none
  - getEmailAddresses
```
public java.util.List<EmailAddress> getEmailAddresses()
```
    The person's email addresses.
    
    Returns:
    
    value or null for none
  - setEmailAddresses
```
public Person setEmailAddresses(java.util.List<EmailAddress> emailAddresses)
```
    The person's email addresses.
    
    Parameters:
    
    emailAddresses - emailAddresses or null for none
  - getEtag
```
public java.lang.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(java.lang.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 java.util.List<Event> getEvents()
```
    The person's events.
    
    Returns:
    
    value or null for none
  - setEvents
```
public Person setEvents(java.util.List<Event> events)
```
    The person's events.
    
    Parameters:
    
    events - events or null for none
  - getGenders
```
public java.util.List<Gender> getGenders()
```
    The person's genders.
    
    Returns:
    
    value or null for none
  - setGenders
```
public Person setGenders(java.util.List<Gender> genders)
```
    The person's genders.
    
    Parameters:
    
    genders - genders or null for none
  - getImClients
```
public java.util.List<ImClient> getImClients()
```
    The person's instant messaging clients.
    
    Returns:
    
    value or null for none
  - setImClients
```
public Person setImClients(java.util.List<ImClient> imClients)
```
    The person's instant messaging clients.
    
    Parameters:
    
    imClients - imClients or null for none
  - getInterests
```
public java.util.List<Interest> getInterests()
```
    The person's interests.
    
    Returns:
    
    value or null for none
  - setInterests
```
public Person setInterests(java.util.List<Interest> interests)
```
    The person's interests.
    
    Parameters:
    
    interests - interests or null for none
  - getLocales
```
public java.util.List<Locale> getLocales()
```
    The person's locale preferences.
    
    Returns:
    
    value or null for none
  - setLocales
```
public Person setLocales(java.util.List<Locale> locales)
```
    The person's locale preferences.
    
    Parameters:
    
    locales - locales or null for none
  - getMemberships
```
public java.util.List<Membership> getMemberships()
```
    The person's group memberships.
    
    Returns:
    
    value or null for none
  - setMemberships
```
public Person setMemberships(java.util.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
  - getNames
```
public java.util.List<Name> getNames()
```
    The person's names.
    
    Returns:
    
    value or null for none
  - setNames
```
public Person setNames(java.util.List<Name> names)
```
    The person's names.
    
    Parameters:
    
    names - names or null for none
  - getNicknames
```
public java.util.List<Nickname> getNicknames()
```
    The person's nicknames.
    
    Returns:
    
    value or null for none
  - setNicknames
```
public Person setNicknames(java.util.List<Nickname> nicknames)
```
    The person's nicknames.
    
    Parameters:
    
    nicknames - nicknames or null for none
  - getOccupations
```
public java.util.List<Occupation> getOccupations()
```
    The person's occupations.
    
    Returns:
    
    value or null for none
  - setOccupations
```
public Person setOccupations(java.util.List<Occupation> occupations)
```
    The person's occupations.
    
    Parameters:
    
    occupations - occupations or null for none
  - getOrganizations
```
public java.util.List<Organization> getOrganizations()
```
    The person's past or current organizations.
    
    Returns:
    
    value or null for none
  - setOrganizations
```
public Person setOrganizations(java.util.List<Organization> organizations)
```
    The person's past or current organizations.
    
    Parameters:
    
    organizations - organizations or null for none
  - getPhoneNumbers
```
public java.util.List<PhoneNumber> getPhoneNumbers()
```
    The person's phone numbers.
    
    Returns:
    
    value or null for none
  - setPhoneNumbers
```
public Person setPhoneNumbers(java.util.List<PhoneNumber> phoneNumbers)
```
    The person's phone numbers.
    
    Parameters:
    
    phoneNumbers - phoneNumbers or null for none
  - getPhotos
```
public java.util.List<Photo> getPhotos()
```
    Output only. The person's photos.
    
    Returns:
    
    value or null for none
  - setPhotos
```
public Person setPhotos(java.util.List<Photo> photos)
```
    Output only. The person's photos.
    
    Parameters:
    
    photos - photos or null for none
  - getRelations
```
public java.util.List<Relation> getRelations()
```
    The person's relations.
    
    Returns:
    
    value or null for none
  - setRelations
```
public Person setRelations(java.util.List<Relation> relations)
```
    The person's relations.
    
    Parameters:
    
    relations - relations or null for none
  - getRelationshipInterests
```
public java.util.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(java.util.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 java.util.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(java.util.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 java.util.List<Residence> getResidences()
```
    The person's residences.
    
    Returns:
    
    value or null for none
  - setResidences
```
public Person setResidences(java.util.List<Residence> residences)
```
    The person's residences.
    
    Parameters:
    
    residences - residences or null for none
  - getResourceName
```
public java.lang.String getResourceName()
```
    The resource name for the person, assigned by the server. An ASCII string with a max length of 27 characters, in the form of `people/{person_id}`.
    
    Returns:
    
    value or null for none
  - setResourceName
```
public Person setResourceName(java.lang.String resourceName)
```
    The resource name for the person, assigned by the server. An ASCII string with a max length of 27 characters, in the form of `people/{person_id}`.
    
    Parameters:
    
    resourceName - resourceName or null for none
  - getSipAddresses
```
public java.util.List<SipAddress> getSipAddresses()
```
    The person's SIP addresses.
    
    Returns:
    
    value or null for none
  - setSipAddresses
```
public Person setSipAddresses(java.util.List<SipAddress> sipAddresses)
```
    The person's SIP addresses.
    
    Parameters:
    
    sipAddresses - sipAddresses or null for none
  - getSkills
```
public java.util.List<Skill> getSkills()
```
    The person's skills.
    
    Returns:
    
    value or null for none
  - setSkills
```
public Person setSkills(java.util.List<Skill> skills)
```
    The person's skills.
    
    Parameters:
    
    skills - skills or null for none
  - getTaglines
```
public java.util.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(java.util.List<Tagline> taglines)
```
    Output only. **DEPRECATED**: No data will be returned The person's taglines.
    
    Parameters:
    
    taglines - taglines or null for none
  - getUrls
```
public java.util.List<Url> getUrls()
```
    The person's associated URLs.
    
    Returns:
    
    value or null for none
  - setUrls
```
public Person setUrls(java.util.List<Url> urls)
```
    The person's associated URLs.
    
    Parameters:
    
    urls - urls or null for none
  - getUserDefined
```
public java.util.List<UserDefined> getUserDefined()
```
    The person's user defined data.
    
    Returns:
    
    value or null for none
  - setUserDefined
```
public Person setUserDefined(java.util.List<UserDefined> userDefined)
```
    The person's user defined data.
    
    Parameters:
    
    userDefined - userDefined or null for none
  - set
```
public Person set(java.lang.String fieldName,
                  java.lang.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

People API v1 (revision 543)

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

getCoverPhotos

setCoverPhotos

getEmailAddresses

setEmailAddresses

getEtag

setEtag

getEvents

setEvents

getGenders

setGenders

getImClients

setImClients

getInterests

setInterests

getLocales

setLocales

getMemberships

setMemberships

getMetadata

setMetadata

getNames

setNames

getNicknames

setNicknames

getOccupations

setOccupations

getOrganizations

setOrganizations

getPhoneNumbers

setPhoneNumbers

getPhotos

setPhotos

getRelations

setRelations

getRelationshipInterests

setRelationshipInterests

getRelationshipStatuses

setRelationshipStatuses

getResidences

setResidences

getResourceName

setResourceName

getSipAddresses

setSipAddresses

getSkills

setSkills

getTaglines

setTaglines

getUrls

setUrls

getUserDefined

setUserDefined