Represents a PostalAddress.
Package
@google-cloud/documentaiConstructors
(constructor)(properties)
constructor(properties?: google.type.IPostalAddress);Constructs a new PostalAddress.
| Parameter | |
|---|---|
| Name | Description |
properties |
IPostalAddress
Properties to set |
Properties
addressLines
public addressLines: string[];PostalAddress addressLines.
administrativeArea
public administrativeArea: string;PostalAddress administrativeArea.
languageCode
public languageCode: string;PostalAddress languageCode.
locality
public locality: string;PostalAddress locality.
organization
public organization: string;PostalAddress organization.
postalCode
public postalCode: string;PostalAddress postalCode.
recipients
public recipients: string[];PostalAddress recipients.
regionCode
public regionCode: string;PostalAddress regionCode.
revision
public revision: number;PostalAddress revision.
sortingCode
public sortingCode: string;PostalAddress sortingCode.
sublocality
public sublocality: string;PostalAddress sublocality.
Methods
create(properties)
public static create(properties?: google.type.IPostalAddress): google.type.PostalAddress;Creates a new PostalAddress instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IPostalAddress
Properties to set |
| Returns | |
|---|---|
| Type | Description |
PostalAddress | PostalAddress instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.type.PostalAddress;Decodes a PostalAddress message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
PostalAddress | PostalAddress |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.type.PostalAddress;Decodes a PostalAddress message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
PostalAddress | PostalAddress |
encode(message, writer)
public static encode(message: google.type.IPostalAddress, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified PostalAddress message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IPostalAddress
PostalAddress message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.type.IPostalAddress, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified PostalAddress message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IPostalAddress
PostalAddress message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.type.PostalAddress;Creates a PostalAddress message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
PostalAddress | PostalAddress |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for PostalAddress
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string | The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this PostalAddress to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.type.PostalAddress, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a PostalAddress message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
PostalAddress
PostalAddress |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies a PostalAddress message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|