Class: Google::Apis::PeopleV1::Name

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 name. If the name is a mononym, the family name is empty.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Name

Returns a new instance of Name.



1688
1689
1690
 
# File 'lib/google/apis/people_v1/classes.rb', line 1688

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

Instance Attribute Details

#display_name ⇒ String

Output only. The display name formatted according to the locale specified by the viewer's account or the Accept-Language HTTP header. Corresponds to the JSON property displayName

Returns:

  • (String) 


1614
1615
1616
 
# File 'lib/google/apis/people_v1/classes.rb', line 1614

def display_name
  @display_name
end

#display_name_last_first ⇒ String

Output only. The display name with the last name first formatted according to the locale specified by the viewer's account or the Accept-Language HTTP header. Corresponds to the JSON property displayNameLastFirst

Returns:

  • (String) 


1621
1622
1623
 
# File 'lib/google/apis/people_v1/classes.rb', line 1621

def display_name_last_first
  @display_name_last_first
end

#family_name ⇒ String

The family name. Corresponds to the JSON property familyName

Returns:

  • (String) 


1626
1627
1628
 
# File 'lib/google/apis/people_v1/classes.rb', line 1626

def family_name
  @family_name
end

#given_name ⇒ String

The given name. Corresponds to the JSON property givenName

Returns:

  • (String) 


1631
1632
1633
 
# File 'lib/google/apis/people_v1/classes.rb', line 1631

def given_name
  @given_name
end

#honorific_prefix ⇒ String

The honorific prefixes, such as Mrs. or Dr. Corresponds to the JSON property honorificPrefix

Returns:

  • (String) 


1636
1637
1638
 
# File 'lib/google/apis/people_v1/classes.rb', line 1636

def honorific_prefix
  @honorific_prefix
end

#honorific_suffix ⇒ String

The honorific suffixes, such as Jr. Corresponds to the JSON property honorificSuffix

Returns:

  • (String) 


1641
1642
1643
 
# File 'lib/google/apis/people_v1/classes.rb', line 1641

def honorific_suffix
  @honorific_suffix
end

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

Metadata about a field. Corresponds to the JSON property metadata

Returns:



1646
1647
1648
 
# File 'lib/google/apis/people_v1/classes.rb', line 1646

def metadata
  @metadata
end

#middle_name ⇒ String

The middle name(s). Corresponds to the JSON property middleName

Returns:

  • (String) 


1651
1652
1653
 
# File 'lib/google/apis/people_v1/classes.rb', line 1651

def middle_name
  @middle_name
end

#phonetic_family_name ⇒ String

The family name spelled as it sounds. Corresponds to the JSON property phoneticFamilyName

Returns:

  • (String) 


1656
1657
1658
 
# File 'lib/google/apis/people_v1/classes.rb', line 1656

def phonetic_family_name
  @phonetic_family_name
end

#phonetic_full_name ⇒ String

The full name spelled as it sounds. Corresponds to the JSON property phoneticFullName

Returns:

  • (String) 


1661
1662
1663
 
# File 'lib/google/apis/people_v1/classes.rb', line 1661

def phonetic_full_name
  @phonetic_full_name
end

#phonetic_given_name ⇒ String

The given name spelled as it sounds. Corresponds to the JSON property phoneticGivenName

Returns:

  • (String) 


1666
1667
1668
 
# File 'lib/google/apis/people_v1/classes.rb', line 1666

def phonetic_given_name
  @phonetic_given_name
end

#phonetic_honorific_prefix ⇒ String

The honorific prefixes spelled as they sound. Corresponds to the JSON property phoneticHonorificPrefix

Returns:

  • (String) 


1671
1672
1673
 
# File 'lib/google/apis/people_v1/classes.rb', line 1671

def phonetic_honorific_prefix
  @phonetic_honorific_prefix
end

#phonetic_honorific_suffix ⇒ String

The honorific suffixes spelled as they sound. Corresponds to the JSON property phoneticHonorificSuffix

Returns:

  • (String) 


1676
1677
1678
 
# File 'lib/google/apis/people_v1/classes.rb', line 1676

def phonetic_honorific_suffix
  @phonetic_honorific_suffix
end

#phonetic_middle_name ⇒ String

The middle name(s) spelled as they sound. Corresponds to the JSON property phoneticMiddleName

Returns:

  • (String) 


1681
1682
1683
 
# File 'lib/google/apis/people_v1/classes.rb', line 1681

def phonetic_middle_name
  @phonetic_middle_name
end

#unstructured_name ⇒ String

The free form name value. Corresponds to the JSON property unstructuredName

Returns:

  • (String) 


1686
1687
1688
 
# File 'lib/google/apis/people_v1/classes.rb', line 1686

def unstructured_name
  @unstructured_name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
 
# File 'lib/google/apis/people_v1/classes.rb', line 1693

def update!(**args)
  @display_name = args[:display_name] if args.key?(:display_name)
  @display_name_last_first = args[:display_name_last_first] if args.key?(:display_name_last_first)
  @family_name = args[:family_name] if args.key?(:family_name)
  @given_name = args[:given_name] if args.key?(:given_name)
  @honorific_prefix = args[:honorific_prefix] if args.key?(:honorific_prefix)
  @honorific_suffix = args[:honorific_suffix] if args.key?(:honorific_suffix)
  @metadata = args[:metadata] if args.key?(:metadata)
  @middle_name = args[:middle_name] if args.key?(:middle_name)
  @phonetic_family_name = args[:phonetic_family_name] if args.key?(:phonetic_family_name)
  @phonetic_full_name = args[:phonetic_full_name] if args.key?(:phonetic_full_name)
  @phonetic_given_name = args[:phonetic_given_name] if args.key?(:phonetic_given_name)
  @phonetic_honorific_prefix = args[:phonetic_honorific_prefix] if args.key?(:phonetic_honorific_prefix)
  @phonetic_honorific_suffix = args[:phonetic_honorific_suffix] if args.key?(:phonetic_honorific_suffix)
  @phonetic_middle_name = args[:phonetic_middle_name] if args.key?(:phonetic_middle_name)
  @unstructured_name = args[:unstructured_name] if args.key?(:unstructured_name)
end