Package com.google.type
Class PostalAddress.Builder
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite.Builder
-
- com.google.protobuf.AbstractMessage.Builder<BuilderT>
-
- com.google.protobuf.GeneratedMessage.Builder<BuilderT>
-
- com.google.protobuf.GeneratedMessage.ExtendableBuilder<com.google.protobuf.GeneratedMessageV3,BuilderT>
-
- com.google.protobuf.GeneratedMessageV3.Builder<PostalAddress.Builder>
-
- com.google.type.PostalAddress.Builder
-
- All Implemented Interfaces:
com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<com.google.protobuf.GeneratedMessageV3>
,com.google.protobuf.Message.Builder
,com.google.protobuf.MessageLite.Builder
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,PostalAddressOrBuilder
,java.lang.Cloneable
- Enclosing class:
- PostalAddress
public static final class PostalAddress.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<PostalAddress.Builder> implements PostalAddressOrBuilder
Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478
Protobuf typegoogle.type.PostalAddress
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description PostalAddress.Builder
addAddressLines(java.lang.String value)
Unstructured address lines describing the lower levels of an address.PostalAddress.Builder
addAddressLinesBytes(com.google.protobuf.ByteString value)
Unstructured address lines describing the lower levels of an address.PostalAddress.Builder
addAllAddressLines(java.lang.Iterable<java.lang.String> values)
Unstructured address lines describing the lower levels of an address.PostalAddress.Builder
addAllRecipients(java.lang.Iterable<java.lang.String> values)
Optional.PostalAddress.Builder
addRecipients(java.lang.String value)
Optional.PostalAddress.Builder
addRecipientsBytes(com.google.protobuf.ByteString value)
Optional.PostalAddress.Builder
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
PostalAddress
build()
PostalAddress
buildPartial()
PostalAddress.Builder
clear()
PostalAddress.Builder
clearAddressLines()
Unstructured address lines describing the lower levels of an address.PostalAddress.Builder
clearAdministrativeArea()
Optional.PostalAddress.Builder
clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
PostalAddress.Builder
clearLanguageCode()
Optional.PostalAddress.Builder
clearLocality()
Optional.PostalAddress.Builder
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
PostalAddress.Builder
clearOrganization()
Optional.PostalAddress.Builder
clearPostalCode()
Optional.PostalAddress.Builder
clearRecipients()
Optional.PostalAddress.Builder
clearRegionCode()
Required.PostalAddress.Builder
clearRevision()
The schema revision of the `PostalAddress`.PostalAddress.Builder
clearSortingCode()
Optional.PostalAddress.Builder
clearSublocality()
Optional.PostalAddress.Builder
clone()
java.lang.String
getAddressLines(int index)
Unstructured address lines describing the lower levels of an address.com.google.protobuf.ByteString
getAddressLinesBytes(int index)
Unstructured address lines describing the lower levels of an address.int
getAddressLinesCount()
Unstructured address lines describing the lower levels of an address.com.google.protobuf.ProtocolStringList
getAddressLinesList()
Unstructured address lines describing the lower levels of an address.java.lang.String
getAdministrativeArea()
Optional.com.google.protobuf.ByteString
getAdministrativeAreaBytes()
Optional.PostalAddress
getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor
getDescriptor()
com.google.protobuf.Descriptors.Descriptor
getDescriptorForType()
java.lang.String
getLanguageCode()
Optional.com.google.protobuf.ByteString
getLanguageCodeBytes()
Optional.java.lang.String
getLocality()
Optional.com.google.protobuf.ByteString
getLocalityBytes()
Optional.java.lang.String
getOrganization()
Optional.com.google.protobuf.ByteString
getOrganizationBytes()
Optional.java.lang.String
getPostalCode()
Optional.com.google.protobuf.ByteString
getPostalCodeBytes()
Optional.java.lang.String
getRecipients(int index)
Optional.com.google.protobuf.ByteString
getRecipientsBytes(int index)
Optional.int
getRecipientsCount()
Optional.com.google.protobuf.ProtocolStringList
getRecipientsList()
Optional.java.lang.String
getRegionCode()
Required.com.google.protobuf.ByteString
getRegionCodeBytes()
Required.int
getRevision()
The schema revision of the `PostalAddress`.java.lang.String
getSortingCode()
Optional.com.google.protobuf.ByteString
getSortingCodeBytes()
Optional.java.lang.String
getSublocality()
Optional.com.google.protobuf.ByteString
getSublocalityBytes()
Optional.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
internalGetFieldAccessorTable()
boolean
isInitialized()
PostalAddress.Builder
mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
PostalAddress.Builder
mergeFrom(com.google.protobuf.Message other)
PostalAddress.Builder
mergeFrom(PostalAddress other)
PostalAddress.Builder
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
PostalAddress.Builder
setAddressLines(int index, java.lang.String value)
Unstructured address lines describing the lower levels of an address.PostalAddress.Builder
setAdministrativeArea(java.lang.String value)
Optional.PostalAddress.Builder
setAdministrativeAreaBytes(com.google.protobuf.ByteString value)
Optional.PostalAddress.Builder
setField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
PostalAddress.Builder
setLanguageCode(java.lang.String value)
Optional.PostalAddress.Builder
setLanguageCodeBytes(com.google.protobuf.ByteString value)
Optional.PostalAddress.Builder
setLocality(java.lang.String value)
Optional.PostalAddress.Builder
setLocalityBytes(com.google.protobuf.ByteString value)
Optional.PostalAddress.Builder
setOrganization(java.lang.String value)
Optional.PostalAddress.Builder
setOrganizationBytes(com.google.protobuf.ByteString value)
Optional.PostalAddress.Builder
setPostalCode(java.lang.String value)
Optional.PostalAddress.Builder
setPostalCodeBytes(com.google.protobuf.ByteString value)
Optional.PostalAddress.Builder
setRecipients(int index, java.lang.String value)
Optional.PostalAddress.Builder
setRegionCode(java.lang.String value)
Required.PostalAddress.Builder
setRegionCodeBytes(com.google.protobuf.ByteString value)
Required.PostalAddress.Builder
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value)
PostalAddress.Builder
setRevision(int value)
The schema revision of the `PostalAddress`.PostalAddress.Builder
setSortingCode(java.lang.String value)
Optional.PostalAddress.Builder
setSortingCodeBytes(com.google.protobuf.ByteString value)
Optional.PostalAddress.Builder
setSublocality(java.lang.String value)
Optional.PostalAddress.Builder
setSublocalityBytes(com.google.protobuf.ByteString value)
Optional.PostalAddress.Builder
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
-
Methods inherited from class com.google.protobuf.GeneratedMessage.ExtendableBuilder
addExtension, clearExtension, extensionsAreInitialized, getAllFields, getExtension, getExtension, getExtensionCount, getField, getFieldBuilder, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, hasExtension, hasField, mergeExtensionFields, newBuilderForField, parseUnknownField, setExtension, setExtension
-
Methods inherited from class com.google.protobuf.GeneratedMessage.Builder
getOneofFieldDescriptor, getUnknownFields, getUnknownFieldSetBuilder, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, onBuilt, onChanged, 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()
- Overrides:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessageV3.Builder<PostalAddress.Builder>
-
clear
public PostalAddress.Builder clear()
- Specified by:
clear
in interfacecom.google.protobuf.Message.Builder
- Specified by:
clear
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
clear
in classcom.google.protobuf.GeneratedMessageV3.Builder<PostalAddress.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.Message.Builder
- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.MessageOrBuilder
- Overrides:
getDescriptorForType
in classcom.google.protobuf.GeneratedMessage.Builder<PostalAddress.Builder>
-
getDefaultInstanceForType
public PostalAddress getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<com.google.protobuf.GeneratedMessageV3>
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
build
public PostalAddress build()
- Specified by:
build
in interfacecom.google.protobuf.Message.Builder
- Specified by:
build
in interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
public PostalAddress buildPartial()
- Specified by:
buildPartial
in interfacecom.google.protobuf.Message.Builder
- Specified by:
buildPartial
in interfacecom.google.protobuf.MessageLite.Builder
-
clone
public PostalAddress.Builder clone()
- Specified by:
clone
in interfacecom.google.protobuf.Message.Builder
- Specified by:
clone
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
clone
in classcom.google.protobuf.GeneratedMessageV3.Builder<PostalAddress.Builder>
-
setField
public PostalAddress.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
- Specified by:
setField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setField
in classcom.google.protobuf.GeneratedMessageV3.Builder<PostalAddress.Builder>
-
clearField
public PostalAddress.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
- Specified by:
clearField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
clearField
in classcom.google.protobuf.GeneratedMessageV3.Builder<PostalAddress.Builder>
-
clearOneof
public PostalAddress.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
- Specified by:
clearOneof
in interfacecom.google.protobuf.Message.Builder
- Overrides:
clearOneof
in classcom.google.protobuf.GeneratedMessageV3.Builder<PostalAddress.Builder>
-
setRepeatedField
public PostalAddress.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value)
- Specified by:
setRepeatedField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setRepeatedField
in classcom.google.protobuf.GeneratedMessageV3.Builder<PostalAddress.Builder>
-
addRepeatedField
public PostalAddress.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
- Specified by:
addRepeatedField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
addRepeatedField
in classcom.google.protobuf.GeneratedMessageV3.Builder<PostalAddress.Builder>
-
mergeFrom
public PostalAddress.Builder mergeFrom(com.google.protobuf.Message other)
- Specified by:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<PostalAddress.Builder>
-
mergeFrom
public PostalAddress.Builder mergeFrom(PostalAddress other)
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessage.ExtendableBuilder<com.google.protobuf.GeneratedMessageV3,PostalAddress.Builder>
-
mergeFrom
public PostalAddress.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Specified by:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Specified by:
mergeFrom
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<PostalAddress.Builder>
- Throws:
java.io.IOException
-
getRevision
public int getRevision()
The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
int32 revision = 1;
- Specified by:
getRevision
in interfacePostalAddressOrBuilder
- Returns:
- The revision.
-
setRevision
public PostalAddress.Builder setRevision(int value)
The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
int32 revision = 1;
- Parameters:
value
- The revision to set.- Returns:
- This builder for chaining.
-
clearRevision
public PostalAddress.Builder clearRevision()
The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
int32 revision = 1;
- Returns:
- This builder for chaining.
-
getRegionCode
public java.lang.String getRegionCode()
Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
string region_code = 2;
- Specified by:
getRegionCode
in interfacePostalAddressOrBuilder
- Returns:
- The regionCode.
-
getRegionCodeBytes
public com.google.protobuf.ByteString getRegionCodeBytes()
Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
string region_code = 2;
- Specified by:
getRegionCodeBytes
in interfacePostalAddressOrBuilder
- Returns:
- The bytes for regionCode.
-
setRegionCode
public PostalAddress.Builder setRegionCode(java.lang.String value)
Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
string region_code = 2;
- Parameters:
value
- The regionCode to set.- Returns:
- This builder for chaining.
-
clearRegionCode
public PostalAddress.Builder clearRegionCode()
Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
string region_code = 2;
- Returns:
- This builder for chaining.
-
setRegionCodeBytes
public PostalAddress.Builder setRegionCodeBytes(com.google.protobuf.ByteString value)
Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
string region_code = 2;
- Parameters:
value
- The bytes for regionCode to set.- Returns:
- This builder for chaining.
-
getLanguageCode
public java.lang.String getLanguageCode()
Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
string language_code = 3;
- Specified by:
getLanguageCode
in interfacePostalAddressOrBuilder
- Returns:
- The languageCode.
-
getLanguageCodeBytes
public com.google.protobuf.ByteString getLanguageCodeBytes()
Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
string language_code = 3;
- Specified by:
getLanguageCodeBytes
in interfacePostalAddressOrBuilder
- Returns:
- The bytes for languageCode.
-
setLanguageCode
public PostalAddress.Builder setLanguageCode(java.lang.String value)
Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
string language_code = 3;
- Parameters:
value
- The languageCode to set.- Returns:
- This builder for chaining.
-
clearLanguageCode
public PostalAddress.Builder clearLanguageCode()
Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
string language_code = 3;
- Returns:
- This builder for chaining.
-
setLanguageCodeBytes
public PostalAddress.Builder setLanguageCodeBytes(com.google.protobuf.ByteString value)
Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
string language_code = 3;
- Parameters:
value
- The bytes for languageCode to set.- Returns:
- This builder for chaining.
-
getPostalCode
public java.lang.String getPostalCode()
Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.).
string postal_code = 4;
- Specified by:
getPostalCode
in interfacePostalAddressOrBuilder
- Returns:
- The postalCode.
-
getPostalCodeBytes
public com.google.protobuf.ByteString getPostalCodeBytes()
Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.).
string postal_code = 4;
- Specified by:
getPostalCodeBytes
in interfacePostalAddressOrBuilder
- Returns:
- The bytes for postalCode.
-
setPostalCode
public PostalAddress.Builder setPostalCode(java.lang.String value)
Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.).
string postal_code = 4;
- Parameters:
value
- The postalCode to set.- Returns:
- This builder for chaining.
-
clearPostalCode
public PostalAddress.Builder clearPostalCode()
Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.).
string postal_code = 4;
- Returns:
- This builder for chaining.
-
setPostalCodeBytes
public PostalAddress.Builder setPostalCodeBytes(com.google.protobuf.ByteString value)
Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.).
string postal_code = 4;
- Parameters:
value
- The bytes for postalCode to set.- Returns:
- This builder for chaining.
-
getSortingCode
public java.lang.String getSortingCode()
Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
string sorting_code = 5;
- Specified by:
getSortingCode
in interfacePostalAddressOrBuilder
- Returns:
- The sortingCode.
-
getSortingCodeBytes
public com.google.protobuf.ByteString getSortingCodeBytes()
Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
string sorting_code = 5;
- Specified by:
getSortingCodeBytes
in interfacePostalAddressOrBuilder
- Returns:
- The bytes for sortingCode.
-
setSortingCode
public PostalAddress.Builder setSortingCode(java.lang.String value)
Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
string sorting_code = 5;
- Parameters:
value
- The sortingCode to set.- Returns:
- This builder for chaining.
-
clearSortingCode
public PostalAddress.Builder clearSortingCode()
Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
string sorting_code = 5;
- Returns:
- This builder for chaining.
-
setSortingCodeBytes
public PostalAddress.Builder setSortingCodeBytes(com.google.protobuf.ByteString value)
Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
string sorting_code = 5;
- Parameters:
value
- The bytes for sortingCode to set.- Returns:
- This builder for chaining.
-
getAdministrativeArea
public java.lang.String getAdministrativeArea()
Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.
string administrative_area = 6;
- Specified by:
getAdministrativeArea
in interfacePostalAddressOrBuilder
- Returns:
- The administrativeArea.
-
getAdministrativeAreaBytes
public com.google.protobuf.ByteString getAdministrativeAreaBytes()
Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.
string administrative_area = 6;
- Specified by:
getAdministrativeAreaBytes
in interfacePostalAddressOrBuilder
- Returns:
- The bytes for administrativeArea.
-
setAdministrativeArea
public PostalAddress.Builder setAdministrativeArea(java.lang.String value)
Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.
string administrative_area = 6;
- Parameters:
value
- The administrativeArea to set.- Returns:
- This builder for chaining.
-
clearAdministrativeArea
public PostalAddress.Builder clearAdministrativeArea()
Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.
string administrative_area = 6;
- Returns:
- This builder for chaining.
-
setAdministrativeAreaBytes
public PostalAddress.Builder setAdministrativeAreaBytes(com.google.protobuf.ByteString value)
Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.
string administrative_area = 6;
- Parameters:
value
- The bytes for administrativeArea to set.- Returns:
- This builder for chaining.
-
getLocality
public java.lang.String getLocality()
Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
string locality = 7;
- Specified by:
getLocality
in interfacePostalAddressOrBuilder
- Returns:
- The locality.
-
getLocalityBytes
public com.google.protobuf.ByteString getLocalityBytes()
Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
string locality = 7;
- Specified by:
getLocalityBytes
in interfacePostalAddressOrBuilder
- Returns:
- The bytes for locality.
-
setLocality
public PostalAddress.Builder setLocality(java.lang.String value)
Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
string locality = 7;
- Parameters:
value
- The locality to set.- Returns:
- This builder for chaining.
-
clearLocality
public PostalAddress.Builder clearLocality()
Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
string locality = 7;
- Returns:
- This builder for chaining.
-
setLocalityBytes
public PostalAddress.Builder setLocalityBytes(com.google.protobuf.ByteString value)
Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
string locality = 7;
- Parameters:
value
- The bytes for locality to set.- Returns:
- This builder for chaining.
-
getSublocality
public java.lang.String getSublocality()
Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
string sublocality = 8;
- Specified by:
getSublocality
in interfacePostalAddressOrBuilder
- Returns:
- The sublocality.
-
getSublocalityBytes
public com.google.protobuf.ByteString getSublocalityBytes()
Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
string sublocality = 8;
- Specified by:
getSublocalityBytes
in interfacePostalAddressOrBuilder
- Returns:
- The bytes for sublocality.
-
setSublocality
public PostalAddress.Builder setSublocality(java.lang.String value)
Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
string sublocality = 8;
- Parameters:
value
- The sublocality to set.- Returns:
- This builder for chaining.
-
clearSublocality
public PostalAddress.Builder clearSublocality()
Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
string sublocality = 8;
- Returns:
- This builder for chaining.
-
setSublocalityBytes
public PostalAddress.Builder setSublocalityBytes(com.google.protobuf.ByteString value)
Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
string sublocality = 8;
- Parameters:
value
- The bytes for sublocality to set.- Returns:
- This builder for chaining.
-
getAddressLinesList
public com.google.protobuf.ProtocolStringList getAddressLinesList()
Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
repeated string address_lines = 9;
- Specified by:
getAddressLinesList
in interfacePostalAddressOrBuilder
- Returns:
- A list containing the addressLines.
-
getAddressLinesCount
public int getAddressLinesCount()
Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
repeated string address_lines = 9;
- Specified by:
getAddressLinesCount
in interfacePostalAddressOrBuilder
- Returns:
- The count of addressLines.
-
getAddressLines
public java.lang.String getAddressLines(int index)
Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
repeated string address_lines = 9;
- Specified by:
getAddressLines
in interfacePostalAddressOrBuilder
- Parameters:
index
- The index of the element to return.- Returns:
- The addressLines at the given index.
-
getAddressLinesBytes
public com.google.protobuf.ByteString getAddressLinesBytes(int index)
Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
repeated string address_lines = 9;
- Specified by:
getAddressLinesBytes
in interfacePostalAddressOrBuilder
- Parameters:
index
- The index of the value to return.- Returns:
- The bytes of the addressLines at the given index.
-
setAddressLines
public PostalAddress.Builder setAddressLines(int index, java.lang.String value)
Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
repeated string address_lines = 9;
- Parameters:
index
- The index to set the value at.value
- The addressLines to set.- Returns:
- This builder for chaining.
-
addAddressLines
public PostalAddress.Builder addAddressLines(java.lang.String value)
Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
repeated string address_lines = 9;
- Parameters:
value
- The addressLines to add.- Returns:
- This builder for chaining.
-
addAllAddressLines
public PostalAddress.Builder addAllAddressLines(java.lang.Iterable<java.lang.String> values)
Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
repeated string address_lines = 9;
- Parameters:
values
- The addressLines to add.- Returns:
- This builder for chaining.
-
clearAddressLines
public PostalAddress.Builder clearAddressLines()
Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
repeated string address_lines = 9;
- Returns:
- This builder for chaining.
-
addAddressLinesBytes
public PostalAddress.Builder addAddressLinesBytes(com.google.protobuf.ByteString value)
Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
repeated string address_lines = 9;
- Parameters:
value
- The bytes of the addressLines to add.- Returns:
- This builder for chaining.
-
getRecipientsList
public com.google.protobuf.ProtocolStringList getRecipientsList()
Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
repeated string recipients = 10;
- Specified by:
getRecipientsList
in interfacePostalAddressOrBuilder
- Returns:
- A list containing the recipients.
-
getRecipientsCount
public int getRecipientsCount()
Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
repeated string recipients = 10;
- Specified by:
getRecipientsCount
in interfacePostalAddressOrBuilder
- Returns:
- The count of recipients.
-
getRecipients
public java.lang.String getRecipients(int index)
Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
repeated string recipients = 10;
- Specified by:
getRecipients
in interfacePostalAddressOrBuilder
- Parameters:
index
- The index of the element to return.- Returns:
- The recipients at the given index.
-
getRecipientsBytes
public com.google.protobuf.ByteString getRecipientsBytes(int index)
Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
repeated string recipients = 10;
- Specified by:
getRecipientsBytes
in interfacePostalAddressOrBuilder
- Parameters:
index
- The index of the value to return.- Returns:
- The bytes of the recipients at the given index.
-
setRecipients
public PostalAddress.Builder setRecipients(int index, java.lang.String value)
Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
repeated string recipients = 10;
- Parameters:
index
- The index to set the value at.value
- The recipients to set.- Returns:
- This builder for chaining.
-
addRecipients
public PostalAddress.Builder addRecipients(java.lang.String value)
Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
repeated string recipients = 10;
- Parameters:
value
- The recipients to add.- Returns:
- This builder for chaining.
-
addAllRecipients
public PostalAddress.Builder addAllRecipients(java.lang.Iterable<java.lang.String> values)
Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
repeated string recipients = 10;
- Parameters:
values
- The recipients to add.- Returns:
- This builder for chaining.
-
clearRecipients
public PostalAddress.Builder clearRecipients()
Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
repeated string recipients = 10;
- Returns:
- This builder for chaining.
-
addRecipientsBytes
public PostalAddress.Builder addRecipientsBytes(com.google.protobuf.ByteString value)
Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
repeated string recipients = 10;
- Parameters:
value
- The bytes of the recipients to add.- Returns:
- This builder for chaining.
-
getOrganization
public java.lang.String getOrganization()
Optional. The name of the organization at the address.
string organization = 11;
- Specified by:
getOrganization
in interfacePostalAddressOrBuilder
- Returns:
- The organization.
-
getOrganizationBytes
public com.google.protobuf.ByteString getOrganizationBytes()
Optional. The name of the organization at the address.
string organization = 11;
- Specified by:
getOrganizationBytes
in interfacePostalAddressOrBuilder
- Returns:
- The bytes for organization.
-
setOrganization
public PostalAddress.Builder setOrganization(java.lang.String value)
Optional. The name of the organization at the address.
string organization = 11;
- Parameters:
value
- The organization to set.- Returns:
- This builder for chaining.
-
clearOrganization
public PostalAddress.Builder clearOrganization()
Optional. The name of the organization at the address.
string organization = 11;
- Returns:
- This builder for chaining.
-
setOrganizationBytes
public PostalAddress.Builder setOrganizationBytes(com.google.protobuf.ByteString value)
Optional. The name of the organization at the address.
string organization = 11;
- Parameters:
value
- The bytes for organization to set.- Returns:
- This builder for chaining.
-
setUnknownFields
public final PostalAddress.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
- Specified by:
setUnknownFields
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setUnknownFields
in classcom.google.protobuf.GeneratedMessageV3.Builder<PostalAddress.Builder>
-
mergeUnknownFields
public final PostalAddress.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
- Specified by:
mergeUnknownFields
in interfacecom.google.protobuf.Message.Builder
- Overrides:
mergeUnknownFields
in classcom.google.protobuf.GeneratedMessageV3.Builder<PostalAddress.Builder>
-
-