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

Represents a UspsAddress.

Package

@googlemaps/addressvalidation

Constructors

(constructor)(properties)

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

Constructs a new UspsAddress.

Parameter
NameDescription
properties IUspsAddress

Properties to set

Properties

city

public city: string;

UspsAddress city.

cityStateZipAddressLine

public cityStateZipAddressLine: string;

UspsAddress cityStateZipAddressLine.

firm

public firm: string;

UspsAddress firm.

firstAddressLine

public firstAddressLine: string;

UspsAddress firstAddressLine.

secondAddressLine

public secondAddressLine: string;

UspsAddress secondAddressLine.

state

public state: string;

UspsAddress state.

urbanization

public urbanization: string;

UspsAddress urbanization.

zipCode

public zipCode: string;

UspsAddress zipCode.

zipCodeExtension

public zipCodeExtension: string;

UspsAddress zipCodeExtension.

Methods

create(properties)

public static create(properties?: google.maps.addressvalidation.v1.IUspsAddress): google.maps.addressvalidation.v1.UspsAddress;

Creates a new UspsAddress instance using the specified properties.

Parameter
NameDescription
properties IUspsAddress

Properties to set

Returns
TypeDescription
google.maps.addressvalidation.v1.UspsAddress

UspsAddress instance

decode(reader, length)

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

Decodes a UspsAddress 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.UspsAddress

UspsAddress

decodeDelimited(reader)

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

Decodes a UspsAddress 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.UspsAddress

UspsAddress

encode(message, writer)

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

Encodes the specified UspsAddress message. Does not implicitly messages.

Parameters
NameDescription
message IUspsAddress

UspsAddress 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.IUspsAddress, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IUspsAddress

UspsAddress 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.UspsAddress;

Creates a UspsAddress 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.UspsAddress

UspsAddress

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for UspsAddress

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 UspsAddress to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

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

UspsAddress

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

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

Verifies a UspsAddress 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