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

DEPRECATED: No data will be returned A person's relationship status.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ RelationshipStatus

Returns a new instance of RelationshipStatus.



2220
2221
2222
# File 'generated/google/apis/people_v1/classes.rb', line 2220

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

Instance Attribute Details

#formatted_valueString

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


2205
2206
2207
# File 'generated/google/apis/people_v1/classes.rb', line 2205

def formatted_value
  @formatted_value
end

#metadataGoogle::Apis::PeopleV1::FieldMetadata

Metadata about a field. Corresponds to the JSON property metadata



2210
2211
2212
# File 'generated/google/apis/people_v1/classes.rb', line 2210

def 
  @metadata
end

#valueString

The relationship status. The value can be custom or one of these predefined values: * single * inARelationship * engaged * married * itsComplicated * openRelationship * widowed * inDomesticPartnership * inCivilUnion Corresponds to the JSON property value

Returns:

  • (String)


2218
2219
2220
# File 'generated/google/apis/people_v1/classes.rb', line 2218

def value
  @value
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2225
2226
2227
2228
2229
# File 'generated/google/apis/people_v1/classes.rb', line 2225

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