com.google.maps.addressvalidation.v1

Interface UspsDataOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

UspsData, UspsData.Builder

public interface UspsDataOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getAbbreviatedCity() Abbreviated city.
com.google.protobuf.ByteString	getAbbreviatedCityBytes() Abbreviated city.
String	getAddressRecordType() Type of the address record that matches the input address.
com.google.protobuf.ByteString	getAddressRecordTypeBytes() Type of the address record that matches the input address.
String	getCarrierRoute() The carrier route code.
com.google.protobuf.ByteString	getCarrierRouteBytes() The carrier route code.
String	getCarrierRouteIndicator() Carrier route rate sort indicator.
com.google.protobuf.ByteString	getCarrierRouteIndicatorBytes() Carrier route rate sort indicator.
boolean	getCassProcessed() Indicator that the request has been CASS processed.
String	getCounty() County name.
com.google.protobuf.ByteString	getCountyBytes() County name.
boolean	getDefaultAddress() Indicator that a default address was found, but more specific addresses exists.
String	getDeliveryPointCheckDigit() The delivery point check digit.
com.google.protobuf.ByteString	getDeliveryPointCheckDigitBytes() The delivery point check digit.
String	getDeliveryPointCode() 2 digit delivery point code
com.google.protobuf.ByteString	getDeliveryPointCodeBytes() 2 digit delivery point code
String	getDpvCmra() Indicates if the address is a CMRA (Commercial Mail Receiving Agency)--a private business receiving mail for clients.
com.google.protobuf.ByteString	getDpvCmraBytes() Indicates if the address is a CMRA (Commercial Mail Receiving Agency)--a private business receiving mail for clients.
String	getDpvConfirmation() The possible values for DPV confirmation.
com.google.protobuf.ByteString	getDpvConfirmationBytes() The possible values for DPV confirmation.
String	getDpvFootnote() The footnotes from delivery point validation.
com.google.protobuf.ByteString	getDpvFootnoteBytes() The footnotes from delivery point validation.
String	getDpvNoStat() Is this a no stat address or an active address? No stat addresses are ones which are not continuously occupied or addresses that the USPS does not service.
com.google.protobuf.ByteString	getDpvNoStatBytes() Is this a no stat address or an active address? No stat addresses are ones which are not continuously occupied or addresses that the USPS does not service.
String	getDpvVacant() Is this place vacant? Returns a single character.
com.google.protobuf.ByteString	getDpvVacantBytes() Is this place vacant? Returns a single character.
String	getElotFlag() eLOT Ascending/Descending Flag (A/D).
com.google.protobuf.ByteString	getElotFlagBytes() eLOT Ascending/Descending Flag (A/D).
String	getElotNumber() Enhanced Line of Travel (eLOT) number.
com.google.protobuf.ByteString	getElotNumberBytes() Enhanced Line of Travel (eLOT) number.
String	getErrorMessage() Error message for USPS data retrieval.
com.google.protobuf.ByteString	getErrorMessageBytes() Error message for USPS data retrieval.
boolean	getEwsNoMatch() The delivery address is matchable, but the EWS file indicates that an exact match will be available soon.
String	getFipsCountyCode() FIPS county code.
com.google.protobuf.ByteString	getFipsCountyCodeBytes() FIPS county code.
String	getLacsLinkIndicator() LACSLink indicator.
com.google.protobuf.ByteString	getLacsLinkIndicatorBytes() LACSLink indicator.
String	getLacsLinkReturnCode() LACSLink return code.
com.google.protobuf.ByteString	getLacsLinkReturnCodeBytes() LACSLink return code.
String	getPmbDesignator() PMB (Private Mail Box) unit designator.
com.google.protobuf.ByteString	getPmbDesignatorBytes() PMB (Private Mail Box) unit designator.
String	getPmbNumber() PMB (Private Mail Box) number;
com.google.protobuf.ByteString	getPmbNumberBytes() PMB (Private Mail Box) number;
boolean	getPoBoxOnlyPostalCode() PO Box only postal code.
String	getPostOfficeCity() Main post office city.
com.google.protobuf.ByteString	getPostOfficeCityBytes() Main post office city.
String	getPostOfficeState() Main post office state.
com.google.protobuf.ByteString	getPostOfficeStateBytes() Main post office state.
UspsAddress	getStandardizedAddress() USPS standardized address.
UspsAddressOrBuilder	getStandardizedAddressOrBuilder() USPS standardized address.
String	getSuitelinkFootnote() Footnotes from matching a street or highrise record to suite information.
com.google.protobuf.ByteString	getSuitelinkFootnoteBytes() Footnotes from matching a street or highrise record to suite information.
boolean	hasStandardizedAddress() USPS standardized address.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasStandardizedAddress

