Represents a PersonName.
Package
@google-cloud/talentConstructors
(constructor)(properties)
constructor(properties?: google.cloud.talent.v4beta1.IPersonName);
Constructs a new PersonName.
Name | Description |
properties |
IPersonName
Properties to set |
Properties
formattedName
public formattedName?: (string|null);
PersonName formattedName.
personName
public personName?: ("formattedName"|"structuredName");
PersonName personName.
preferredName
public preferredName: string;
PersonName preferredName.
structuredName
public structuredName?: (google.cloud.talent.v4beta1.PersonName.IPersonStructuredName|null);
PersonName structuredName.
Methods
create(properties)
public static create(properties?: google.cloud.talent.v4beta1.IPersonName): google.cloud.talent.v4beta1.PersonName;
Creates a new PersonName instance using the specified properties.
Name | Description |
properties |
IPersonName
Properties to set |
Type | Description |
google.cloud.talent.v4beta1.PersonName | PersonName instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.talent.v4beta1.PersonName;
Decodes a PersonName message from the specified reader or buffer.
Name | Description |
reader |
($protobuf.Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
Type | Description |
google.cloud.talent.v4beta1.PersonName | PersonName |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.talent.v4beta1.PersonName;
Decodes a PersonName message from the specified reader or buffer, length delimited.
Name | Description |
reader |
($protobuf.Reader|Uint8Array)
Reader or buffer to decode from |
Type | Description |
google.cloud.talent.v4beta1.PersonName | PersonName |
encode(message, writer)
public static encode(message: google.cloud.talent.v4beta1.IPersonName, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified PersonName message. Does not implicitly messages.
Name | Description |
message |
IPersonName
PersonName message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
Type | Description |
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.cloud.talent.v4beta1.IPersonName, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified PersonName message, length delimited. Does not implicitly messages.
Name | Description |
message |
IPersonName
PersonName message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
Type | Description |
$protobuf.Writer | Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.cloud.talent.v4beta1.PersonName;
Creates a PersonName message from a plain object. Also converts values to their respective internal types.
Name | Description |
object |
{ [k: string]: any }
Plain object |
Type | Description |
google.cloud.talent.v4beta1.PersonName | PersonName |
toJSON()
public toJSON(): { [k: string]: any };
Converts this PersonName to JSON.
Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.talent.v4beta1.PersonName, options?: $protobuf.IConversionOptions): { [k: string]: any };
Creates a plain object from a PersonName message. Also converts values to other types if specified.
Name | Description |
message |
google.cloud.talent.v4beta1.PersonName
PersonName |
options |
$protobuf.IConversionOptions
Conversion options |
Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);
Verifies a PersonName message.
Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
Type | Description |
(string|null) |
|