Class: Google::Apis::PeopleV1::Relation
- Inherits:
-
Object
- Object
- Google::Apis::PeopleV1::Relation
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/people_v1/classes.rb,
generated/google/apis/people_v1/representations.rb,
generated/google/apis/people_v1/representations.rb
Overview
A person's relation to another person.
Instance Attribute Summary collapse
-
#formatted_type ⇒ String
The type of the relation translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.
-
#metadata ⇒ Google::Apis::PeopleV1::FieldMetadata
Metadata about a field.
-
#person ⇒ String
The name of the other person this relation refers to.
-
#type ⇒ String
The person's relation to the other person.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Relation
constructor
A new instance of Relation.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ Relation
Returns a new instance of Relation
1833 1834 1835 |
# File 'generated/google/apis/people_v1/classes.rb', line 1833 def initialize(**args) update!(**args) end |
Instance Attribute Details
#formatted_type ⇒ String
The type of the relation translated and formatted in the viewer's account
locale or the locale specified in the Accept-Language HTTP header.
Corresponds to the JSON property formattedType
1801 1802 1803 |
# File 'generated/google/apis/people_v1/classes.rb', line 1801 def formatted_type @formatted_type end |
#metadata ⇒ Google::Apis::PeopleV1::FieldMetadata
Metadata about a field.
Corresponds to the JSON property metadata
1806 1807 1808 |
# File 'generated/google/apis/people_v1/classes.rb', line 1806 def @metadata end |
#person ⇒ String
The name of the other person this relation refers to.
Corresponds to the JSON property person
1811 1812 1813 |
# File 'generated/google/apis/people_v1/classes.rb', line 1811 def person @person end |
#type ⇒ String
The person's relation to the other person. The type can be custom or one of these predefined values:
spouse
child
mother
father
parent
brother
sister
friend
relative
domesticPartner
manager
assistant
referredBy
partner
Corresponds to the JSON propertytype
1831 1832 1833 |
# File 'generated/google/apis/people_v1/classes.rb', line 1831 def type @type end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1838 1839 1840 1841 1842 1843 |
# File 'generated/google/apis/people_v1/classes.rb', line 1838 def update!(**args) @formatted_type = args[:formatted_type] if args.key?(:formatted_type) @metadata = args[:metadata] if args.key?(:metadata) @person = args[:person] if args.key?(:person) @type = args[:type] if args.key?(:type) end |