boolean hasStandardizedAddress()

 USPS standardized address.
 

.google.maps.addressvalidation.v1.UspsAddress standardized_address = 1;

Returns:

Whether the standardizedAddress field is set.

getStandardizedAddress

UspsAddress getStandardizedAddress()

 USPS standardized address.
 

.google.maps.addressvalidation.v1.UspsAddress standardized_address = 1;

Returns:

The standardizedAddress.

getStandardizedAddressOrBuilder

UspsAddressOrBuilder getStandardizedAddressOrBuilder()

 USPS standardized address.
 

.google.maps.addressvalidation.v1.UspsAddress standardized_address = 1;

getDeliveryPointCode

String getDeliveryPointCode()

 2 digit delivery point code
 

string delivery_point_code = 2;

Returns:

The deliveryPointCode.

getDeliveryPointCodeBytes

com.google.protobuf.ByteString getDeliveryPointCodeBytes()

 2 digit delivery point code
 

string delivery_point_code = 2;

Returns:

The bytes for deliveryPointCode.

getDeliveryPointCheckDigit

String getDeliveryPointCheckDigit()

 The delivery point check digit. This number is added to the end of the
 delivery_point_barcode for mechanically scanned mail. Adding all the
 digits of the delivery_point_barcode, delivery_point_check_digit, postal
 code, and ZIP+4 together should yield a number divisible by 10.
 

string delivery_point_check_digit = 3;

Returns:

The deliveryPointCheckDigit.

getDeliveryPointCheckDigitBytes

com.google.protobuf.ByteString getDeliveryPointCheckDigitBytes()

 The delivery point check digit. This number is added to the end of the
 delivery_point_barcode for mechanically scanned mail. Adding all the
 digits of the delivery_point_barcode, delivery_point_check_digit, postal
 code, and ZIP+4 together should yield a number divisible by 10.
 

string delivery_point_check_digit = 3;

Returns:

The bytes for deliveryPointCheckDigit.

getDpvConfirmation

String getDpvConfirmation()

 The possible values for DPV confirmation. Returns a single character.

 * `Y`: Address was DPV confirmed for primary and any secondary numbers.
 * `N`: Primary and any secondary number information failed to
 DPV confirm.
 * `S`: Address was DPV confirmed for the primary number only, and the
 secondary number information was present by not confirmed.
 * `D`: Address was DPV confirmed for the primary number only, and the
 secondary number information was missing.
 

string dpv_confirmation = 4;

Returns:

The dpvConfirmation.

getDpvConfirmationBytes

com.google.protobuf.ByteString getDpvConfirmationBytes()

 The possible values for DPV confirmation. Returns a single character.

 * `Y`: Address was DPV confirmed for primary and any secondary numbers.
 * `N`: Primary and any secondary number information failed to
 DPV confirm.
 * `S`: Address was DPV confirmed for the primary number only, and the
 secondary number information was present by not confirmed.
 * `D`: Address was DPV confirmed for the primary number only, and the
 secondary number information was missing.
 

string dpv_confirmation = 4;

Returns:

The bytes for dpvConfirmation.

getDpvFootnote

String getDpvFootnote()

 The footnotes from delivery point validation.
 Multiple footnotes may be strung together in the same string.

 * `AA`: Input address matched to the ZIP+4 file
 * `A1`: Input address was not matched to the ZIP+4 file
 * `BB`: Matched to DPV (all components)
 * `CC`: Secondary number not matched (present but invalid)
 * `N1`: High-rise address missing secondary number
 * `M1`: Primary number missing
 * `M3`: Primary number invalid
 * `P1`: Input address RR or HC box number missing
 * `P3`: Input address PO, RR, or HC Box number invalid
 * `F1`: Input address matched to a military address
 * `G1`: Input address matched to a general delivery address
 * `U1`: Input address matched to a unique ZIP code
 * `PB`: Input address matched to PBSA record
 * `RR`: DPV confirmed address with PMB information
 * `R1`: DPV confirmed address without PMB information
 * `R7`: Carrier Route R777 or R779 record
 

