/*
* Copyright 2020 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/maps/addressvalidation/v1/usps_data.proto
package com.google.maps.addressvalidation.v1;
public interface UspsDataOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.maps.addressvalidation.v1.UspsData)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* USPS standardized address.
*
*
* .google.maps.addressvalidation.v1.UspsAddress standardized_address = 1;
*
* @return Whether the standardizedAddress field is set.
*/
boolean hasStandardizedAddress();
/**
*
*
*
* USPS standardized address.
*
*
* .google.maps.addressvalidation.v1.UspsAddress standardized_address = 1;
*
* @return The standardizedAddress.
*/
com.google.maps.addressvalidation.v1.UspsAddress getStandardizedAddress();
/**
*
*
*
* USPS standardized address.
*
*
* .google.maps.addressvalidation.v1.UspsAddress standardized_address = 1;
*/
com.google.maps.addressvalidation.v1.UspsAddressOrBuilder getStandardizedAddressOrBuilder();
/**
*
*
*
* 2 digit delivery point code
*
*
* string delivery_point_code = 2;
*
* @return The deliveryPointCode.
*/
java.lang.String getDeliveryPointCode();
/**
*
*
*
* 2 digit delivery point code
*
*
* string delivery_point_code = 2;
*
* @return The bytes for deliveryPointCode.
*/
com.google.protobuf.ByteString getDeliveryPointCodeBytes();
/**
*
*
*
* 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;
*
* @return The deliveryPointCheckDigit.
*/
java.lang.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;
*
* @return The bytes for deliveryPointCheckDigit.
*/
com.google.protobuf.ByteString getDeliveryPointCheckDigitBytes();
/**
*
*
*
* 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;
*
* @return The dpvConfirmation.
*/
java.lang.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;
*
* @return The bytes for dpvConfirmation.
*/
com.google.protobuf.ByteString getDpvConfirmationBytes();
/**
*
*
*
* 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;
*
* @return The dpvFootnote.
*/
java.lang.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;
*
* @return The bytes for dpvFootnote.
*/
com.google.protobuf.ByteString getDpvFootnoteBytes();
/**
*
*
*
* 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;
*
* @return The dpvCmra.
*/
java.lang.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;
*
* @return The bytes for dpvCmra.
*/
com.google.protobuf.ByteString getDpvCmraBytes();
/**
*
*
*
* Is this place vacant?
* Returns a single character.
* * `Y`: The address is vacant
* * `N`: The address is not vacant
*
*
* string dpv_vacant = 7;
*
* @return The dpvVacant.
*/
java.lang.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;
*
* @return The bytes for dpvVacant.
*/
com.google.protobuf.ByteString getDpvVacantBytes();
/**
*
*
*
* 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;
*
* @return The dpvNoStat.
*/
java.lang.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;
*
* @return The bytes for dpvNoStat.
*/
com.google.protobuf.ByteString getDpvNoStatBytes();
/**
*
*
*
* 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;
*
* @return The carrierRoute.
*/
java.lang.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;
*
* @return The bytes for carrierRoute.
*/
com.google.protobuf.ByteString getCarrierRouteBytes();
/**
*
*
*
* Carrier route rate sort indicator.
*
*
* string carrier_route_indicator = 10;
*
* @return The carrierRouteIndicator.
*/
java.lang.String getCarrierRouteIndicator();
/**
*
*
*
* Carrier route rate sort indicator.
*
*
* string carrier_route_indicator = 10;
*
* @return The bytes for carrierRouteIndicator.
*/
com.google.protobuf.ByteString getCarrierRouteIndicatorBytes();
/**
*
*
*
* The delivery address is matchable, but the EWS file indicates that an exact
* match will be available soon.
*
*
* bool ews_no_match = 11;
*
* @return The ewsNoMatch.
*/
boolean getEwsNoMatch();
/**
*
*
*
* Main post office city.
*
*
* string post_office_city = 12;
*
* @return The postOfficeCity.
*/
java.lang.String getPostOfficeCity();
/**
*
*
*
* Main post office city.
*
*
* string post_office_city = 12;
*
* @return The bytes for postOfficeCity.
*/
com.google.protobuf.ByteString getPostOfficeCityBytes();
/**
*
*
*
* Main post office state.
*
*
* string post_office_state = 13;
*
* @return The postOfficeState.
*/
java.lang.String getPostOfficeState();
/**
*
*
*
* Main post office state.
*
*
* string post_office_state = 13;
*
* @return The bytes for postOfficeState.
*/
com.google.protobuf.ByteString getPostOfficeStateBytes();
/**
*
*
*
* Abbreviated city.
*
*
* string abbreviated_city = 14;
*
* @return The abbreviatedCity.
*/
java.lang.String getAbbreviatedCity();
/**
*
*
*
* Abbreviated city.
*
*
* string abbreviated_city = 14;
*
* @return The bytes for abbreviatedCity.
*/
com.google.protobuf.ByteString getAbbreviatedCityBytes();
/**
*
*
*
* FIPS county code.
*
*
* string fips_county_code = 15;
*
* @return The fipsCountyCode.
*/
java.lang.String getFipsCountyCode();
/**
*
*
*
* FIPS county code.
*
*
* string fips_county_code = 15;
*
* @return The bytes for fipsCountyCode.
*/
com.google.protobuf.ByteString getFipsCountyCodeBytes();
/**
*
*
*
* County name.
*
*
* string county = 16;
*
* @return The county.
*/
java.lang.String getCounty();
/**
*
*
*
* County name.
*
*
* string county = 16;
*
* @return The bytes for county.
*/
com.google.protobuf.ByteString getCountyBytes();
/**
*
*
*
* Enhanced Line of Travel (eLOT) number.
*
*
* string elot_number = 17;
*
* @return The elotNumber.
*/
java.lang.String getElotNumber();
/**
*
*
*
* Enhanced Line of Travel (eLOT) number.
*
*
* string elot_number = 17;
*
* @return The bytes for elotNumber.
*/
com.google.protobuf.ByteString getElotNumberBytes();
/**
*
*
*
* eLOT Ascending/Descending Flag (A/D).
*
*
* string elot_flag = 18;
*
* @return The elotFlag.
*/
java.lang.String getElotFlag();
/**
*
*
*
* eLOT Ascending/Descending Flag (A/D).
*
*
* string elot_flag = 18;
*
* @return The bytes for elotFlag.
*/
com.google.protobuf.ByteString getElotFlagBytes();
/**
*
*
*
* LACSLink return code.
*
*
* string lacs_link_return_code = 19;
*
* @return The lacsLinkReturnCode.
*/
java.lang.String getLacsLinkReturnCode();
/**
*
*
*
* LACSLink return code.
*
*
* string lacs_link_return_code = 19;
*
* @return The bytes for lacsLinkReturnCode.
*/
com.google.protobuf.ByteString getLacsLinkReturnCodeBytes();
/**
*
*
*
* LACSLink indicator.
*
*
* string lacs_link_indicator = 20;
*
* @return The lacsLinkIndicator.
*/
java.lang.String getLacsLinkIndicator();
/**
*
*
*
* LACSLink indicator.
*
*
* string lacs_link_indicator = 20;
*
* @return The bytes for lacsLinkIndicator.
*/
com.google.protobuf.ByteString getLacsLinkIndicatorBytes();
/**
*
*
*
* PO Box only postal code.
*
*
* bool po_box_only_postal_code = 21;
*
* @return The poBoxOnlyPostalCode.
*/
boolean getPoBoxOnlyPostalCode();
/**
*
*
*
* 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;
*
* @return The suitelinkFootnote.
*/
java.lang.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;
*
* @return The bytes for suitelinkFootnote.
*/
com.google.protobuf.ByteString getSuitelinkFootnoteBytes();
/**
*
*
*
* PMB (Private Mail Box) unit designator.
*
*
* string pmb_designator = 23;
*
* @return The pmbDesignator.
*/
java.lang.String getPmbDesignator();
/**
*
*
*
* PMB (Private Mail Box) unit designator.
*
*
* string pmb_designator = 23;
*
* @return The bytes for pmbDesignator.
*/
com.google.protobuf.ByteString getPmbDesignatorBytes();
/**
*
*
*
* PMB (Private Mail Box) number;
*
*
* string pmb_number = 24;
*
* @return The pmbNumber.
*/
java.lang.String getPmbNumber();
/**
*
*
*
* PMB (Private Mail Box) number;
*
*
* string pmb_number = 24;
*
* @return The bytes for pmbNumber.
*/
com.google.protobuf.ByteString getPmbNumberBytes();
/**
*
*
*
* 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;
*
* @return The addressRecordType.
*/
java.lang.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;
*
* @return The bytes for addressRecordType.
*/
com.google.protobuf.ByteString getAddressRecordTypeBytes();
/**
*
*
*
* Indicator that a default address was found, but more specific addresses
* exists.
*
*
* bool default_address = 26;
*
* @return The defaultAddress.
*/
boolean getDefaultAddress();
/**
*
*
*
* 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;
*
* @return The errorMessage.
*/
java.lang.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;
*
* @return The bytes for errorMessage.
*/
com.google.protobuf.ByteString getErrorMessageBytes();
/**
*
*
*
* Indicator that the request has been CASS processed.
*
*
* bool cass_processed = 28;
*
* @return The cassProcessed.
*/
boolean getCassProcessed();
}