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

Class Relation

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

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

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

A person's relation to another person.

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
Relation()

Method Summary

Methods

Modifier and Type	Method and Description
Relation	clone()
java.lang.String	getFormattedType() The type of the relation translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.
FieldMetadata	getMetadata() Metadata about the relation.
java.lang.String	getPerson() The name of the other person this relation refers to.
java.lang.String	getType() The person's relation to the other person.
Relation	set(java.lang.String fieldName, java.lang.Object value)
Relation	setFormattedType(java.lang.String formattedType) The type of the relation translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.
Relation	setMetadata(FieldMetadata metadata) Metadata about the relation.
Relation	setPerson(java.lang.String person) The name of the other person this relation refers to.
Relation	setType(java.lang.String type) The person's relation to the other person.

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

Constructor Detail

Relation

public Relation()

Method Detail

getFormattedType

public java.lang.String getFormattedType()

The type of the relation translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.

Returns:

value or null for none

setFormattedType

public Relation setFormattedType(java.lang.String formattedType)

The type of the relation translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.

Parameters:

formattedType - formattedType or null for none

getMetadata

public FieldMetadata getMetadata()

Metadata about the relation.

Returns:

value or null for none

setMetadata

public Relation setMetadata(FieldMetadata metadata)

Metadata about the relation.

Parameters:

metadata - metadata or null for none

getPerson

public java.lang.String getPerson()

The name of the other person this relation refers to.

Returns:

value or null for none

setPerson

public Relation setPerson(java.lang.String person)

The name of the other person this relation refers to.

Parameters:

person - person or null for none

getType

public java.lang.String getType()

The person's relation to the other person. The type can be custom or predefined. Possible values include, but are not limited to, the following values: * `spouse` * `child` * `mother` * `father` * `parent` * `brother` * `sister` * `friend` * `relative` * `domesticPartner` * `manager` * `assistant` * `referredBy` * `partner`

Returns:

value or null for none

setType

public Relation setType(java.lang.String type)

The person's relation to the other person. The type can be custom or predefined. Possible values include, but are not limited to, the following values: * `spouse` * `child` * `mother` * `father` * `parent` * `brother` * `sister` * `friend` * `relative` * `domesticPartner` * `manager` * `assistant` * `referredBy` * `partner`

Parameters:

type - type or null for none

set

public Relation set(java.lang.String fieldName,
           java.lang.Object value)

Overrides:

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

clone

public Relation clone()

Overrides:

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