string dpv_footnote = 5;

Returns:

The dpvFootnote.

getDpvFootnoteBytes

com.google.protobuf.ByteString getDpvFootnoteBytes()

 The footnotes from delivery point validation.
 Multiple footnotes may be strung together in the same string.

 * `AA`: Input address matched to the ZIP+4 file
 * `A1`: Input address was not matched to the ZIP+4 file
 * `BB`: Matched to DPV (all components)
 * `CC`: Secondary number not matched (present but invalid)
 * `N1`: High-rise address missing secondary number
 * `M1`: Primary number missing
 * `M3`: Primary number invalid
 * `P1`: Input address RR or HC box number missing
 * `P3`: Input address PO, RR, or HC Box number invalid
 * `F1`: Input address matched to a military address
 * `G1`: Input address matched to a general delivery address
 * `U1`: Input address matched to a unique ZIP code
 * `PB`: Input address matched to PBSA record
 * `RR`: DPV confirmed address with PMB information
 * `R1`: DPV confirmed address without PMB information
 * `R7`: Carrier Route R777 or R779 record
 

string dpv_footnote = 5;

Returns:

The bytes for dpvFootnote.

getDpvCmra

String getDpvCmra()

 Indicates if the address is a CMRA (Commercial Mail Receiving Agency)--a
 private business receiving mail for clients. Returns a single character.

 * `Y`: The address is a CMRA
 * `N`: The address is not a CMRA
 

string dpv_cmra = 6;

Returns:

The dpvCmra.

getDpvCmraBytes

com.google.protobuf.ByteString getDpvCmraBytes()

 Indicates if the address is a CMRA (Commercial Mail Receiving Agency)--a
 private business receiving mail for clients. Returns a single character.

 * `Y`: The address is a CMRA
 * `N`: The address is not a CMRA
 

string dpv_cmra = 6;

Returns:

The bytes for dpvCmra.

getDpvVacant

String getDpvVacant()

 Is this place vacant?
 Returns a single character.

 * `Y`: The address is vacant
 * `N`: The address is not vacant
 

string dpv_vacant = 7;

Returns:

The dpvVacant.

getDpvVacantBytes

com.google.protobuf.ByteString getDpvVacantBytes()

 Is this place vacant?
 Returns a single character.

 * `Y`: The address is vacant
 * `N`: The address is not vacant
 

string dpv_vacant = 7;

Returns:

The bytes for dpvVacant.

getDpvNoStat

String getDpvNoStat()

 Is this a no stat address or an active address?
 No stat addresses are ones which are not continuously occupied or addresses
 that the USPS does not service. Returns a single character.

 * `Y`: The address is not active
 * `N`: The address is active
 

string dpv_no_stat = 8;

Returns:

The dpvNoStat.

getDpvNoStatBytes

com.google.protobuf.ByteString getDpvNoStatBytes()

 Is this a no stat address or an active address?
 No stat addresses are ones which are not continuously occupied or addresses
 that the USPS does not service. Returns a single character.

 * `Y`: The address is not active
 * `N`: The address is active
 

string dpv_no_stat = 8;

Returns:

The bytes for dpvNoStat.

getCarrierRoute

String getCarrierRoute()

 The carrier route code.
 A four character code consisting of a one letter prefix and a three digit
 route designator.

 Prefixes:

 * `C`: Carrier route (or city route)
 * `R`: Rural route
 * `H`: Highway Contract Route
 * `B`: Post Office Box Section
 * `G`: General delivery unit
 

string carrier_route = 9;

Returns:

The carrierRoute.

getCarrierRouteBytes

com.google.protobuf.ByteString getCarrierRouteBytes()

 The carrier route code.
 A four character code consisting of a one letter prefix and a three digit
 route designator.

 Prefixes:

 * `C`: Carrier route (or city route)
 * `R`: Rural route
 * `H`: Highway Contract Route
 * `B`: Post Office Box Section
 * `G`: General delivery unit
 

