Class: Google::Apis::PeopleV1::Relation

Inherits:
Object
  • Object
show all
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

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Relation

Returns a new instance of Relation



1830
1831
1832
 
# File 'generated/google/apis/people_v1/classes.rb', line 1830

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

Returns:

  • (String) 


1797
1798
1799
 
# File 'generated/google/apis/people_v1/classes.rb', line 1797

def formatted_type
  @formatted_type
end

#metadata ⇒ Google::Apis::PeopleV1::FieldMetadata

Metadata about a field. Corresponds to the JSON property metadata

Returns:



1802
1803
1804
 
# File 'generated/google/apis/people_v1/classes.rb', line 1802

def metadata
  @metadata
end

#person ⇒ String

The name of the other person this relation refers to. Corresponds to the JSON property person

Returns:

  • (String) 


1807
1808
1809
 
# File 'generated/google/apis/people_v1/classes.rb', line 1807

def person
  @person
end

#type ⇒ String

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 Corresponds to the JSON property type

Returns:

  • (String) 


1828
1829
1830
 
# File 'generated/google/apis/people_v1/classes.rb', line 1828

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1835
1836
1837
1838
1839
1840
 
# File 'generated/google/apis/people_v1/classes.rb', line 1835

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