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

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/people_v1/classes.rb,
lib/google/apis/people_v1/representations.rb,
lib/google/apis/people_v1/representations.rb

Overview

A person's relation to another person.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Relation

Returns a new instance of Relation.



2188
2189
2190
 
# File 'lib/google/apis/people_v1/classes.rb', line 2188

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#formatted_type ⇒ String

Output only. 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) 


2168
2169
2170
 
# File 'lib/google/apis/people_v1/classes.rb', line 2168

def formatted_type
  @formatted_type
end

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

Metadata about a field. Corresponds to the JSON property metadata

Returns:



2173
2174
2175
 
# File 'lib/google/apis/people_v1/classes.rb', line 2173

def metadata
  @metadata
end

#person ⇒ String

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

Returns:

  • (String) 


2178
2179
2180
 
# File 'lib/google/apis/people_v1/classes.rb', line 2178

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 property type

Returns:

  • (String) 


2186
2187
2188
 
# File 'lib/google/apis/people_v1/classes.rb', line 2186

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2193
2194
2195
2196
2197
2198
 
# File 'lib/google/apis/people_v1/classes.rb', line 2193

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