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.



1504
1505
1506
 
# File 'lib/google/apis/people_v1/classes.rb', line 1504

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) 


1430
1431
1432
 
# File 'lib/google/apis/people_v1/classes.rb', line 1430

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) 


1437
1438
1439
 
# File 'lib/google/apis/people_v1/classes.rb', line 1437

def display_name_last_first
  @display_name_last_first
end

#family_name ⇒ String

The family name. Corresponds to the JSON property familyName

Returns:

  • (String) 


1442
1443
1444
 
# File 'lib/google/apis/people_v1/classes.rb', line 1442

def family_name
  @family_name
end

#given_name ⇒ String

The given name. Corresponds to the JSON property givenName

Returns:

  • (String) 


1447
1448
1449
 
# File 'lib/google/apis/people_v1/classes.rb', line 1447

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) 


1452
1453
1454
 
# File 'lib/google/apis/people_v1/classes.rb', line 1452

def honorific_prefix
  @honorific_prefix
end

#honorific_suffix ⇒ String

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

Returns:

  • (String) 


1457
1458
1459
 
# File 'lib/google/apis/people_v1/classes.rb', line 1457

def honorific_suffix
  @honorific_suffix
end

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

Metadata about a field. Corresponds to the JSON property metadata

Returns:



1462
1463
1464
 
# File 'lib/google/apis/people_v1/classes.rb', line 1462

def metadata
  @metadata
end

#middle_name ⇒ String

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

Returns:

  • (String) 


1467
1468
1469
 
# File 'lib/google/apis/people_v1/classes.rb', line 1467

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) 


1472
1473
1474
 
# File 'lib/google/apis/people_v1/classes.rb', line 1472

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) 


1477
1478
1479
 
# File 'lib/google/apis/people_v1/classes.rb', line 1477

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) 


1482
1483
1484
 
# File 'lib/google/apis/people_v1/classes.rb', line 1482

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) 


1487
1488
1489
 
# File 'lib/google/apis/people_v1/classes.rb', line 1487

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) 


1492
1493
1494
 
# File 'lib/google/apis/people_v1/classes.rb', line 1492

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) 


1497
1498
1499
 
# File 'lib/google/apis/people_v1/classes.rb', line 1497

def phonetic_middle_name
  @phonetic_middle_name
end

#unstructured_name ⇒ String

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

Returns:

  • (String) 


1502
1503
1504
 
# File 'lib/google/apis/people_v1/classes.rb', line 1502

def unstructured_name
  @unstructured_name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
 
# File 'lib/google/apis/people_v1/classes.rb', line 1509

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