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.



1133
1134
1135
 
# File 'generated/google/apis/people_v1/classes.rb', line 1133

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) 


1064
1065
1066
 
# File 'generated/google/apis/people_v1/classes.rb', line 1064

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) 


1071
1072
1073
 
# File 'generated/google/apis/people_v1/classes.rb', line 1071

def display_name_last_first
  @display_name_last_first
end

#family_name ⇒ String

The family name. Corresponds to the JSON property familyName

Returns:

  • (String) 


1076
1077
1078
 
# File 'generated/google/apis/people_v1/classes.rb', line 1076

def family_name
  @family_name
end

#given_name ⇒ String

The given name. Corresponds to the JSON property givenName

Returns:

  • (String) 


1081
1082
1083
 
# File 'generated/google/apis/people_v1/classes.rb', line 1081

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) 


1086
1087
1088
 
# File 'generated/google/apis/people_v1/classes.rb', line 1086

def honorific_prefix
  @honorific_prefix
end

#honorific_suffix ⇒ String

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

Returns:

  • (String) 


1091
1092
1093
 
# File 'generated/google/apis/people_v1/classes.rb', line 1091

def honorific_suffix
  @honorific_suffix
end

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

Metadata about a field. Corresponds to the JSON property metadata

Returns:



1096
1097
1098
 
# File 'generated/google/apis/people_v1/classes.rb', line 1096

def metadata
  @metadata
end

#middle_name ⇒ String

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

Returns:

  • (String) 


1101
1102
1103
 
# File 'generated/google/apis/people_v1/classes.rb', line 1101

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) 


1106
1107
1108
 
# File 'generated/google/apis/people_v1/classes.rb', line 1106

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) 


1111
1112
1113
 
# File 'generated/google/apis/people_v1/classes.rb', line 1111

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) 


1116
1117
1118
 
# File 'generated/google/apis/people_v1/classes.rb', line 1116

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) 


1121
1122
1123
 
# File 'generated/google/apis/people_v1/classes.rb', line 1121

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) 


1126
1127
1128
 
# File 'generated/google/apis/people_v1/classes.rb', line 1126

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) 


1131
1132
1133
 
# File 'generated/google/apis/people_v1/classes.rb', line 1131

def phonetic_middle_name
  @phonetic_middle_name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
 
# File 'generated/google/apis/people_v1/classes.rb', line 1138

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)
end