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 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.


1347
1348
1349
# File 'generated/google/apis/people_v1/classes.rb', line 1347

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

Instance Attribute Details

#formatted_valueString

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)

1345
1346
1347
# File 'generated/google/apis/people_v1/classes.rb', line 1345

def formatted_value
  @formatted_value
end

#metadataGoogle::Apis::PeopleV1::FieldMetadata

Metadata about a field. Corresponds to the JSON property metadata


1331
1332
1333
# File 'generated/google/apis/people_v1/classes.rb', line 1331

def 
  @metadata
end

#valueString

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)

1339
1340
1341
# File 'generated/google/apis/people_v1/classes.rb', line 1339

def value
  @value
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


1352
1353
1354
1355
1356
# File 'generated/google/apis/people_v1/classes.rb', line 1352

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