Class UspsData.Builder
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite.Builder
-
- com.google.protobuf.AbstractMessage.Builder<BuilderT>
-
- com.google.protobuf.GeneratedMessageV3.Builder<UspsData.Builder>
-
- com.google.maps.addressvalidation.v1.UspsData.Builder
-
- All Implemented Interfaces:
UspsDataOrBuilder,com.google.protobuf.Message.Builder,com.google.protobuf.MessageLite.Builder,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Cloneable
- Enclosing class:
- UspsData
public static final class UspsData.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<UspsData.Builder> 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 typegoogle.maps.addressvalidation.v1.UspsData
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description UspsData.BuilderaddRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)UspsDatabuild()UspsDatabuildPartial()UspsData.Builderclear()UspsData.BuilderclearAbbreviatedCity()Abbreviated city.UspsData.BuilderclearAddressRecordType()Type of the address record that matches the input address.UspsData.BuilderclearCarrierRoute()The carrier route code.UspsData.BuilderclearCarrierRouteIndicator()Carrier route rate sort indicator.UspsData.BuilderclearCassProcessed()Indicator that the request has been CASS processed.UspsData.BuilderclearCounty()County name.UspsData.BuilderclearDefaultAddress()Indicator that a default address was found, but more specific addresses exists.UspsData.BuilderclearDeliveryPointCheckDigit()The delivery point check digit.UspsData.BuilderclearDeliveryPointCode()2 digit delivery point codeUspsData.BuilderclearDpvCmra()Indicates if the address is a CMRA (Commercial Mail Receiving Agency)--a private business receiving mail for clients.UspsData.BuilderclearDpvConfirmation()The possible values for DPV confirmation.UspsData.BuilderclearDpvFootnote()The footnotes from delivery point validation.UspsData.BuilderclearDpvNoStat()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.UspsData.BuilderclearDpvVacant()Is this place vacant? Returns a single character.UspsData.BuilderclearElotFlag()eLOT Ascending/Descending Flag (A/D).UspsData.BuilderclearElotNumber()Enhanced Line of Travel (eLOT) number.UspsData.BuilderclearErrorMessage()Error message for USPS data retrieval.UspsData.BuilderclearEwsNoMatch()The delivery address is matchable, but the EWS file indicates that an exact match will be available soon.UspsData.BuilderclearField(com.google.protobuf.Descriptors.FieldDescriptor field)UspsData.BuilderclearFipsCountyCode()FIPS county code.UspsData.BuilderclearLacsLinkIndicator()LACSLink indicator.UspsData.BuilderclearLacsLinkReturnCode()LACSLink return code.UspsData.BuilderclearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)UspsData.BuilderclearPmbDesignator()PMB (Private Mail Box) unit designator.UspsData.BuilderclearPmbNumber()PMB (Private Mail Box) number;UspsData.BuilderclearPoBoxOnlyPostalCode()PO Box only postal code.UspsData.BuilderclearPostOfficeCity()Main post office city.UspsData.BuilderclearPostOfficeState()Main post office state.UspsData.BuilderclearStandardizedAddress()USPS standardized address.UspsData.BuilderclearSuitelinkFootnote()Footnotes from matching a street or highrise record to suite information.UspsData.Builderclone()StringgetAbbreviatedCity()Abbreviated city.com.google.protobuf.ByteStringgetAbbreviatedCityBytes()Abbreviated city.StringgetAddressRecordType()Type of the address record that matches the input address.com.google.protobuf.ByteStringgetAddressRecordTypeBytes()Type of the address record that matches the input address.StringgetCarrierRoute()The carrier route code.com.google.protobuf.ByteStringgetCarrierRouteBytes()The carrier route code.StringgetCarrierRouteIndicator()Carrier route rate sort indicator.com.google.protobuf.ByteStringgetCarrierRouteIndicatorBytes()Carrier route rate sort indicator.booleangetCassProcessed()Indicator that the request has been CASS processed.StringgetCounty()County name.com.google.protobuf.ByteStringgetCountyBytes()County name.booleangetDefaultAddress()Indicator that a default address was found, but more specific addresses exists.UspsDatagetDefaultInstanceForType()StringgetDeliveryPointCheckDigit()The delivery point check digit.com.google.protobuf.ByteStringgetDeliveryPointCheckDigitBytes()The delivery point check digit.StringgetDeliveryPointCode()2 digit delivery point codecom.google.protobuf.ByteStringgetDeliveryPointCodeBytes()2 digit delivery point codestatic com.google.protobuf.Descriptors.DescriptorgetDescriptor()com.google.protobuf.Descriptors.DescriptorgetDescriptorForType()StringgetDpvCmra()Indicates if the address is a CMRA (Commercial Mail Receiving Agency)--a private business receiving mail for clients.com.google.protobuf.ByteStringgetDpvCmraBytes()Indicates if the address is a CMRA (Commercial Mail Receiving Agency)--a private business receiving mail for clients.StringgetDpvConfirmation()The possible values for DPV confirmation.com.google.protobuf.ByteStringgetDpvConfirmationBytes()The possible values for DPV confirmation.StringgetDpvFootnote()The footnotes from delivery point validation.com.google.protobuf.ByteStringgetDpvFootnoteBytes()The footnotes from delivery point validation.StringgetDpvNoStat()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.ByteStringgetDpvNoStatBytes()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.StringgetDpvVacant()Is this place vacant? Returns a single character.com.google.protobuf.ByteStringgetDpvVacantBytes()Is this place vacant? Returns a single character.StringgetElotFlag()eLOT Ascending/Descending Flag (A/D).com.google.protobuf.ByteStringgetElotFlagBytes()eLOT Ascending/Descending Flag (A/D).StringgetElotNumber()Enhanced Line of Travel (eLOT) number.com.google.protobuf.ByteStringgetElotNumberBytes()Enhanced Line of Travel (eLOT) number.StringgetErrorMessage()Error message for USPS data retrieval.com.google.protobuf.ByteStringgetErrorMessageBytes()Error message for USPS data retrieval.booleangetEwsNoMatch()The delivery address is matchable, but the EWS file indicates that an exact match will be available soon.StringgetFipsCountyCode()FIPS county code.com.google.protobuf.ByteStringgetFipsCountyCodeBytes()FIPS county code.StringgetLacsLinkIndicator()LACSLink indicator.com.google.protobuf.ByteStringgetLacsLinkIndicatorBytes()LACSLink indicator.StringgetLacsLinkReturnCode()LACSLink return code.com.google.protobuf.ByteStringgetLacsLinkReturnCodeBytes()LACSLink return code.StringgetPmbDesignator()PMB (Private Mail Box) unit designator.com.google.protobuf.ByteStringgetPmbDesignatorBytes()PMB (Private Mail Box) unit designator.StringgetPmbNumber()PMB (Private Mail Box) number;com.google.protobuf.ByteStringgetPmbNumberBytes()PMB (Private Mail Box) number;booleangetPoBoxOnlyPostalCode()PO Box only postal code.StringgetPostOfficeCity()Main post office city.com.google.protobuf.ByteStringgetPostOfficeCityBytes()Main post office city.StringgetPostOfficeState()Main post office state.com.google.protobuf.ByteStringgetPostOfficeStateBytes()Main post office state.UspsAddressgetStandardizedAddress()USPS standardized address.UspsAddress.BuildergetStandardizedAddressBuilder()USPS standardized address.UspsAddressOrBuildergetStandardizedAddressOrBuilder()USPS standardized address.StringgetSuitelinkFootnote()Footnotes from matching a street or highrise record to suite information.com.google.protobuf.ByteStringgetSuitelinkFootnoteBytes()Footnotes from matching a street or highrise record to suite information.booleanhasStandardizedAddress()USPS standardized address.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()booleanisInitialized()UspsData.BuildermergeFrom(UspsData other)UspsData.BuildermergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)UspsData.BuildermergeFrom(com.google.protobuf.Message other)UspsData.BuildermergeStandardizedAddress(UspsAddress value)USPS standardized address.UspsData.BuildermergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)UspsData.BuildersetAbbreviatedCity(String value)Abbreviated city.UspsData.BuildersetAbbreviatedCityBytes(com.google.protobuf.ByteString value)Abbreviated city.UspsData.BuildersetAddressRecordType(String value)Type of the address record that matches the input address.UspsData.BuildersetAddressRecordTypeBytes(com.google.protobuf.ByteString value)Type of the address record that matches the input address.UspsData.BuildersetCarrierRoute(String value)The carrier route code.UspsData.BuildersetCarrierRouteBytes(com.google.protobuf.ByteString value)The carrier route code.UspsData.BuildersetCarrierRouteIndicator(String value)Carrier route rate sort indicator.UspsData.BuildersetCarrierRouteIndicatorBytes(com.google.protobuf.ByteString value)Carrier route rate sort indicator.UspsData.BuildersetCassProcessed(boolean value)Indicator that the request has been CASS processed.UspsData.BuildersetCounty(String value)County name.UspsData.BuildersetCountyBytes(com.google.protobuf.ByteString value)County name.UspsData.BuildersetDefaultAddress(boolean value)Indicator that a default address was found, but more specific addresses exists.UspsData.BuildersetDeliveryPointCheckDigit(String value)The delivery point check digit.UspsData.BuildersetDeliveryPointCheckDigitBytes(com.google.protobuf.ByteString value)The delivery point check digit.UspsData.BuildersetDeliveryPointCode(String value)2 digit delivery point codeUspsData.BuildersetDeliveryPointCodeBytes(com.google.protobuf.ByteString value)2 digit delivery point codeUspsData.BuildersetDpvCmra(String value)Indicates if the address is a CMRA (Commercial Mail Receiving Agency)--a private business receiving mail for clients.UspsData.BuildersetDpvCmraBytes(com.google.protobuf.ByteString value)Indicates if the address is a CMRA (Commercial Mail Receiving Agency)--a private business receiving mail for clients.UspsData.BuildersetDpvConfirmation(String value)The possible values for DPV confirmation.UspsData.BuildersetDpvConfirmationBytes(com.google.protobuf.ByteString value)The possible values for DPV confirmation.UspsData.BuildersetDpvFootnote(String value)The footnotes from delivery point validation.UspsData.BuildersetDpvFootnoteBytes(com.google.protobuf.ByteString value)The footnotes from delivery point validation.UspsData.BuildersetDpvNoStat(String value)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.UspsData.BuildersetDpvNoStatBytes(com.google.protobuf.ByteString value)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.UspsData.BuildersetDpvVacant(String value)Is this place vacant? Returns a single character.UspsData.BuildersetDpvVacantBytes(com.google.protobuf.ByteString value)Is this place vacant? Returns a single character.UspsData.BuildersetElotFlag(String value)eLOT Ascending/Descending Flag (A/D).UspsData.BuildersetElotFlagBytes(com.google.protobuf.ByteString value)eLOT Ascending/Descending Flag (A/D).UspsData.BuildersetElotNumber(String value)Enhanced Line of Travel (eLOT) number.UspsData.BuildersetElotNumberBytes(com.google.protobuf.ByteString value)Enhanced Line of Travel (eLOT) number.UspsData.BuildersetErrorMessage(String value)Error message for USPS data retrieval.UspsData.BuildersetErrorMessageBytes(com.google.protobuf.ByteString value)Error message for USPS data retrieval.UspsData.BuildersetEwsNoMatch(boolean value)The delivery address is matchable, but the EWS file indicates that an exact match will be available soon.UspsData.BuildersetField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)UspsData.BuildersetFipsCountyCode(String value)FIPS county code.UspsData.BuildersetFipsCountyCodeBytes(com.google.protobuf.ByteString value)FIPS county code.UspsData.BuildersetLacsLinkIndicator(String value)LACSLink indicator.UspsData.BuildersetLacsLinkIndicatorBytes(com.google.protobuf.ByteString value)LACSLink indicator.UspsData.BuildersetLacsLinkReturnCode(String value)LACSLink return code.UspsData.BuildersetLacsLinkReturnCodeBytes(com.google.protobuf.ByteString value)LACSLink return code.UspsData.BuildersetPmbDesignator(String value)PMB (Private Mail Box) unit designator.UspsData.BuildersetPmbDesignatorBytes(com.google.protobuf.ByteString value)PMB (Private Mail Box) unit designator.UspsData.BuildersetPmbNumber(String value)PMB (Private Mail Box) number;UspsData.BuildersetPmbNumberBytes(com.google.protobuf.ByteString value)PMB (Private Mail Box) number;UspsData.BuildersetPoBoxOnlyPostalCode(boolean value)PO Box only postal code.UspsData.BuildersetPostOfficeCity(String value)Main post office city.UspsData.BuildersetPostOfficeCityBytes(com.google.protobuf.ByteString value)Main post office city.UspsData.BuildersetPostOfficeState(String value)Main post office state.UspsData.BuildersetPostOfficeStateBytes(com.google.protobuf.ByteString value)Main post office state.UspsData.BuildersetRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)UspsData.BuildersetStandardizedAddress(UspsAddress value)USPS standardized address.UspsData.BuildersetStandardizedAddress(UspsAddress.Builder builderForValue)USPS standardized address.UspsData.BuildersetSuitelinkFootnote(String value)Footnotes from matching a street or highrise record to suite information.UspsData.BuildersetSuitelinkFootnoteBytes(com.google.protobuf.ByteString value)Footnotes from matching a street or highrise record to suite information.UspsData.BuildersetUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)-
Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3
-
Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException
-
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
-
-
-
Method Detail
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3.Builder<UspsData.Builder>
-
clear
public UspsData.Builder clear()
- Specified by:
clearin interfacecom.google.protobuf.Message.Builder- Specified by:
clearin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clearin classcom.google.protobuf.GeneratedMessageV3.Builder<UspsData.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.Message.Builder- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getDescriptorForTypein classcom.google.protobuf.GeneratedMessageV3.Builder<UspsData.Builder>
-
getDefaultInstanceForType
public UspsData getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
build
public UspsData build()
- Specified by:
buildin interfacecom.google.protobuf.Message.Builder- Specified by:
buildin interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
public UspsData buildPartial()
- Specified by:
buildPartialin interfacecom.google.protobuf.Message.Builder- Specified by:
buildPartialin interfacecom.google.protobuf.MessageLite.Builder
-
clone
public UspsData.Builder clone()
- Specified by:
clonein interfacecom.google.protobuf.Message.Builder- Specified by:
clonein interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clonein classcom.google.protobuf.GeneratedMessageV3.Builder<UspsData.Builder>
-
setField
public UspsData.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
- Specified by:
setFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<UspsData.Builder>
-
clearField
public UspsData.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
- Specified by:
clearFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
clearFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<UspsData.Builder>
-
clearOneof
public UspsData.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
- Specified by:
clearOneofin interfacecom.google.protobuf.Message.Builder- Overrides:
clearOneofin classcom.google.protobuf.GeneratedMessageV3.Builder<UspsData.Builder>
-
setRepeatedField
public UspsData.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
- Specified by:
setRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<UspsData.Builder>
-
addRepeatedField
public UspsData.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
- Specified by:
addRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
addRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<UspsData.Builder>
-
mergeFrom
public UspsData.Builder mergeFrom(com.google.protobuf.Message other)
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<UspsData.Builder>
-
mergeFrom
public UspsData.Builder mergeFrom(UspsData other)
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3.Builder<UspsData.Builder>
-
mergeFrom
public UspsData.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Specified by:
mergeFromin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<UspsData.Builder>- Throws:
IOException
-
hasStandardizedAddress
public boolean hasStandardizedAddress()
USPS standardized address.
.google.maps.addressvalidation.v1.UspsAddress standardized_address = 1;- Specified by:
hasStandardizedAddressin interfaceUspsDataOrBuilder- Returns:
- Whether the standardizedAddress field is set.
-
getStandardizedAddress
public UspsAddress getStandardizedAddress()
USPS standardized address.
.google.maps.addressvalidation.v1.UspsAddress standardized_address = 1;- Specified by:
getStandardizedAddressin interfaceUspsDataOrBuilder- Returns:
- The standardizedAddress.
-
setStandardizedAddress
public UspsData.Builder setStandardizedAddress(UspsAddress value)
USPS standardized address.
.google.maps.addressvalidation.v1.UspsAddress standardized_address = 1;
-
setStandardizedAddress
public UspsData.Builder setStandardizedAddress(UspsAddress.Builder builderForValue)
USPS standardized address.
.google.maps.addressvalidation.v1.UspsAddress standardized_address = 1;
-
mergeStandardizedAddress
public UspsData.Builder mergeStandardizedAddress(UspsAddress value)
USPS standardized address.
.google.maps.addressvalidation.v1.UspsAddress standardized_address = 1;
-
clearStandardizedAddress
public UspsData.Builder clearStandardizedAddress()
USPS standardized address.
.google.maps.addressvalidation.v1.UspsAddress standardized_address = 1;
-
getStandardizedAddressBuilder
public UspsAddress.Builder getStandardizedAddressBuilder()
USPS standardized address.
.google.maps.addressvalidation.v1.UspsAddress standardized_address = 1;
-
getStandardizedAddressOrBuilder
public UspsAddressOrBuilder getStandardizedAddressOrBuilder()
USPS standardized address.
.google.maps.addressvalidation.v1.UspsAddress standardized_address = 1;- Specified by:
getStandardizedAddressOrBuilderin interfaceUspsDataOrBuilder
-
getDeliveryPointCode
public String getDeliveryPointCode()
2 digit delivery point code
string delivery_point_code = 2;- Specified by:
getDeliveryPointCodein interfaceUspsDataOrBuilder- Returns:
- The deliveryPointCode.
-
getDeliveryPointCodeBytes
public com.google.protobuf.ByteString getDeliveryPointCodeBytes()
2 digit delivery point code
string delivery_point_code = 2;- Specified by:
getDeliveryPointCodeBytesin interfaceUspsDataOrBuilder- Returns:
- The bytes for deliveryPointCode.
-
setDeliveryPointCode
public UspsData.Builder setDeliveryPointCode(String value)
2 digit delivery point code
string delivery_point_code = 2;- Parameters:
value- The deliveryPointCode to set.- Returns:
- This builder for chaining.
-
clearDeliveryPointCode
public UspsData.Builder clearDeliveryPointCode()
2 digit delivery point code
string delivery_point_code = 2;- Returns:
- This builder for chaining.
-
setDeliveryPointCodeBytes
public UspsData.Builder setDeliveryPointCodeBytes(com.google.protobuf.ByteString value)
2 digit delivery point code
string delivery_point_code = 2;- Parameters:
value- The bytes for deliveryPointCode to set.- Returns:
- This builder for chaining.
-
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:
getDeliveryPointCheckDigitin interfaceUspsDataOrBuilder- 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:
getDeliveryPointCheckDigitBytesin interfaceUspsDataOrBuilder- Returns:
- The bytes for deliveryPointCheckDigit.
-
setDeliveryPointCheckDigit
public UspsData.Builder setDeliveryPointCheckDigit(String value)
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;- Parameters:
value- The deliveryPointCheckDigit to set.- Returns:
- This builder for chaining.
-
clearDeliveryPointCheckDigit
public UspsData.Builder clearDeliveryPointCheckDigit()
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:
- This builder for chaining.
-
setDeliveryPointCheckDigitBytes
public UspsData.Builder setDeliveryPointCheckDigitBytes(com.google.protobuf.ByteString value)
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;- Parameters:
value- The bytes for deliveryPointCheckDigit to set.- Returns:
- This builder for chaining.
-
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:
getDpvConfirmationin interfaceUspsDataOrBuilder- 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:
getDpvConfirmationBytesin interfaceUspsDataOrBuilder- Returns:
- The bytes for dpvConfirmation.
-
setDpvConfirmation
public UspsData.Builder setDpvConfirmation(String value)
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;- Parameters:
value- The dpvConfirmation to set.- Returns:
- This builder for chaining.
-
clearDpvConfirmation
public UspsData.Builder clearDpvConfirmation()
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:
- This builder for chaining.
-
setDpvConfirmationBytes
public UspsData.Builder setDpvConfirmationBytes(com.google.protobuf.ByteString value)
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;- Parameters:
value- The bytes for dpvConfirmation to set.- Returns:
- This builder for chaining.
-
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:
getDpvFootnotein interfaceUspsDataOrBuilder- 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:
getDpvFootnoteBytesin interfaceUspsDataOrBuilder- Returns:
- The bytes for dpvFootnote.
-
setDpvFootnote
public UspsData.Builder setDpvFootnote(String value)
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;- Parameters:
value- The dpvFootnote to set.- Returns:
- This builder for chaining.
-
clearDpvFootnote
public UspsData.Builder clearDpvFootnote()
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:
- This builder for chaining.
-
setDpvFootnoteBytes
public UspsData.Builder setDpvFootnoteBytes(com.google.protobuf.ByteString value)
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;- Parameters:
value- The bytes for dpvFootnote to set.- Returns:
- This builder for chaining.
-
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:
getDpvCmrain interfaceUspsDataOrBuilder- 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:
getDpvCmraBytesin interfaceUspsDataOrBuilder- Returns:
- The bytes for dpvCmra.
-
setDpvCmra
public UspsData.Builder setDpvCmra(String value)
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;- Parameters:
value- The dpvCmra to set.- Returns:
- This builder for chaining.
-
clearDpvCmra
public UspsData.Builder clearDpvCmra()
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:
- This builder for chaining.
-
setDpvCmraBytes
public UspsData.Builder setDpvCmraBytes(com.google.protobuf.ByteString value)
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;- Parameters:
value- The bytes for dpvCmra to set.- Returns:
- This builder for chaining.
-
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:
getDpvVacantin interfaceUspsDataOrBuilder- 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:
getDpvVacantBytesin interfaceUspsDataOrBuilder- Returns:
- The bytes for dpvVacant.
-
setDpvVacant
public UspsData.Builder setDpvVacant(String value)
Is this place vacant? Returns a single character. * `Y`: The address is vacant * `N`: The address is not vacant
string dpv_vacant = 7;- Parameters:
value- The dpvVacant to set.- Returns:
- This builder for chaining.
-
clearDpvVacant
public UspsData.Builder clearDpvVacant()
Is this place vacant? Returns a single character. * `Y`: The address is vacant * `N`: The address is not vacant
string dpv_vacant = 7;- Returns:
- This builder for chaining.
-
setDpvVacantBytes
public UspsData.Builder setDpvVacantBytes(com.google.protobuf.ByteString value)
Is this place vacant? Returns a single character. * `Y`: The address is vacant * `N`: The address is not vacant
string dpv_vacant = 7;- Parameters:
value- The bytes for dpvVacant to set.- Returns:
- This builder for chaining.
-
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:
getDpvNoStatin interfaceUspsDataOrBuilder- 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:
getDpvNoStatBytesin interfaceUspsDataOrBuilder- Returns:
- The bytes for dpvNoStat.
-
setDpvNoStat
public UspsData.Builder setDpvNoStat(String value)
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;- Parameters:
value- The dpvNoStat to set.- Returns:
- This builder for chaining.
-
clearDpvNoStat
public UspsData.Builder clearDpvNoStat()
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:
- This builder for chaining.
-
setDpvNoStatBytes
public UspsData.Builder setDpvNoStatBytes(com.google.protobuf.ByteString value)
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;- Parameters:
value- The bytes for dpvNoStat to set.- Returns:
- This builder for chaining.
-
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:
getCarrierRoutein interfaceUspsDataOrBuilder- 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:
getCarrierRouteBytesin interfaceUspsDataOrBuilder- Returns:
- The bytes for carrierRoute.
-
setCarrierRoute
public UspsData.Builder setCarrierRoute(String value)
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;- Parameters:
value- The carrierRoute to set.- Returns:
- This builder for chaining.
-
clearCarrierRoute
public UspsData.Builder clearCarrierRoute()
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:
- This builder for chaining.
-
setCarrierRouteBytes
public UspsData.Builder setCarrierRouteBytes(com.google.protobuf.ByteString value)
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;- Parameters:
value- The bytes for carrierRoute to set.- Returns:
- This builder for chaining.
-
getCarrierRouteIndicator
public String getCarrierRouteIndicator()
Carrier route rate sort indicator.
string carrier_route_indicator = 10;- Specified by:
getCarrierRouteIndicatorin interfaceUspsDataOrBuilder- Returns:
- The carrierRouteIndicator.
-
getCarrierRouteIndicatorBytes
public com.google.protobuf.ByteString getCarrierRouteIndicatorBytes()
Carrier route rate sort indicator.
string carrier_route_indicator = 10;- Specified by:
getCarrierRouteIndicatorBytesin interfaceUspsDataOrBuilder- Returns:
- The bytes for carrierRouteIndicator.
-
setCarrierRouteIndicator
public UspsData.Builder setCarrierRouteIndicator(String value)
Carrier route rate sort indicator.
string carrier_route_indicator = 10;- Parameters:
value- The carrierRouteIndicator to set.- Returns:
- This builder for chaining.
-
clearCarrierRouteIndicator
public UspsData.Builder clearCarrierRouteIndicator()
Carrier route rate sort indicator.
string carrier_route_indicator = 10;- Returns:
- This builder for chaining.
-
setCarrierRouteIndicatorBytes
public UspsData.Builder setCarrierRouteIndicatorBytes(com.google.protobuf.ByteString value)
Carrier route rate sort indicator.
string carrier_route_indicator = 10;- Parameters:
value- The bytes for carrierRouteIndicator to set.- Returns:
- This builder for chaining.
-
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:
getEwsNoMatchin interfaceUspsDataOrBuilder- Returns:
- The ewsNoMatch.
-
setEwsNoMatch
public UspsData.Builder setEwsNoMatch(boolean value)
The delivery address is matchable, but the EWS file indicates that an exact match will be available soon.
bool ews_no_match = 11;- Parameters:
value- The ewsNoMatch to set.- Returns:
- This builder for chaining.
-
clearEwsNoMatch
public UspsData.Builder clearEwsNoMatch()
The delivery address is matchable, but the EWS file indicates that an exact match will be available soon.
bool ews_no_match = 11;- Returns:
- This builder for chaining.
-
getPostOfficeCity
public String getPostOfficeCity()
Main post office city.
string post_office_city = 12;- Specified by:
getPostOfficeCityin interfaceUspsDataOrBuilder- Returns:
- The postOfficeCity.
-
getPostOfficeCityBytes
public com.google.protobuf.ByteString getPostOfficeCityBytes()
Main post office city.
string post_office_city = 12;- Specified by:
getPostOfficeCityBytesin interfaceUspsDataOrBuilder- Returns:
- The bytes for postOfficeCity.
-
setPostOfficeCity
public UspsData.Builder setPostOfficeCity(String value)
Main post office city.
string post_office_city = 12;- Parameters:
value- The postOfficeCity to set.- Returns:
- This builder for chaining.
-
clearPostOfficeCity
public UspsData.Builder clearPostOfficeCity()
Main post office city.
string post_office_city = 12;- Returns:
- This builder for chaining.
-
setPostOfficeCityBytes
public UspsData.Builder setPostOfficeCityBytes(com.google.protobuf.ByteString value)
Main post office city.
string post_office_city = 12;- Parameters:
value- The bytes for postOfficeCity to set.- Returns:
- This builder for chaining.
-
getPostOfficeState
public String getPostOfficeState()
Main post office state.
string post_office_state = 13;- Specified by:
getPostOfficeStatein interfaceUspsDataOrBuilder- Returns:
- The postOfficeState.
-
getPostOfficeStateBytes
public com.google.protobuf.ByteString getPostOfficeStateBytes()
Main post office state.
string post_office_state = 13;- Specified by:
getPostOfficeStateBytesin interfaceUspsDataOrBuilder- Returns:
- The bytes for postOfficeState.
-
setPostOfficeState
public UspsData.Builder setPostOfficeState(String value)
Main post office state.
string post_office_state = 13;- Parameters:
value- The postOfficeState to set.- Returns:
- This builder for chaining.
-
clearPostOfficeState
public UspsData.Builder clearPostOfficeState()
Main post office state.
string post_office_state = 13;- Returns:
- This builder for chaining.
-
setPostOfficeStateBytes
public UspsData.Builder setPostOfficeStateBytes(com.google.protobuf.ByteString value)
Main post office state.
string post_office_state = 13;- Parameters:
value- The bytes for postOfficeState to set.- Returns:
- This builder for chaining.
-
getAbbreviatedCity
public String getAbbreviatedCity()
Abbreviated city.
string abbreviated_city = 14;- Specified by:
getAbbreviatedCityin interfaceUspsDataOrBuilder- Returns:
- The abbreviatedCity.
-
getAbbreviatedCityBytes
public com.google.protobuf.ByteString getAbbreviatedCityBytes()
Abbreviated city.
string abbreviated_city = 14;- Specified by:
getAbbreviatedCityBytesin interfaceUspsDataOrBuilder- Returns:
- The bytes for abbreviatedCity.
-
setAbbreviatedCity
public UspsData.Builder setAbbreviatedCity(String value)
Abbreviated city.
string abbreviated_city = 14;- Parameters:
value- The abbreviatedCity to set.- Returns:
- This builder for chaining.
-
clearAbbreviatedCity
public UspsData.Builder clearAbbreviatedCity()
Abbreviated city.
string abbreviated_city = 14;- Returns:
- This builder for chaining.
-
setAbbreviatedCityBytes
public UspsData.Builder setAbbreviatedCityBytes(com.google.protobuf.ByteString value)
Abbreviated city.
string abbreviated_city = 14;- Parameters:
value- The bytes for abbreviatedCity to set.- Returns:
- This builder for chaining.
-
getFipsCountyCode
public String getFipsCountyCode()
FIPS county code.
string fips_county_code = 15;- Specified by:
getFipsCountyCodein interfaceUspsDataOrBuilder- Returns:
- The fipsCountyCode.
-
getFipsCountyCodeBytes
public com.google.protobuf.ByteString getFipsCountyCodeBytes()
FIPS county code.
string fips_county_code = 15;- Specified by:
getFipsCountyCodeBytesin interfaceUspsDataOrBuilder- Returns:
- The bytes for fipsCountyCode.
-
setFipsCountyCode
public UspsData.Builder setFipsCountyCode(String value)
FIPS county code.
string fips_county_code = 15;- Parameters:
value- The fipsCountyCode to set.- Returns:
- This builder for chaining.
-
clearFipsCountyCode
public UspsData.Builder clearFipsCountyCode()
FIPS county code.
string fips_county_code = 15;- Returns:
- This builder for chaining.
-
setFipsCountyCodeBytes
public UspsData.Builder setFipsCountyCodeBytes(com.google.protobuf.ByteString value)
FIPS county code.
string fips_county_code = 15;- Parameters:
value- The bytes for fipsCountyCode to set.- Returns:
- This builder for chaining.
-
getCounty
public String getCounty()
County name.
string county = 16;- Specified by:
getCountyin interfaceUspsDataOrBuilder- Returns:
- The county.
-
getCountyBytes
public com.google.protobuf.ByteString getCountyBytes()
County name.
string county = 16;- Specified by:
getCountyBytesin interfaceUspsDataOrBuilder- Returns:
- The bytes for county.
-
setCounty
public UspsData.Builder setCounty(String value)
County name.
string county = 16;- Parameters:
value- The county to set.- Returns:
- This builder for chaining.
-
clearCounty
public UspsData.Builder clearCounty()
County name.
string county = 16;- Returns:
- This builder for chaining.
-
setCountyBytes
public UspsData.Builder setCountyBytes(com.google.protobuf.ByteString value)
County name.
string county = 16;- Parameters:
value- The bytes for county to set.- Returns:
- This builder for chaining.
-
getElotNumber
public String getElotNumber()
Enhanced Line of Travel (eLOT) number.
string elot_number = 17;- Specified by:
getElotNumberin interfaceUspsDataOrBuilder- Returns:
- The elotNumber.
-
getElotNumberBytes
public com.google.protobuf.ByteString getElotNumberBytes()
Enhanced Line of Travel (eLOT) number.
string elot_number = 17;- Specified by:
getElotNumberBytesin interfaceUspsDataOrBuilder- Returns:
- The bytes for elotNumber.
-
setElotNumber
public UspsData.Builder setElotNumber(String value)
Enhanced Line of Travel (eLOT) number.
string elot_number = 17;- Parameters:
value- The elotNumber to set.- Returns:
- This builder for chaining.
-
clearElotNumber
public UspsData.Builder clearElotNumber()
Enhanced Line of Travel (eLOT) number.
string elot_number = 17;- Returns:
- This builder for chaining.
-
setElotNumberBytes
public UspsData.Builder setElotNumberBytes(com.google.protobuf.ByteString value)
Enhanced Line of Travel (eLOT) number.
string elot_number = 17;- Parameters:
value- The bytes for elotNumber to set.- Returns:
- This builder for chaining.
-
getElotFlag
public String getElotFlag()
eLOT Ascending/Descending Flag (A/D).
string elot_flag = 18;- Specified by:
getElotFlagin interfaceUspsDataOrBuilder- Returns:
- The elotFlag.
-
getElotFlagBytes
public com.google.protobuf.ByteString getElotFlagBytes()
eLOT Ascending/Descending Flag (A/D).
string elot_flag = 18;- Specified by:
getElotFlagBytesin interfaceUspsDataOrBuilder- Returns:
- The bytes for elotFlag.
-
setElotFlag
public UspsData.Builder setElotFlag(String value)
eLOT Ascending/Descending Flag (A/D).
string elot_flag = 18;- Parameters:
value- The elotFlag to set.- Returns:
- This builder for chaining.
-
clearElotFlag
public UspsData.Builder clearElotFlag()
eLOT Ascending/Descending Flag (A/D).
string elot_flag = 18;- Returns:
- This builder for chaining.
-
setElotFlagBytes
public UspsData.Builder setElotFlagBytes(com.google.protobuf.ByteString value)
eLOT Ascending/Descending Flag (A/D).
string elot_flag = 18;- Parameters:
value- The bytes for elotFlag to set.- Returns:
- This builder for chaining.
-
getLacsLinkReturnCode
public String getLacsLinkReturnCode()
LACSLink return code.
string lacs_link_return_code = 19;- Specified by:
getLacsLinkReturnCodein interfaceUspsDataOrBuilder- Returns:
- The lacsLinkReturnCode.
-
getLacsLinkReturnCodeBytes
public com.google.protobuf.ByteString getLacsLinkReturnCodeBytes()
LACSLink return code.
string lacs_link_return_code = 19;- Specified by:
getLacsLinkReturnCodeBytesin interfaceUspsDataOrBuilder- Returns:
- The bytes for lacsLinkReturnCode.
-
setLacsLinkReturnCode
public UspsData.Builder setLacsLinkReturnCode(String value)
LACSLink return code.
string lacs_link_return_code = 19;- Parameters:
value- The lacsLinkReturnCode to set.- Returns:
- This builder for chaining.
-
clearLacsLinkReturnCode
public UspsData.Builder clearLacsLinkReturnCode()
LACSLink return code.
string lacs_link_return_code = 19;- Returns:
- This builder for chaining.
-
setLacsLinkReturnCodeBytes
public UspsData.Builder setLacsLinkReturnCodeBytes(com.google.protobuf.ByteString value)
LACSLink return code.
string lacs_link_return_code = 19;- Parameters:
value- The bytes for lacsLinkReturnCode to set.- Returns:
- This builder for chaining.
-
getLacsLinkIndicator
public String getLacsLinkIndicator()
LACSLink indicator.
string lacs_link_indicator = 20;- Specified by:
getLacsLinkIndicatorin interfaceUspsDataOrBuilder- Returns:
- The lacsLinkIndicator.
-
getLacsLinkIndicatorBytes
public com.google.protobuf.ByteString getLacsLinkIndicatorBytes()
LACSLink indicator.
string lacs_link_indicator = 20;- Specified by:
getLacsLinkIndicatorBytesin interfaceUspsDataOrBuilder- Returns:
- The bytes for lacsLinkIndicator.
-
setLacsLinkIndicator
public UspsData.Builder setLacsLinkIndicator(String value)
LACSLink indicator.
string lacs_link_indicator = 20;- Parameters:
value- The lacsLinkIndicator to set.- Returns:
- This builder for chaining.
-
clearLacsLinkIndicator
public UspsData.Builder clearLacsLinkIndicator()
LACSLink indicator.
string lacs_link_indicator = 20;- Returns:
- This builder for chaining.
-
setLacsLinkIndicatorBytes
public UspsData.Builder setLacsLinkIndicatorBytes(com.google.protobuf.ByteString value)
LACSLink indicator.
string lacs_link_indicator = 20;- Parameters:
value- The bytes for lacsLinkIndicator to set.- Returns:
- This builder for chaining.
-
getPoBoxOnlyPostalCode
public boolean getPoBoxOnlyPostalCode()
PO Box only postal code.
bool po_box_only_postal_code = 21;- Specified by:
getPoBoxOnlyPostalCodein interfaceUspsDataOrBuilder- Returns:
- The poBoxOnlyPostalCode.
-
setPoBoxOnlyPostalCode
public UspsData.Builder setPoBoxOnlyPostalCode(boolean value)
PO Box only postal code.
bool po_box_only_postal_code = 21;- Parameters:
value- The poBoxOnlyPostalCode to set.- Returns:
- This builder for chaining.
-
clearPoBoxOnlyPostalCode
public UspsData.Builder clearPoBoxOnlyPostalCode()
PO Box only postal code.
bool po_box_only_postal_code = 21;- Returns:
- This builder for chaining.
-
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:
getSuitelinkFootnotein interfaceUspsDataOrBuilder- 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:
getSuitelinkFootnoteBytesin interfaceUspsDataOrBuilder- Returns:
- The bytes for suitelinkFootnote.
-
setSuitelinkFootnote
public UspsData.Builder setSuitelinkFootnote(String value)
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;- Parameters:
value- The suitelinkFootnote to set.- Returns:
- This builder for chaining.
-
clearSuitelinkFootnote
public UspsData.Builder clearSuitelinkFootnote()
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:
- This builder for chaining.
-
setSuitelinkFootnoteBytes
public UspsData.Builder setSuitelinkFootnoteBytes(com.google.protobuf.ByteString value)
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;- Parameters:
value- The bytes for suitelinkFootnote to set.- Returns:
- This builder for chaining.
-
getPmbDesignator
public String getPmbDesignator()
PMB (Private Mail Box) unit designator.
string pmb_designator = 23;- Specified by:
getPmbDesignatorin interfaceUspsDataOrBuilder- Returns:
- The pmbDesignator.
-
getPmbDesignatorBytes
public com.google.protobuf.ByteString getPmbDesignatorBytes()
PMB (Private Mail Box) unit designator.
string pmb_designator = 23;- Specified by:
getPmbDesignatorBytesin interfaceUspsDataOrBuilder- Returns:
- The bytes for pmbDesignator.
-
setPmbDesignator
public UspsData.Builder setPmbDesignator(String value)
PMB (Private Mail Box) unit designator.
string pmb_designator = 23;- Parameters:
value- The pmbDesignator to set.- Returns:
- This builder for chaining.
-
clearPmbDesignator
public UspsData.Builder clearPmbDesignator()
PMB (Private Mail Box) unit designator.
string pmb_designator = 23;- Returns:
- This builder for chaining.
-
setPmbDesignatorBytes
public UspsData.Builder setPmbDesignatorBytes(com.google.protobuf.ByteString value)
PMB (Private Mail Box) unit designator.
string pmb_designator = 23;- Parameters:
value- The bytes for pmbDesignator to set.- Returns:
- This builder for chaining.
-
getPmbNumber
public String getPmbNumber()
PMB (Private Mail Box) number;
string pmb_number = 24;- Specified by:
getPmbNumberin interfaceUspsDataOrBuilder- Returns:
- The pmbNumber.
-
getPmbNumberBytes
public com.google.protobuf.ByteString getPmbNumberBytes()
PMB (Private Mail Box) number;
string pmb_number = 24;- Specified by:
getPmbNumberBytesin interfaceUspsDataOrBuilder- Returns:
- The bytes for pmbNumber.
-
setPmbNumber
public UspsData.Builder setPmbNumber(String value)
PMB (Private Mail Box) number;
string pmb_number = 24;- Parameters:
value- The pmbNumber to set.- Returns:
- This builder for chaining.
-
clearPmbNumber
public UspsData.Builder clearPmbNumber()
PMB (Private Mail Box) number;
string pmb_number = 24;- Returns:
- This builder for chaining.
-
setPmbNumberBytes
public UspsData.Builder setPmbNumberBytes(com.google.protobuf.ByteString value)
PMB (Private Mail Box) number;
string pmb_number = 24;- Parameters:
value- The bytes for pmbNumber to set.- Returns:
- This builder for chaining.
-
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:
getAddressRecordTypein interfaceUspsDataOrBuilder- 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:
getAddressRecordTypeBytesin interfaceUspsDataOrBuilder- Returns:
- The bytes for addressRecordType.
-
setAddressRecordType
public UspsData.Builder setAddressRecordType(String value)
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;- Parameters:
value- The addressRecordType to set.- Returns:
- This builder for chaining.
-
clearAddressRecordType
public UspsData.Builder clearAddressRecordType()
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:
- This builder for chaining.
-
setAddressRecordTypeBytes
public UspsData.Builder setAddressRecordTypeBytes(com.google.protobuf.ByteString value)
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;- Parameters:
value- The bytes for addressRecordType to set.- Returns:
- This builder for chaining.
-
getDefaultAddress
public boolean getDefaultAddress()
Indicator that a default address was found, but more specific addresses exists.
bool default_address = 26;- Specified by:
getDefaultAddressin interfaceUspsDataOrBuilder- Returns:
- The defaultAddress.
-
setDefaultAddress
public UspsData.Builder setDefaultAddress(boolean value)
Indicator that a default address was found, but more specific addresses exists.
bool default_address = 26;- Parameters:
value- The defaultAddress to set.- Returns:
- This builder for chaining.
-
clearDefaultAddress
public UspsData.Builder clearDefaultAddress()
Indicator that a default address was found, but more specific addresses exists.
bool default_address = 26;- Returns:
- This builder for chaining.
-
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:
getErrorMessagein interfaceUspsDataOrBuilder- 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:
getErrorMessageBytesin interfaceUspsDataOrBuilder- Returns:
- The bytes for errorMessage.
-
setErrorMessage
public UspsData.Builder setErrorMessage(String value)
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;- Parameters:
value- The errorMessage to set.- Returns:
- This builder for chaining.
-
clearErrorMessage
public UspsData.Builder clearErrorMessage()
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:
- This builder for chaining.
-
setErrorMessageBytes
public UspsData.Builder setErrorMessageBytes(com.google.protobuf.ByteString value)
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;- Parameters:
value- The bytes for errorMessage to set.- Returns:
- This builder for chaining.
-
getCassProcessed
public boolean getCassProcessed()
Indicator that the request has been CASS processed.
bool cass_processed = 28;- Specified by:
getCassProcessedin interfaceUspsDataOrBuilder- Returns:
- The cassProcessed.
-
setCassProcessed
public UspsData.Builder setCassProcessed(boolean value)
Indicator that the request has been CASS processed.
bool cass_processed = 28;- Parameters:
value- The cassProcessed to set.- Returns:
- This builder for chaining.
-
clearCassProcessed
public UspsData.Builder clearCassProcessed()
Indicator that the request has been CASS processed.
bool cass_processed = 28;- Returns:
- This builder for chaining.
-
setUnknownFields
public final UspsData.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
- Specified by:
setUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
setUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<UspsData.Builder>
-
mergeUnknownFields
public final UspsData.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
- Specified by:
mergeUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<UspsData.Builder>
-
-