Class protos.google.maps.addressvalidation.v1.AddressMetadata (1.0.1)

Represents an AddressMetadata.

Package

@googlemaps/addressvalidation

Constructors

(constructor)(properties)

constructor(properties?: google.maps.addressvalidation.v1.IAddressMetadata);

Constructs a new AddressMetadata.

Parameter
NameDescription
properties IAddressMetadata

Properties to set

Properties

_business

public _business?: "business";

AddressMetadata _business.

_poBox

public _poBox?: "poBox";

AddressMetadata _poBox.

_residential

public _residential?: "residential";

AddressMetadata _residential.

business

public business?: (boolean|null);

AddressMetadata business.

poBox

public poBox?: (boolean|null);

AddressMetadata poBox.

residential

public residential?: (boolean|null);

AddressMetadata residential.

Methods

create(properties)

public static create(properties?: google.maps.addressvalidation.v1.IAddressMetadata): google.maps.addressvalidation.v1.AddressMetadata;

Creates a new AddressMetadata instance using the specified properties.

Parameter
NameDescription
properties IAddressMetadata

Properties to set

Returns
TypeDescription
google.maps.addressvalidation.v1.AddressMetadata

AddressMetadata instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.maps.addressvalidation.v1.AddressMetadata;

Decodes an AddressMetadata message from the specified reader or buffer.

Parameters
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
google.maps.addressvalidation.v1.AddressMetadata

AddressMetadata

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.maps.addressvalidation.v1.AddressMetadata;

Decodes an AddressMetadata message from the specified reader or buffer, length delimited.

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.maps.addressvalidation.v1.AddressMetadata

AddressMetadata

encode(message, writer)

public static encode(message: google.maps.addressvalidation.v1.IAddressMetadata, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified AddressMetadata message. Does not implicitly messages.

Parameters
NameDescription
message IAddressMetadata

AddressMetadata message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.maps.addressvalidation.v1.IAddressMetadata, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified AddressMetadata message, length delimited. Does not implicitly messages.

Parameters
NameDescription
message IAddressMetadata

AddressMetadata message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.maps.addressvalidation.v1.AddressMetadata;

Creates an AddressMetadata message from a plain object. Also converts values to their respective internal types.

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
google.maps.addressvalidation.v1.AddressMetadata

AddressMetadata

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for AddressMetadata

Parameter
NameDescription
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
TypeDescription
string

The default type url

toJSON()

public toJSON(): { [k: string]: any };

Converts this AddressMetadata to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.maps.addressvalidation.v1.AddressMetadata, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from an AddressMetadata message. Also converts values to other types if specified.

Parameters
NameDescription
message google.maps.addressvalidation.v1.AddressMetadata

AddressMetadata

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies an AddressMetadata message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not