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



1223
1224
1225
 
# File 'generated/google/apis/people_v1/classes.rb', line 1223

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) 


1166
1167
1168
 
# File 'generated/google/apis/people_v1/classes.rb', line 1166

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) 


1160
1161
1162
 
# File 'generated/google/apis/people_v1/classes.rb', line 1160

def display_name_last_first
  @display_name_last_first
end

#family_name ⇒ String

The family name. Corresponds to the JSON property familyName

Returns:

  • (String) 


1211
1212
1213
 
# File 'generated/google/apis/people_v1/classes.rb', line 1211

def family_name
  @family_name
end

#given_name ⇒ String

The given name. Corresponds to the JSON property givenName

Returns:

  • (String) 


1186
1187
1188
 
# File 'generated/google/apis/people_v1/classes.rb', line 1186

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) 


1176
1177
1178
 
# File 'generated/google/apis/people_v1/classes.rb', line 1176

def honorific_prefix
  @honorific_prefix
end

#honorific_suffix ⇒ String

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

Returns:

  • (String) 


1171
1172
1173
 
# File 'generated/google/apis/people_v1/classes.rb', line 1171

def honorific_suffix
  @honorific_suffix
end

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

Metadata about a field. Corresponds to the JSON property metadata

Returns:



1221
1222
1223
 
# File 'generated/google/apis/people_v1/classes.rb', line 1221

def metadata
  @metadata
end

#middle_name ⇒ String

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

Returns:

  • (String) 


1191
1192
1193
 
# File 'generated/google/apis/people_v1/classes.rb', line 1191

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) 


1206
1207
1208
 
# File 'generated/google/apis/people_v1/classes.rb', line 1206

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) 


1153
1154
1155
 
# File 'generated/google/apis/people_v1/classes.rb', line 1153

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) 


1201
1202
1203
 
# File 'generated/google/apis/people_v1/classes.rb', line 1201

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) 


1196
1197
1198
 
# File 'generated/google/apis/people_v1/classes.rb', line 1196

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) 


1181
1182
1183
 
# File 'generated/google/apis/people_v1/classes.rb', line 1181

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) 


1216
1217
1218
 
# File 'generated/google/apis/people_v1/classes.rb', line 1216

def phonetic_middle_name
  @phonetic_middle_name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
 
# File 'generated/google/apis/people_v1/classes.rb', line 1228

def update!(**args)
  @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)
  @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)
end