Represents a UspsData.
Package
@googlemaps/addressvalidationConstructors
(constructor)(properties)
constructor(properties?: google.maps.addressvalidation.v1.IUspsData);Constructs a new UspsData.
| Parameter | |
|---|---|
| Name | Description |
properties |
IUspsData
Properties to set |
Properties
abbreviatedCity
public abbreviatedCity: string;UspsData abbreviatedCity.
addressRecordType
public addressRecordType: string;UspsData addressRecordType.
carrierRoute
public carrierRoute: string;UspsData carrierRoute.
carrierRouteIndicator
public carrierRouteIndicator: string;UspsData carrierRouteIndicator.
cassProcessed
public cassProcessed: boolean;UspsData cassProcessed.
county
public county: string;UspsData county.
defaultAddress
public defaultAddress: boolean;UspsData defaultAddress.
deliveryPointCheckDigit
public deliveryPointCheckDigit: string;UspsData deliveryPointCheckDigit.
deliveryPointCode
public deliveryPointCode: string;UspsData deliveryPointCode.
dpvCmra
public dpvCmra: string;UspsData dpvCmra.
dpvConfirmation
public dpvConfirmation: string;UspsData dpvConfirmation.
dpvFootnote
public dpvFootnote: string;UspsData dpvFootnote.
dpvNoStat
public dpvNoStat: string;UspsData dpvNoStat.
dpvVacant
public dpvVacant: string;UspsData dpvVacant.
elotFlag
public elotFlag: string;UspsData elotFlag.
elotNumber
public elotNumber: string;UspsData elotNumber.
errorMessage
public errorMessage: string;UspsData errorMessage.
ewsNoMatch
public ewsNoMatch: boolean;UspsData ewsNoMatch.
fipsCountyCode
public fipsCountyCode: string;UspsData fipsCountyCode.
lacsLinkIndicator
public lacsLinkIndicator: string;UspsData lacsLinkIndicator.
lacsLinkReturnCode
public lacsLinkReturnCode: string;UspsData lacsLinkReturnCode.
pmbDesignator
public pmbDesignator: string;UspsData pmbDesignator.
pmbNumber
public pmbNumber: string;UspsData pmbNumber.
poBoxOnlyPostalCode
public poBoxOnlyPostalCode: boolean;UspsData poBoxOnlyPostalCode.
postOfficeCity
public postOfficeCity: string;UspsData postOfficeCity.
postOfficeState
public postOfficeState: string;UspsData postOfficeState.
standardizedAddress
public standardizedAddress?: (google.maps.addressvalidation.v1.IUspsAddress|null);UspsData standardizedAddress.
suitelinkFootnote
public suitelinkFootnote: string;UspsData suitelinkFootnote.
Methods
create(properties)
public static create(properties?: google.maps.addressvalidation.v1.IUspsData): google.maps.addressvalidation.v1.UspsData;Creates a new UspsData instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IUspsData
Properties to set |
| Returns | |
|---|---|
| Type | Description |
google.maps.addressvalidation.v1.UspsData | UspsData instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.maps.addressvalidation.v1.UspsData;Decodes a UspsData message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
($protobuf.Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
google.maps.addressvalidation.v1.UspsData | UspsData |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.maps.addressvalidation.v1.UspsData;Decodes a UspsData message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
($protobuf.Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
google.maps.addressvalidation.v1.UspsData | UspsData |
encode(message, writer)
public static encode(message: google.maps.addressvalidation.v1.IUspsData, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified UspsData message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IUspsData
UspsData 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.maps.addressvalidation.v1.IUspsData, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified UspsData message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IUspsData
UspsData 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.maps.addressvalidation.v1.UspsData;Creates a UspsData 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 |
google.maps.addressvalidation.v1.UspsData | UspsData |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for UspsData
| 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 UspsData to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.maps.addressvalidation.v1.UspsData, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a UspsData message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
google.maps.addressvalidation.v1.UspsData
UspsData |
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 UspsData message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|