UspsData (proto-google-maps-addressvalidation-v1 0.27.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - com.google.maps.addressvalidation.v1.UspsData

All Implemented Interfaces:: UspsDataOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class UspsData
extends com.google.protobuf.GeneratedMessageV3
implements UspsDataOrBuilder

 The USPS data for the address. `uspsData` is not guaranteed to be fully
 populated for every US or PR address sent to the Address Validation API. It's
 recommended to integrate the backup address fields in the response if you
 utilize uspsData as the primary part of the response.

Protobuf type google.maps.addressvalidation.v1.UspsData

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class UspsData.Builder
The USPS data for the address.
- Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
  com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
- Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
  com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Nested Classes
Modifier and Type	Class and Description
`static class`	`UspsData.Builder` The USPS data for the address.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ABBREVIATED_CITY_FIELD_NUMBER`
`static int`	`ADDRESS_RECORD_TYPE_FIELD_NUMBER`
`static int`	`CARRIER_ROUTE_FIELD_NUMBER`
`static int`	`CARRIER_ROUTE_INDICATOR_FIELD_NUMBER`
`static int`	`CASS_PROCESSED_FIELD_NUMBER`
`static int`	`COUNTY_FIELD_NUMBER`
`static int`	`DEFAULT_ADDRESS_FIELD_NUMBER`
`static int`	`DELIVERY_POINT_CHECK_DIGIT_FIELD_NUMBER`
`static int`	`DELIVERY_POINT_CODE_FIELD_NUMBER`
`static int`	`DPV_CMRA_FIELD_NUMBER`
`static int`	`DPV_CONFIRMATION_FIELD_NUMBER`
`static int`	`DPV_FOOTNOTE_FIELD_NUMBER`
`static int`	`DPV_NO_STAT_FIELD_NUMBER`
`static int`	`DPV_VACANT_FIELD_NUMBER`
`static int`	`ELOT_FLAG_FIELD_NUMBER`
`static int`	`ELOT_NUMBER_FIELD_NUMBER`
`static int`	`ERROR_MESSAGE_FIELD_NUMBER`
`static int`	`EWS_NO_MATCH_FIELD_NUMBER`
`static int`	`FIPS_COUNTY_CODE_FIELD_NUMBER`
`static int`	`LACS_LINK_INDICATOR_FIELD_NUMBER`
`static int`	`LACS_LINK_RETURN_CODE_FIELD_NUMBER`
`static int`	`PMB_DESIGNATOR_FIELD_NUMBER`
`static int`	`PMB_NUMBER_FIELD_NUMBER`
`static int`	`PO_BOX_ONLY_POSTAL_CODE_FIELD_NUMBER`
`static int`	`POST_OFFICE_CITY_FIELD_NUMBER`
`static int`	`POST_OFFICE_STATE_FIELD_NUMBER`
`static int`	`STANDARDIZED_ADDRESS_FIELD_NUMBER`
`static int`	`SUITELINK_FOOTNOTE_FIELD_NUMBER`

Fields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`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.
`static UspsData`	`getDefaultInstance()`
`UspsData`	`getDefaultInstanceForType()`
`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
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`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.
`com.google.protobuf.Parser<UspsData>`	`getParserForType()`
`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.
`int`	`getSerializedSize()`
`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.
`int`	`hashCode()`
`boolean`	`hasStandardizedAddress()` USPS standardized address.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`static UspsData.Builder`	`newBuilder()`
`static UspsData.Builder`	`newBuilder(UspsData prototype)`
`UspsData.Builder`	`newBuilderForType()`
`protected UspsData.Builder`	`newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)`
`protected Object`	`newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)`
`static UspsData`	`parseDelimitedFrom(InputStream input)`
`static UspsData`	`parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static UspsData`	`parseFrom(byte[] data)`
`static UspsData`	`parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static UspsData`	`parseFrom(ByteBuffer data)`
`static UspsData`	`parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static UspsData`	`parseFrom(com.google.protobuf.ByteString data)`
`static UspsData`	`parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static UspsData`	`parseFrom(com.google.protobuf.CodedInputStream input)`
`static UspsData`	`parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static UspsData`	`parseFrom(InputStream input)`
`static UspsData`	`parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static com.google.protobuf.Parser<UspsData>`	`parser()`
`UspsData.Builder`	`toBuilder()`
`void`	`writeTo(com.google.protobuf.CodedOutputStream output)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail
- STANDARDIZED_ADDRESS_FIELD_NUMBER
```
public static final int STANDARDIZED_ADDRESS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DELIVERY_POINT_CODE_FIELD_NUMBER
```
public static final int DELIVERY_POINT_CODE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DELIVERY_POINT_CHECK_DIGIT_FIELD_NUMBER
```
public static final int DELIVERY_POINT_CHECK_DIGIT_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DPV_CONFIRMATION_FIELD_NUMBER
```
public static final int DPV_CONFIRMATION_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DPV_FOOTNOTE_FIELD_NUMBER
```
public static final int DPV_FOOTNOTE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DPV_CMRA_FIELD_NUMBER
```
public static final int DPV_CMRA_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DPV_VACANT_FIELD_NUMBER
```
public static final int DPV_VACANT_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DPV_NO_STAT_FIELD_NUMBER
```
public static final int DPV_NO_STAT_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- CARRIER_ROUTE_FIELD_NUMBER
```
public static final int CARRIER_ROUTE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- CARRIER_ROUTE_INDICATOR_FIELD_NUMBER
```
public static final int CARRIER_ROUTE_INDICATOR_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- EWS_NO_MATCH_FIELD_NUMBER
```
public static final int EWS_NO_MATCH_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- POST_OFFICE_CITY_FIELD_NUMBER
```
public static final int POST_OFFICE_CITY_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- POST_OFFICE_STATE_FIELD_NUMBER
```
public static final int POST_OFFICE_STATE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- ABBREVIATED_CITY_FIELD_NUMBER
```
public static final int ABBREVIATED_CITY_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- FIPS_COUNTY_CODE_FIELD_NUMBER
```
public static final int FIPS_COUNTY_CODE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- COUNTY_FIELD_NUMBER
```
public static final int COUNTY_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- ELOT_NUMBER_FIELD_NUMBER
```
public static final int ELOT_NUMBER_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- ELOT_FLAG_FIELD_NUMBER
```
public static final int ELOT_FLAG_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- LACS_LINK_RETURN_CODE_FIELD_NUMBER
```
public static final int LACS_LINK_RETURN_CODE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- LACS_LINK_INDICATOR_FIELD_NUMBER
```
public static final int LACS_LINK_INDICATOR_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- PO_BOX_ONLY_POSTAL_CODE_FIELD_NUMBER
```
public static final int PO_BOX_ONLY_POSTAL_CODE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- SUITELINK_FOOTNOTE_FIELD_NUMBER
```
public static final int SUITELINK_FOOTNOTE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- PMB_DESIGNATOR_FIELD_NUMBER
```
public static final int PMB_DESIGNATOR_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- PMB_NUMBER_FIELD_NUMBER
```
public static final int PMB_NUMBER_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- ADDRESS_RECORD_TYPE_FIELD_NUMBER
```
public static final int ADDRESS_RECORD_TYPE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DEFAULT_ADDRESS_FIELD_NUMBER
```
public static final int DEFAULT_ADDRESS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- ERROR_MESSAGE_FIELD_NUMBER
```
public static final int ERROR_MESSAGE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- CASS_PROCESSED_FIELD_NUMBER
```
public static final int CASS_PROCESSED_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:: newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

hasStandardizedAddress
```
public boolean hasStandardizedAddress()
```
```
 USPS standardized address.
 
```
.google.maps.addressvalidation.v1.UspsAddress standardized_address = 1;
Specified by:

hasStandardizedAddress in interface UspsDataOrBuilder

Returns:

Whether the standardizedAddress field is set.

getStandardizedAddress
```
public UspsAddress getStandardizedAddress()
```
```
 USPS standardized address.
 
```
.google.maps.addressvalidation.v1.UspsAddress standardized_address = 1;
Specified by:

getStandardizedAddress in interface UspsDataOrBuilder

Returns:

The standardizedAddress.

getStandardizedAddressOrBuilder
```
public UspsAddressOrBuilder getStandardizedAddressOrBuilder()
```
```
 USPS standardized address.
 
```
.google.maps.addressvalidation.v1.UspsAddress standardized_address = 1;
Specified by:

getStandardizedAddressOrBuilder in interface UspsDataOrBuilder

getDeliveryPointCode
```
public String getDeliveryPointCode()
```
```
 2 digit delivery point code
 
```
string delivery_point_code = 2;
Specified by:

getDeliveryPointCode in interface UspsDataOrBuilder

Returns:

The deliveryPointCode.

getDeliveryPointCodeBytes
```
public com.google.protobuf.ByteString getDeliveryPointCodeBytes()
```
```
 2 digit delivery point code
 
```
string delivery_point_code = 2;
Specified by:

getDeliveryPointCodeBytes in interface UspsDataOrBuilder

Returns:

The bytes for deliveryPointCode.

getDeliveryPointCheckDigit

public 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;

Specified by:: getDeliveryPointCheckDigit in interface UspsDataOrBuilder
Returns:: The deliveryPointCheckDigit.

getDeliveryPointCheckDigitBytes

public 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;

Specified by:: getDeliveryPointCheckDigitBytes in interface UspsDataOrBuilder
Returns:: The bytes for deliveryPointCheckDigit.

getDpvConfirmation

public 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;

Specified by:: getDpvConfirmation in interface UspsDataOrBuilder
Returns:: The dpvConfirmation.

getDpvConfirmationBytes

public 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;

Specified by:: getDpvConfirmationBytes in interface UspsDataOrBuilder
Returns:: The bytes for dpvConfirmation.

getDpvFootnote

public 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;

Specified by:: getDpvFootnote in interface UspsDataOrBuilder
Returns:: The dpvFootnote.

getDpvFootnoteBytes

public 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;

Specified by:: getDpvFootnoteBytes in interface UspsDataOrBuilder
Returns:: The bytes for dpvFootnote.

getDpvCmra

public 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;

Specified by:: getDpvCmra in interface UspsDataOrBuilder
Returns:: The dpvCmra.

getDpvCmraBytes

public 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;

Specified by:: getDpvCmraBytes in interface UspsDataOrBuilder
Returns:: The bytes for dpvCmra.

getDpvVacant

public 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;

Specified by:: getDpvVacant in interface UspsDataOrBuilder
Returns:: The dpvVacant.

getDpvVacantBytes

public 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;

Specified by:: getDpvVacantBytes in interface UspsDataOrBuilder
Returns:: The bytes for dpvVacant.

getDpvNoStat

public 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;

Specified by:: getDpvNoStat in interface UspsDataOrBuilder
Returns:: The dpvNoStat.

getDpvNoStatBytes

public 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;

Specified by:: getDpvNoStatBytes in interface UspsDataOrBuilder
Returns:: The bytes for dpvNoStat.

getCarrierRoute

public 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;

Specified by:: getCarrierRoute in interface UspsDataOrBuilder
Returns:: The carrierRoute.

getCarrierRouteBytes

public 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;

Specified by:: getCarrierRouteBytes in interface UspsDataOrBuilder
Returns:: The bytes for carrierRoute.

getCarrierRouteIndicator
```
public String getCarrierRouteIndicator()
```
```
 Carrier route rate sort indicator.
 
```
string carrier_route_indicator = 10;
Specified by:

getCarrierRouteIndicator in interface UspsDataOrBuilder

Returns:

The carrierRouteIndicator.

getCarrierRouteIndicatorBytes
```
public com.google.protobuf.ByteString getCarrierRouteIndicatorBytes()
```
```
 Carrier route rate sort indicator.
 
```
string carrier_route_indicator = 10;
Specified by:

getCarrierRouteIndicatorBytes in interface UspsDataOrBuilder

Returns:

The bytes for carrierRouteIndicator.

getEwsNoMatch

public 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;

Specified by:: getEwsNoMatch in interface UspsDataOrBuilder
Returns:: The ewsNoMatch.

getPostOfficeCity
```
public String getPostOfficeCity()
```
```
 Main post office city.
 
```
string post_office_city = 12;
Specified by:

getPostOfficeCity in interface UspsDataOrBuilder

Returns:

The postOfficeCity.

getPostOfficeCityBytes
```
public com.google.protobuf.ByteString getPostOfficeCityBytes()
```
```
 Main post office city.
 
```
string post_office_city = 12;
Specified by:

getPostOfficeCityBytes in interface UspsDataOrBuilder

Returns:

The bytes for postOfficeCity.

getPostOfficeState
```
public String getPostOfficeState()
```
```
 Main post office state.
 
```
string post_office_state = 13;
Specified by:

getPostOfficeState in interface UspsDataOrBuilder

Returns:

The postOfficeState.

getPostOfficeStateBytes
```
public com.google.protobuf.ByteString getPostOfficeStateBytes()
```
```
 Main post office state.
 
```
string post_office_state = 13;
Specified by:

getPostOfficeStateBytes in interface UspsDataOrBuilder

Returns:

The bytes for postOfficeState.

getAbbreviatedCity
```
public String getAbbreviatedCity()
```
```
 Abbreviated city.
 
```
string abbreviated_city = 14;
Specified by:

getAbbreviatedCity in interface UspsDataOrBuilder

Returns:

The abbreviatedCity.

getAbbreviatedCityBytes
```
public com.google.protobuf.ByteString getAbbreviatedCityBytes()
```
```
 Abbreviated city.
 
```
string abbreviated_city = 14;
Specified by:

getAbbreviatedCityBytes in interface UspsDataOrBuilder

Returns:

The bytes for abbreviatedCity.

getFipsCountyCode
```
public String getFipsCountyCode()
```
```
 FIPS county code.
 
```
string fips_county_code = 15;
Specified by:

getFipsCountyCode in interface UspsDataOrBuilder

Returns:

The fipsCountyCode.

getFipsCountyCodeBytes
```
public com.google.protobuf.ByteString getFipsCountyCodeBytes()
```
```
 FIPS county code.
 
```
string fips_county_code = 15;
Specified by:

getFipsCountyCodeBytes in interface UspsDataOrBuilder

Returns:

The bytes for fipsCountyCode.

getCounty
```
public String getCounty()
```
```
 County name.
 
```
string county = 16;
Specified by:

getCounty in interface UspsDataOrBuilder

Returns:

The county.

getCountyBytes
```
public com.google.protobuf.ByteString getCountyBytes()
```
```
 County name.
 
```
string county = 16;
Specified by:

getCountyBytes in interface UspsDataOrBuilder

Returns:

The bytes for county.

getElotNumber
```
public String getElotNumber()
```
```
 Enhanced Line of Travel (eLOT) number.
 
```
string elot_number = 17;
Specified by:

getElotNumber in interface UspsDataOrBuilder

Returns:

The elotNumber.

getElotNumberBytes
```
public com.google.protobuf.ByteString getElotNumberBytes()
```
```
 Enhanced Line of Travel (eLOT) number.
 
```
string elot_number = 17;
Specified by:

getElotNumberBytes in interface UspsDataOrBuilder

Returns:

The bytes for elotNumber.

getElotFlag
```
public String getElotFlag()
```
```
 eLOT Ascending/Descending Flag (A/D).
 
```
string elot_flag = 18;
Specified by:

getElotFlag in interface UspsDataOrBuilder

Returns:

The elotFlag.

getElotFlagBytes
```
public com.google.protobuf.ByteString getElotFlagBytes()
```
```
 eLOT Ascending/Descending Flag (A/D).
 
```
string elot_flag = 18;
Specified by:

getElotFlagBytes in interface UspsDataOrBuilder

Returns:

The bytes for elotFlag.

getLacsLinkReturnCode
```
public String getLacsLinkReturnCode()
```
```
 LACSLink return code.
 
```
string lacs_link_return_code = 19;
Specified by:

getLacsLinkReturnCode in interface UspsDataOrBuilder

Returns:

The lacsLinkReturnCode.

getLacsLinkReturnCodeBytes
```
public com.google.protobuf.ByteString getLacsLinkReturnCodeBytes()
```
```
 LACSLink return code.
 
```
string lacs_link_return_code = 19;
Specified by:

getLacsLinkReturnCodeBytes in interface UspsDataOrBuilder

Returns:

The bytes for lacsLinkReturnCode.

getLacsLinkIndicator
```
public String getLacsLinkIndicator()
```
```
 LACSLink indicator.
 
```
string lacs_link_indicator = 20;
Specified by:

getLacsLinkIndicator in interface UspsDataOrBuilder

Returns:

The lacsLinkIndicator.

getLacsLinkIndicatorBytes
```
public com.google.protobuf.ByteString getLacsLinkIndicatorBytes()
```
```
 LACSLink indicator.
 
```
string lacs_link_indicator = 20;
Specified by:

getLacsLinkIndicatorBytes in interface UspsDataOrBuilder

Returns:

The bytes for lacsLinkIndicator.

getPoBoxOnlyPostalCode
```
public boolean getPoBoxOnlyPostalCode()
```
```
 PO Box only postal code.
 
```
bool po_box_only_postal_code = 21;
Specified by:

getPoBoxOnlyPostalCode in interface UspsDataOrBuilder

Returns:

The poBoxOnlyPostalCode.

getSuitelinkFootnote

public 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;

Specified by:: getSuitelinkFootnote in interface UspsDataOrBuilder
Returns:: The suitelinkFootnote.

getSuitelinkFootnoteBytes

public 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;

Specified by:: getSuitelinkFootnoteBytes in interface UspsDataOrBuilder
Returns:: The bytes for suitelinkFootnote.

getPmbDesignator
```
public String getPmbDesignator()
```
```
 PMB (Private Mail Box) unit designator.
 
```
string pmb_designator = 23;
Specified by:

getPmbDesignator in interface UspsDataOrBuilder

Returns:

The pmbDesignator.

getPmbDesignatorBytes
```
public com.google.protobuf.ByteString getPmbDesignatorBytes()
```
```
 PMB (Private Mail Box) unit designator.
 
```
string pmb_designator = 23;
Specified by:

getPmbDesignatorBytes in interface UspsDataOrBuilder

Returns:

The bytes for pmbDesignator.

getPmbNumber
```
public String getPmbNumber()
```
```
 PMB (Private Mail Box) number;
 
```
string pmb_number = 24;
Specified by:

getPmbNumber in interface UspsDataOrBuilder

Returns:

The pmbNumber.

getPmbNumberBytes
```
public com.google.protobuf.ByteString getPmbNumberBytes()
```
```
 PMB (Private Mail Box) number;
 
```
string pmb_number = 24;
Specified by:

getPmbNumberBytes in interface UspsDataOrBuilder

Returns:

The bytes for pmbNumber.

getAddressRecordType

public 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;

Specified by:: getAddressRecordType in interface UspsDataOrBuilder
Returns:: The addressRecordType.

getAddressRecordTypeBytes

public 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;

Specified by:: getAddressRecordTypeBytes in interface UspsDataOrBuilder
Returns:: The bytes for addressRecordType.

getDefaultAddress
```
public boolean getDefaultAddress()
```
```
 Indicator that a default address was found, but more specific addresses
 exists.
 
```
bool default_address = 26;
Specified by:

getDefaultAddress in interface UspsDataOrBuilder

Returns:

The defaultAddress.

getErrorMessage

public 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;

Specified by:: getErrorMessage in interface UspsDataOrBuilder
Returns:: The errorMessage.

getErrorMessageBytes

public 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;

Specified by:: getErrorMessageBytes in interface UspsDataOrBuilder
Returns:: The bytes for errorMessage.

getCassProcessed
```
public boolean getCassProcessed()
```
```
 Indicator that the request has been CASS processed.
 
```
bool cass_processed = 28;
Specified by:

getCassProcessed in interface UspsDataOrBuilder

Returns:

The cassProcessed.

isInitialized
```
public final boolean isInitialized()
```
Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo
```
public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException
```
Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize
```
public int getSerializedSize()
```
Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals
```
public boolean equals(Object obj)
```
Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode
```
public int hashCode()
```
Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static UspsData parseFrom(ByteBuffer data)
                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:: com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static UspsData parseFrom(ByteBuffer data,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:: com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static UspsData parseFrom(com.google.protobuf.ByteString data)
                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:: com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static UspsData parseFrom(com.google.protobuf.ByteString data,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:: com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static UspsData parseFrom(byte[] data)
                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:: com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static UspsData parseFrom(byte[] data,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:: com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static UspsData parseFrom(InputStream input)
                          throws IOException

Throws:: IOException

parseFrom

public static UspsData parseFrom(InputStream input,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws IOException

Throws:: IOException

parseDelimitedFrom

public static UspsData parseDelimitedFrom(InputStream input)
                                   throws IOException

Throws:: IOException

parseDelimitedFrom

public static UspsData parseDelimitedFrom(InputStream input,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws IOException

Throws:: IOException

parseFrom

public static UspsData parseFrom(com.google.protobuf.CodedInputStream input)
                          throws IOException

Throws:: IOException

parseFrom

public static UspsData parseFrom(com.google.protobuf.CodedInputStream input,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws IOException

Throws:: IOException

newBuilderForType
```
public UspsData.Builder newBuilderForType()
```
Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static UspsData.Builder newBuilder()

newBuilder

public static UspsData.Builder newBuilder(UspsData prototype)

toBuilder
```
public UspsData.Builder toBuilder()
```
Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected UspsData.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:: newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static UspsData getDefaultInstance()

parser

public static com.google.protobuf.Parser<UspsData> parser()

getParserForType
```
public com.google.protobuf.Parser<UspsData> getParserForType()
```
Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType
```
public UspsData getDefaultInstanceForType()
```
Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

Class UspsData

Nested Class Summary

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

Field Summary

Fields inherited from class com.google.protobuf.GeneratedMessageV3

Fields inherited from class com.google.protobuf.AbstractMessage

Fields inherited from class com.google.protobuf.AbstractMessageLite

Method Summary

Methods inherited from class com.google.protobuf.GeneratedMessageV3

Methods inherited from class com.google.protobuf.AbstractMessage

Methods inherited from class com.google.protobuf.AbstractMessageLite

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Methods inherited from interface com.google.protobuf.MessageLite

Field Detail

STANDARDIZED_ADDRESS_FIELD_NUMBER

DELIVERY_POINT_CODE_FIELD_NUMBER

DELIVERY_POINT_CHECK_DIGIT_FIELD_NUMBER

DPV_CONFIRMATION_FIELD_NUMBER

DPV_FOOTNOTE_FIELD_NUMBER

DPV_CMRA_FIELD_NUMBER

DPV_VACANT_FIELD_NUMBER

DPV_NO_STAT_FIELD_NUMBER

CARRIER_ROUTE_FIELD_NUMBER

CARRIER_ROUTE_INDICATOR_FIELD_NUMBER

EWS_NO_MATCH_FIELD_NUMBER

POST_OFFICE_CITY_FIELD_NUMBER

POST_OFFICE_STATE_FIELD_NUMBER

ABBREVIATED_CITY_FIELD_NUMBER

FIPS_COUNTY_CODE_FIELD_NUMBER

COUNTY_FIELD_NUMBER

ELOT_NUMBER_FIELD_NUMBER

ELOT_FLAG_FIELD_NUMBER

LACS_LINK_RETURN_CODE_FIELD_NUMBER

LACS_LINK_INDICATOR_FIELD_NUMBER

PO_BOX_ONLY_POSTAL_CODE_FIELD_NUMBER

SUITELINK_FOOTNOTE_FIELD_NUMBER

PMB_DESIGNATOR_FIELD_NUMBER

PMB_NUMBER_FIELD_NUMBER

ADDRESS_RECORD_TYPE_FIELD_NUMBER

DEFAULT_ADDRESS_FIELD_NUMBER

ERROR_MESSAGE_FIELD_NUMBER

CASS_PROCESSED_FIELD_NUMBER

Method Detail

newInstance

getDescriptor

internalGetFieldAccessorTable

hasStandardizedAddress

getStandardizedAddress

getStandardizedAddressOrBuilder

getDeliveryPointCode

getDeliveryPointCodeBytes

getDeliveryPointCheckDigit

getDeliveryPointCheckDigitBytes

getDpvConfirmation

getDpvConfirmationBytes

getDpvFootnote

getDpvFootnoteBytes

getDpvCmra

getDpvCmraBytes

getDpvVacant

getDpvVacantBytes

getDpvNoStat

getDpvNoStatBytes

getCarrierRoute

getCarrierRouteBytes

getCarrierRouteIndicator

getCarrierRouteIndicatorBytes

getEwsNoMatch

getPostOfficeCity

getPostOfficeCityBytes

getPostOfficeState

getPostOfficeStateBytes

getAbbreviatedCity

getAbbreviatedCityBytes

getFipsCountyCode

getFipsCountyCodeBytes

getCounty

getCountyBytes