Package com.google.type

Class PostalAddress

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.type.PostalAddress
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, PostalAddressOrBuilder, Serializable
public final class PostalAddress extends com.google.protobuf.GeneratedMessageV3 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 type google.type.PostalAddress
See Also:

  • Field Details

    • REVISION_FIELD_NUMBER

      public static final int REVISION_FIELD_NUMBER
      See Also:

    • REGION_CODE_FIELD_NUMBER

      public static final int REGION_CODE_FIELD_NUMBER
      See Also:

    • LANGUAGE_CODE_FIELD_NUMBER

      public static final int LANGUAGE_CODE_FIELD_NUMBER
      See Also:

    • POSTAL_CODE_FIELD_NUMBER

      public static final int POSTAL_CODE_FIELD_NUMBER
      See Also:

    • SORTING_CODE_FIELD_NUMBER

      public static final int SORTING_CODE_FIELD_NUMBER
      See Also:

    • ADMINISTRATIVE_AREA_FIELD_NUMBER

      public static final int ADMINISTRATIVE_AREA_FIELD_NUMBER
      See Also:

    • LOCALITY_FIELD_NUMBER

      public static final int LOCALITY_FIELD_NUMBER
      See Also:

    • SUBLOCALITY_FIELD_NUMBER

      public static final int SUBLOCALITY_FIELD_NUMBER
      See Also:

    • ADDRESS_LINES_FIELD_NUMBER

      public static final int ADDRESS_LINES_FIELD_NUMBER
      See Also:

    • RECIPIENTS_FIELD_NUMBER

      public static final int RECIPIENTS_FIELD_NUMBER
      See Also:

    • ORGANIZATION_FIELD_NUMBER

      public static final int ORGANIZATION_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

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

    • internalGetFieldAccessorTable

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

    • 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 interface PostalAddressOrBuilder
      Returns:
      The revision.

    • getRegionCode

      public 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 interface PostalAddressOrBuilder
      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 interface PostalAddressOrBuilder
      Returns:
      The bytes for regionCode.

    • getLanguageCode

      public 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 interface PostalAddressOrBuilder
      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 interface PostalAddressOrBuilder
      Returns:
      The bytes for languageCode.

    • getPostalCode

      public 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 interface PostalAddressOrBuilder
      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 interface PostalAddressOrBuilder
      Returns:
      The bytes for postalCode.

    • getSortingCode

      public 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 interface PostalAddressOrBuilder
      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 interface PostalAddressOrBuilder
      Returns:
      The bytes for sortingCode.

    • getAdministrativeArea

      public 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 interface PostalAddressOrBuilder
      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 interface PostalAddressOrBuilder
      Returns:
      The bytes for administrativeArea.

    • getLocality

      public 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 interface PostalAddressOrBuilder
      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 interface PostalAddressOrBuilder
      Returns:
      The bytes for locality.

    • getSublocality

      public String getSublocality()
       Optional. Sublocality of the address.
 For example, this can be neighborhoods, boroughs, districts.
      string sublocality = 8;
      Specified by:
      getSublocality in interface PostalAddressOrBuilder
      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 interface PostalAddressOrBuilder
      Returns:
      The bytes for sublocality.

    • 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 interface PostalAddressOrBuilder
      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 interface PostalAddressOrBuilder
      Returns:
      The count of addressLines.

    • getAddressLines

      public 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 interface PostalAddressOrBuilder
      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 interface PostalAddressOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the addressLines at the given index.

    • 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 interface PostalAddressOrBuilder
      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 interface PostalAddressOrBuilder
      Returns:
      The count of recipients.

    • getRecipients

      public 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 interface PostalAddressOrBuilder
      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 interface PostalAddressOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the recipients at the given index.

    • getOrganization

      public String getOrganization()
       Optional. The name of the organization at the address.
      string organization = 11;
      Specified by:
      getOrganization in interface PostalAddressOrBuilder
      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 interface PostalAddressOrBuilder
      Returns:
      The bytes for organization.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static PostalAddress parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static PostalAddress parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static PostalAddress parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static PostalAddress parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static PostalAddress parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

      public static PostalAddress parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • newBuilderForType

      public PostalAddress.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static PostalAddress.Builder newBuilder()

    • newBuilder

      public static PostalAddress.Builder newBuilder(PostalAddress prototype)

    • toBuilder

      public PostalAddress.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected PostalAddress.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static PostalAddress getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<PostalAddress> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public PostalAddress getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder