Class: Google::Apis::PeopleV1::RelationshipStatus

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 read-only relationship status.

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) ⇒ RelationshipStatus

Returns a new instance of RelationshipStatus



439
440
441
 
# File 'generated/google/apis/people_v1/classes.rb', line 439

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

Instance Attribute Details

#formatted_value ⇒ String

The read-only value of the relationship status translated and formatted in the viewer's account locale or the Accept-Language HTTP header locale. Corresponds to the JSON property formattedValue

Returns:

  • (String) 


437
438
439
 
# File 'generated/google/apis/people_v1/classes.rb', line 437

def formatted_value
  @formatted_value
end

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

Metadata about a field. Corresponds to the JSON property metadata

Returns:



416
417
418
 
# File 'generated/google/apis/people_v1/classes.rb', line 416

def metadata
  @metadata
end

#value ⇒ String

The relationship status. The value can be custom or predefined. Possible values include, but are not limited to, the following:

  • single
  • inARelationship
  • engaged
  • married
  • itsComplicated
  • openRelationship
  • widowed
  • inDomesticPartnership
  • inCivilUnion Corresponds to the JSON property value

Returns:

  • (String) 


431
432
433
 
# File 'generated/google/apis/people_v1/classes.rb', line 431

def value
  @value
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



444
445
446
447
448
 
# File 'generated/google/apis/people_v1/classes.rb', line 444

def update!(**args)
  @metadata = args[:metadata] if args.key?(:metadata)
  @value = args[:value] if args.key?(:value)
  @formatted_value = args[:formatted_value] if args.key?(:formatted_value)
end