string carrier_route = 9;

Returns:

The bytes for carrierRoute.

getCarrierRouteIndicator

String getCarrierRouteIndicator()

 Carrier route rate sort indicator.
 

string carrier_route_indicator = 10;

Returns:

The carrierRouteIndicator.

getCarrierRouteIndicatorBytes

com.google.protobuf.ByteString getCarrierRouteIndicatorBytes()

 Carrier route rate sort indicator.
 

string carrier_route_indicator = 10;

Returns:

The bytes for carrierRouteIndicator.

getEwsNoMatch

boolean getEwsNoMatch()

 The delivery address is matchable, but the EWS file indicates that an exact
 match will be available soon.
 

bool ews_no_match = 11;

Returns:

The ewsNoMatch.

getPostOfficeCity

String getPostOfficeCity()

 Main post office city.
 

string post_office_city = 12;

Returns:

The postOfficeCity.

getPostOfficeCityBytes

com.google.protobuf.ByteString getPostOfficeCityBytes()

 Main post office city.
 

string post_office_city = 12;

Returns:

The bytes for postOfficeCity.

getPostOfficeState

String getPostOfficeState()

 Main post office state.
 

string post_office_state = 13;

Returns:

The postOfficeState.

getPostOfficeStateBytes

com.google.protobuf.ByteString getPostOfficeStateBytes()

 Main post office state.
 

string post_office_state = 13;

Returns:

The bytes for postOfficeState.

getAbbreviatedCity

String getAbbreviatedCity()

 Abbreviated city.
 

string abbreviated_city = 14;

Returns:

The abbreviatedCity.

getAbbreviatedCityBytes

com.google.protobuf.ByteString getAbbreviatedCityBytes()

 Abbreviated city.
 

string abbreviated_city = 14;

Returns:

The bytes for abbreviatedCity.

getFipsCountyCode

String getFipsCountyCode()

 FIPS county code.
 

string fips_county_code = 15;

Returns:

The fipsCountyCode.

getFipsCountyCodeBytes

com.google.protobuf.ByteString getFipsCountyCodeBytes()

 FIPS county code.
 

string fips_county_code = 15;

Returns:

The bytes for fipsCountyCode.

getCounty

String getCounty()

 County name.
 

string county = 16;

Returns:

The county.

getCountyBytes

com.google.protobuf.ByteString getCountyBytes()

 County name.
 

string county = 16;

Returns:

The bytes for county.

getElotNumber

String getElotNumber()

 Enhanced Line of Travel (eLOT) number.
 

string elot_number = 17;

Returns:

The elotNumber.

getElotNumberBytes

com.google.protobuf.ByteString getElotNumberBytes()

 Enhanced Line of Travel (eLOT) number.
 

string elot_number = 17;

Returns:

The bytes for elotNumber.

getElotFlag

String getElotFlag()

 eLOT Ascending/Descending Flag (A/D).
 

string elot_flag = 18;

Returns:

The elotFlag.

getElotFlagBytes

com.google.protobuf.ByteString getElotFlagBytes()

 eLOT Ascending/Descending Flag (A/D).
 

string elot_flag = 18;

Returns:

The bytes for elotFlag.

getLacsLinkReturnCode

String getLacsLinkReturnCode()

 LACSLink return code.
 

string lacs_link_return_code = 19;

Returns:

The lacsLinkReturnCode.

getLacsLinkReturnCodeBytes

com.google.protobuf.ByteString getLacsLinkReturnCodeBytes()

 LACSLink return code.
 

string lacs_link_return_code = 19;

Returns:

The bytes for lacsLinkReturnCode.

getLacsLinkIndicator

String getLacsLinkIndicator()

 LACSLink indicator.
 

string lacs_link_indicator = 20;

Returns:

The lacsLinkIndicator.

getLacsLinkIndicatorBytes

com.google.protobuf.ByteString getLacsLinkIndicatorBytes()

 LACSLink indicator.
 

string lacs_link_indicator = 20;

Returns:

The bytes for lacsLinkIndicator.

getPoBoxOnlyPostalCode

boolean getPoBoxOnlyPostalCode()

 PO Box only postal code.
 

