Package com.google.type
Interface PostalAddressOrBuilder
-
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
PostalAddress
,PostalAddress.Builder
public interface PostalAddressOrBuilder extends com.google.protobuf.MessageOrBuilder
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description 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.java.util.List<java.lang.String>
getAddressLinesList()
Unstructured address lines describing the lower levels of an address.java.lang.String
getAdministrativeArea()
Optional.com.google.protobuf.ByteString
getAdministrativeAreaBytes()
Optional.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.java.util.List<java.lang.String>
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.-
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
-
-
-
Method Detail
-
getRevision
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;
- Returns:
- The revision.
-
getRegionCode
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;
- Returns:
- The regionCode.
-
getRegionCodeBytes
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;
- Returns:
- The bytes for regionCode.
-
getLanguageCode
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;
- Returns:
- The languageCode.
-
getLanguageCodeBytes
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;
- Returns:
- The bytes for languageCode.
-
getPostalCode
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;
- Returns:
- The postalCode.
-
getPostalCodeBytes
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;
- Returns:
- The bytes for postalCode.
-
getSortingCode
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;
- Returns:
- The sortingCode.
-
getSortingCodeBytes
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;
- Returns:
- The bytes for sortingCode.
-
getAdministrativeArea
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;
- Returns:
- The administrativeArea.
-
getAdministrativeAreaBytes
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;
- Returns:
- The bytes for administrativeArea.
-
getLocality
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;
- Returns:
- The locality.
-
getLocalityBytes
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;
- Returns:
- The bytes for locality.
-
getSublocality
java.lang.String getSublocality()
Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
string sublocality = 8;
- Returns:
- The sublocality.
-
getSublocalityBytes
com.google.protobuf.ByteString getSublocalityBytes()
Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
string sublocality = 8;
- Returns:
- The bytes for sublocality.
-
getAddressLinesList
java.util.List<java.lang.String> 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;
- Returns:
- A list containing the addressLines.
-
getAddressLinesCount
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;
- Returns:
- The count of addressLines.
-
getAddressLines
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;
- Parameters:
index
- The index of the element to return.- Returns:
- The addressLines at the given index.
-
getAddressLinesBytes
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;
- Parameters:
index
- The index of the value to return.- Returns:
- The bytes of the addressLines at the given index.
-
getRecipientsList
java.util.List<java.lang.String> 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;
- Returns:
- A list containing the recipients.
-
getRecipientsCount
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;
- Returns:
- The count of recipients.
-
getRecipients
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;
- Parameters:
index
- The index of the element to return.- Returns:
- The recipients at the given index.
-
getRecipientsBytes
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;
- Parameters:
index
- The index of the value to return.- Returns:
- The bytes of the recipients at the given index.
-
getOrganization
java.lang.String getOrganization()
Optional. The name of the organization at the address.
string organization = 11;
- Returns:
- The organization.
-
getOrganizationBytes
com.google.protobuf.ByteString getOrganizationBytes()
Optional. The name of the organization at the address.
string organization = 11;
- Returns:
- The bytes for organization.
-
-