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.



1701
1702
1703
 
# File 'lib/google/apis/people_v1/classes.rb', line 1701

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) 


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

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) 


1634
1635
1636
 
# File 'lib/google/apis/people_v1/classes.rb', line 1634

def display_name_last_first
  @display_name_last_first
end

#family_name ⇒ String

The family name. Corresponds to the JSON property familyName

Returns:

  • (String) 


1639
1640
1641
 
# File 'lib/google/apis/people_v1/classes.rb', line 1639

def family_name
  @family_name
end

#given_name ⇒ String

The given name. Corresponds to the JSON property givenName

Returns:

  • (String) 


1644
1645
1646
 
# File 'lib/google/apis/people_v1/classes.rb', line 1644

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) 


1649
1650
1651
 
# File 'lib/google/apis/people_v1/classes.rb', line 1649

def honorific_prefix
  @honorific_prefix
end

#honorific_suffix ⇒ String

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

Returns:

  • (String) 


1654
1655
1656
 
# File 'lib/google/apis/people_v1/classes.rb', line 1654

def honorific_suffix
  @honorific_suffix
end

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

Metadata about a field. Corresponds to the JSON property metadata

Returns:



1659
1660
1661
 
# File 'lib/google/apis/people_v1/classes.rb', line 1659

def metadata
  @metadata
end

#middle_name ⇒ String

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

Returns:

  • (String) 


1664
1665
1666
 
# File 'lib/google/apis/people_v1/classes.rb', line 1664

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) 


1669
1670
1671
 
# File 'lib/google/apis/people_v1/classes.rb', line 1669

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) 


1674
1675
1676
 
# File 'lib/google/apis/people_v1/classes.rb', line 1674

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) 


1679
1680
1681
 
# File 'lib/google/apis/people_v1/classes.rb', line 1679

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) 


1684
1685
1686
 
# File 'lib/google/apis/people_v1/classes.rb', line 1684

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) 


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

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) 


1694
1695
1696
 
# File 'lib/google/apis/people_v1/classes.rb', line 1694

def phonetic_middle_name
  @phonetic_middle_name
end

#unstructured_name ⇒ String

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

Returns:

  • (String) 


1699
1700
1701
 
# File 'lib/google/apis/people_v1/classes.rb', line 1699

def unstructured_name
  @unstructured_name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
 
# File 'lib/google/apis/people_v1/classes.rb', line 1706

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