bool po_box_only_postal_code = 21;

Returns:

The poBoxOnlyPostalCode.

getSuitelinkFootnote

String getSuitelinkFootnote()

 Footnotes from matching a street or highrise record to suite information.
 If business name match is found, the secondary number is returned.

 * `A`: SuiteLink record match, business address improved.
 * `00`: No match, business address is not improved.
 

string suitelink_footnote = 22;

Returns:

The suitelinkFootnote.

getSuitelinkFootnoteBytes

com.google.protobuf.ByteString getSuitelinkFootnoteBytes()

 Footnotes from matching a street or highrise record to suite information.
 If business name match is found, the secondary number is returned.

 * `A`: SuiteLink record match, business address improved.
 * `00`: No match, business address is not improved.
 

string suitelink_footnote = 22;

Returns:

The bytes for suitelinkFootnote.

getPmbDesignator

String getPmbDesignator()

 PMB (Private Mail Box) unit designator.
 

string pmb_designator = 23;

Returns:

The pmbDesignator.

getPmbDesignatorBytes

com.google.protobuf.ByteString getPmbDesignatorBytes()

 PMB (Private Mail Box) unit designator.
 

string pmb_designator = 23;

Returns:

The bytes for pmbDesignator.

getPmbNumber

String getPmbNumber()

 PMB (Private Mail Box) number;
 

string pmb_number = 24;

Returns:

The pmbNumber.

getPmbNumberBytes

com.google.protobuf.ByteString getPmbNumberBytes()

 PMB (Private Mail Box) number;
 

string pmb_number = 24;

Returns:

The bytes for pmbNumber.

getAddressRecordType

String getAddressRecordType()

 Type of the address record that matches the input address.

 * `F`: FIRM. This is a match to a Firm Record, which is the finest level of
 match available for an address.
 * `G`: GENERAL DELIVERY. This is a match to a General Delivery record.
 * `H`: BUILDING / APARTMENT. This is a match to a Building or Apartment
 record.
 * `P`: POST OFFICE BOX. This is a match to a Post Office Box.
 * `R`: RURAL ROUTE or HIGHWAY CONTRACT: This is a match to either a Rural
 Route or a Highway Contract record, both of which may have associated Box
 Number ranges.
 * `S`: STREET RECORD: This is a match to a Street record containing a valid
 primary number range.
 

string address_record_type = 25;

Returns:

The addressRecordType.

getAddressRecordTypeBytes

com.google.protobuf.ByteString getAddressRecordTypeBytes()

 Type of the address record that matches the input address.

 * `F`: FIRM. This is a match to a Firm Record, which is the finest level of
 match available for an address.
 * `G`: GENERAL DELIVERY. This is a match to a General Delivery record.
 * `H`: BUILDING / APARTMENT. This is a match to a Building or Apartment
 record.
 * `P`: POST OFFICE BOX. This is a match to a Post Office Box.
 * `R`: RURAL ROUTE or HIGHWAY CONTRACT: This is a match to either a Rural
 Route or a Highway Contract record, both of which may have associated Box
 Number ranges.
 * `S`: STREET RECORD: This is a match to a Street record containing a valid
 primary number range.
 

string address_record_type = 25;

Returns:

The bytes for addressRecordType.

getDefaultAddress

boolean getDefaultAddress()

 Indicator that a default address was found, but more specific addresses
 exists.
 

bool default_address = 26;

Returns:

The defaultAddress.

getErrorMessage

String getErrorMessage()

 Error message for USPS data retrieval. This is populated when USPS
 processing is suspended because of the detection of artificially created
 addresses.

 The USPS data fields might not be populated when this error is present.
 

string error_message = 27;

Returns:

The errorMessage.

getErrorMessageBytes

com.google.protobuf.ByteString getErrorMessageBytes()

 Error message for USPS data retrieval. This is populated when USPS
 processing is suspended because of the detection of artificially created
 addresses.

 The USPS data fields might not be populated when this error is present.
 

string error_message = 27;

Returns:

The bytes for errorMessage.

getCassProcessed

boolean getCassProcessed()

 Indicator that the request has been CASS processed.
 

bool cass_processed = 28;

Returns:

The cassProcessed.