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

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Name

Returns a new instance of Name



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

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

Instance Attribute Details

#display_name ⇒ String

The read-only 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) 


1313
1314
1315
 
# File 'generated/google/apis/people_v1/classes.rb', line 1313

def display_name
  @display_name
end

#display_name_last_first ⇒ String

The read-only 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) 


1307
1308
1309
 
# File 'generated/google/apis/people_v1/classes.rb', line 1307

def display_name_last_first
  @display_name_last_first
end

#family_name ⇒ String

The family name. Corresponds to the JSON property familyName

Returns:

  • (String) 


1285
1286
1287
 
# File 'generated/google/apis/people_v1/classes.rb', line 1285

def family_name
  @family_name
end

#given_name ⇒ String

The given name. Corresponds to the JSON property givenName

Returns:

  • (String) 


1260
1261
1262
 
# File 'generated/google/apis/people_v1/classes.rb', line 1260

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) 


1323
1324
1325
 
# File 'generated/google/apis/people_v1/classes.rb', line 1323

def honorific_prefix
  @honorific_prefix
end

#honorific_suffix ⇒ String

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

Returns:

  • (String) 


1318
1319
1320
 
# File 'generated/google/apis/people_v1/classes.rb', line 1318

def honorific_suffix
  @honorific_suffix
end

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

Metadata about a field. Corresponds to the JSON property metadata

Returns:



1295
1296
1297
 
# File 'generated/google/apis/people_v1/classes.rb', line 1295

def metadata
  @metadata
end

#middle_name ⇒ String

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

Returns:

  • (String) 


1265
1266
1267
 
# File 'generated/google/apis/people_v1/classes.rb', line 1265

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) 


1280
1281
1282
 
# File 'generated/google/apis/people_v1/classes.rb', line 1280

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) 


1300
1301
1302
 
# File 'generated/google/apis/people_v1/classes.rb', line 1300

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) 


1275
1276
1277
 
# File 'generated/google/apis/people_v1/classes.rb', line 1275

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) 


1270
1271
1272
 
# File 'generated/google/apis/people_v1/classes.rb', line 1270

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) 


1328
1329
1330
 
# File 'generated/google/apis/people_v1/classes.rb', line 1328

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) 


1290
1291
1292
 
# File 'generated/google/apis/people_v1/classes.rb', line 1290

def phonetic_middle_name
  @phonetic_middle_name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
 
# File 'generated/google/apis/people_v1/classes.rb', line 1335

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