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

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



1465
1466
1467
 
# File 'generated/google/apis/people_v1/classes.rb', line 1465

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) 


1391
1392
1393
 
# File 'generated/google/apis/people_v1/classes.rb', line 1391

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) 


1398
1399
1400
 
# File 'generated/google/apis/people_v1/classes.rb', line 1398

def display_name_last_first
  @display_name_last_first
end

#family_name ⇒ String

The family name. Corresponds to the JSON property familyName

Returns:

  • (String) 


1403
1404
1405
 
# File 'generated/google/apis/people_v1/classes.rb', line 1403

def family_name
  @family_name
end

#given_name ⇒ String

The given name. Corresponds to the JSON property givenName

Returns:

  • (String) 


1408
1409
1410
 
# File 'generated/google/apis/people_v1/classes.rb', line 1408

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) 


1413
1414
1415
 
# File 'generated/google/apis/people_v1/classes.rb', line 1413

def honorific_prefix
  @honorific_prefix
end

#honorific_suffix ⇒ String

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

Returns:

  • (String) 


1418
1419
1420
 
# File 'generated/google/apis/people_v1/classes.rb', line 1418

def honorific_suffix
  @honorific_suffix
end

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

Metadata about a field. Corresponds to the JSON property metadata

Returns:



1423
1424
1425
 
# File 'generated/google/apis/people_v1/classes.rb', line 1423

def metadata
  @metadata
end

#middle_name ⇒ String

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

Returns:

  • (String) 


1428
1429
1430
 
# File 'generated/google/apis/people_v1/classes.rb', line 1428

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) 


1433
1434
1435
 
# File 'generated/google/apis/people_v1/classes.rb', line 1433

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) 


1438
1439
1440
 
# File 'generated/google/apis/people_v1/classes.rb', line 1438

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) 


1443
1444
1445
 
# File 'generated/google/apis/people_v1/classes.rb', line 1443

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) 


1448
1449
1450
 
# File 'generated/google/apis/people_v1/classes.rb', line 1448

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) 


1453
1454
1455
 
# File 'generated/google/apis/people_v1/classes.rb', line 1453

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) 


1458
1459
1460
 
# File 'generated/google/apis/people_v1/classes.rb', line 1458

def phonetic_middle_name
  @phonetic_middle_name
end

#unstructured_name ⇒ String

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

Returns:

  • (String) 


1463
1464
1465
 
# File 'generated/google/apis/people_v1/classes.rb', line 1463

def unstructured_name
  @unstructured_name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
 
# File 'generated/google/apis/people_v1/classes.rb', line 1470

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