Package com.google.type
Class PostalAddress.Builder
java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder<MessageType,BuilderType>
com.google.protobuf.GeneratedMessageLite.Builder<PostalAddress,PostalAddress.Builder>
com.google.type.PostalAddress.Builder
- All Implemented Interfaces:
com.google.protobuf.MessageLite.Builder
,com.google.protobuf.MessageLiteOrBuilder
,PostalAddressOrBuilder
,Cloneable
- Enclosing class:
- PostalAddress
public static final class PostalAddress.Builder
extends com.google.protobuf.GeneratedMessageLite.Builder<PostalAddress,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/6397478Protobuf type
google.type.PostalAddress
-
Field Summary
Fields inherited from class com.google.protobuf.GeneratedMessageLite.Builder
instance
-
Method Summary
Modifier and TypeMethodDescriptionaddAddressLines
(String value) Unstructured address lines describing the lower levels of an address.addAddressLinesBytes
(com.google.protobuf.ByteString value) Unstructured address lines describing the lower levels of an address.addAllAddressLines
(Iterable<String> values) Unstructured address lines describing the lower levels of an address.addAllRecipients
(Iterable<String> values) Optional.addRecipients
(String value) Optional.addRecipientsBytes
(com.google.protobuf.ByteString value) Optional.Unstructured address lines describing the lower levels of an address.Optional.Optional.Optional.Optional.Optional.Optional.Required.The schema revision of the `PostalAddress`.Optional.Optional.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
Unstructured address lines describing the lower levels of an address.Unstructured address lines describing the lower levels of an address.Optional.com.google.protobuf.ByteString
Optional.Optional.com.google.protobuf.ByteString
Optional.Optional.com.google.protobuf.ByteString
Optional.Optional.com.google.protobuf.ByteString
Optional.Optional.com.google.protobuf.ByteString
Optional.getRecipients
(int index) Optional.com.google.protobuf.ByteString
getRecipientsBytes
(int index) Optional.int
Optional.Optional.Required.com.google.protobuf.ByteString
Required.int
The schema revision of the `PostalAddress`.Optional.com.google.protobuf.ByteString
Optional.Optional.com.google.protobuf.ByteString
Optional.setAddressLines
(int index, String value) Unstructured address lines describing the lower levels of an address.setAdministrativeArea
(String value) Optional.setAdministrativeAreaBytes
(com.google.protobuf.ByteString value) Optional.setLanguageCode
(String value) Optional.setLanguageCodeBytes
(com.google.protobuf.ByteString value) Optional.setLocality
(String value) Optional.setLocalityBytes
(com.google.protobuf.ByteString value) Optional.setOrganization
(String value) Optional.setOrganizationBytes
(com.google.protobuf.ByteString value) Optional.setPostalCode
(String value) Optional.setPostalCodeBytes
(com.google.protobuf.ByteString value) Optional.setRecipients
(int index, String value) Optional.setRegionCode
(String value) Required.setRegionCodeBytes
(com.google.protobuf.ByteString value) Required.setRevision
(int value) The schema revision of the `PostalAddress`.setSortingCode
(String value) Optional.setSortingCodeBytes
(com.google.protobuf.ByteString value) Optional.setSublocality
(String value) Optional.setSublocalityBytes
(com.google.protobuf.ByteString value) Optional.Methods inherited from class com.google.protobuf.GeneratedMessageLite.Builder
build, buildPartial, clear, clone, copyOnWrite, copyOnWriteInternal, getDefaultInstanceForType, internalMergeFrom, isInitialized, mergeFrom, mergeFrom, mergeFrom, mergeFrom
Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
getDefaultInstanceForType, isInitialized
-
Method Details
-
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 [json_name = "revision"];
- Specified by:
getRevision
in interfacePostalAddressOrBuilder
- Returns:
- The revision.
-
setRevision
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 [json_name = "revision"];
- Parameters:
value
- The revision to set.- Returns:
- This builder for chaining.
-
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 [json_name = "revision"];
- Returns:
- This builder for chaining.
-
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 [json_name = "regionCode"];
- 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 [json_name = "regionCode"];
- Specified by:
getRegionCodeBytes
in interfacePostalAddressOrBuilder
- Returns:
- The bytes for regionCode.
-
setRegionCode
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 [json_name = "regionCode"];
- Parameters:
value
- The regionCode to set.- Returns:
- This builder for chaining.
-
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 [json_name = "regionCode"];
- Returns:
- This builder for chaining.
-
setRegionCodeBytes
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 [json_name = "regionCode"];
- Parameters:
value
- The bytes for regionCode to set.- Returns:
- This builder for chaining.
-
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 [json_name = "languageCode"];
- 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 [json_name = "languageCode"];
- Specified by:
getLanguageCodeBytes
in interfacePostalAddressOrBuilder
- Returns:
- The bytes for languageCode.
-
setLanguageCode
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 [json_name = "languageCode"];
- Parameters:
value
- The languageCode to set.- Returns:
- This builder for chaining.
-
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 [json_name = "languageCode"];
- Returns:
- This builder for chaining.
-
setLanguageCodeBytes
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 [json_name = "languageCode"];
- Parameters:
value
- The bytes for languageCode to set.- Returns:
- This builder for chaining.
-
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 [json_name = "postalCode"];
- 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 [json_name = "postalCode"];
- Specified by:
getPostalCodeBytes
in interfacePostalAddressOrBuilder
- Returns:
- The bytes for postalCode.
-
setPostalCode
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 [json_name = "postalCode"];
- Parameters:
value
- The postalCode to set.- Returns:
- This builder for chaining.
-
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 [json_name = "postalCode"];
- Returns:
- This builder for chaining.
-
setPostalCodeBytes
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 [json_name = "postalCode"];
- Parameters:
value
- The bytes for postalCode to set.- Returns:
- This builder for chaining.
-
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 [json_name = "sortingCode"];
- 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 [json_name = "sortingCode"];
- Specified by:
getSortingCodeBytes
in interfacePostalAddressOrBuilder
- Returns:
- The bytes for sortingCode.
-
setSortingCode
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 [json_name = "sortingCode"];
- Parameters:
value
- The sortingCode to set.- Returns:
- This builder for chaining.
-
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 [json_name = "sortingCode"];
- Returns:
- This builder for chaining.
-
setSortingCodeBytes
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 [json_name = "sortingCode"];
- Parameters:
value
- The bytes for sortingCode to set.- Returns:
- This builder for chaining.
-
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 [json_name = "administrativeArea"];
- 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 [json_name = "administrativeArea"];
- Specified by:
getAdministrativeAreaBytes
in interfacePostalAddressOrBuilder
- Returns:
- The bytes for administrativeArea.
-
setAdministrativeArea
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 [json_name = "administrativeArea"];
- Parameters:
value
- The administrativeArea to set.- Returns:
- This builder for chaining.
-
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 [json_name = "administrativeArea"];
- Returns:
- This builder for chaining.
-
setAdministrativeAreaBytes
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 [json_name = "administrativeArea"];
- Parameters:
value
- The bytes for administrativeArea to set.- Returns:
- This builder for chaining.
-
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 [json_name = "locality"];
- 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 [json_name = "locality"];
- Specified by:
getLocalityBytes
in interfacePostalAddressOrBuilder
- Returns:
- The bytes for locality.
-
setLocality
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 [json_name = "locality"];
- Parameters:
value
- The locality to set.- Returns:
- This builder for chaining.
-
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 [json_name = "locality"];
- Returns:
- This builder for chaining.
-
setLocalityBytes
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 [json_name = "locality"];
- Parameters:
value
- The bytes for locality to set.- Returns:
- This builder for chaining.
-
getSublocality
Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
string sublocality = 8 [json_name = "sublocality"];
- 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 [json_name = "sublocality"];
- Specified by:
getSublocalityBytes
in interfacePostalAddressOrBuilder
- Returns:
- The bytes for sublocality.
-
setSublocality
Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
string sublocality = 8 [json_name = "sublocality"];
- Parameters:
value
- The sublocality to set.- Returns:
- This builder for chaining.
-
clearSublocality
Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
string sublocality = 8 [json_name = "sublocality"];
- Returns:
- This builder for chaining.
-
setSublocalityBytes
Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
string sublocality = 8 [json_name = "sublocality"];
- Parameters:
value
- The bytes for sublocality to set.- Returns:
- This builder for chaining.
-
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 [json_name = "addressLines"];
- 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 [json_name = "addressLines"];
- Specified by:
getAddressLinesCount
in interfacePostalAddressOrBuilder
- Returns:
- The count of addressLines.
-
getAddressLines
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 [json_name = "addressLines"];
- 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 [json_name = "addressLines"];
- 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
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 [json_name = "addressLines"];
- Parameters:
index
- The index to set the value at.value
- The addressLines to set.- Returns:
- This builder for chaining.
-
addAddressLines
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 [json_name = "addressLines"];
- Parameters:
value
- The addressLines to add.- Returns:
- This builder for chaining.
-
addAllAddressLines
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 [json_name = "addressLines"];
- Parameters:
values
- The addressLines to add.- Returns:
- This builder for chaining.
-
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 [json_name = "addressLines"];
- Returns:
- This builder for chaining.
-
addAddressLinesBytes
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 [json_name = "addressLines"];
- Parameters:
value
- The bytes of the addressLines to add.- Returns:
- This builder for chaining.
-
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 [json_name = "recipients"];
- 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 [json_name = "recipients"];
- Specified by:
getRecipientsCount
in interfacePostalAddressOrBuilder
- Returns:
- The count of recipients.
-
getRecipients
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 [json_name = "recipients"];
- 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 [json_name = "recipients"];
- 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
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 [json_name = "recipients"];
- Parameters:
index
- The index to set the value at.value
- The recipients to set.- Returns:
- This builder for chaining.
-
addRecipients
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 [json_name = "recipients"];
- Parameters:
value
- The recipients to add.- Returns:
- This builder for chaining.
-
addAllRecipients
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 [json_name = "recipients"];
- Parameters:
values
- The recipients to add.- Returns:
- This builder for chaining.
-
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 [json_name = "recipients"];
- Returns:
- This builder for chaining.
-
addRecipientsBytes
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 [json_name = "recipients"];
- Parameters:
value
- The bytes of the recipients to add.- Returns:
- This builder for chaining.
-
getOrganization
Optional. The name of the organization at the address.
string organization = 11 [json_name = "organization"];
- 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 [json_name = "organization"];
- Specified by:
getOrganizationBytes
in interfacePostalAddressOrBuilder
- Returns:
- The bytes for organization.
-
setOrganization
Optional. The name of the organization at the address.
string organization = 11 [json_name = "organization"];
- Parameters:
value
- The organization to set.- Returns:
- This builder for chaining.
-
clearOrganization
Optional. The name of the organization at the address.
string organization = 11 [json_name = "organization"];
- Returns:
- This builder for chaining.
-
setOrganizationBytes
Optional. The name of the organization at the address.
string organization = 11 [json_name = "organization"];
- Parameters:
value
- The bytes for organization to set.- Returns:
- This builder for chaining.
-