public static final class PostalAddress.Builder extends GeneratedMessageV3.Builder<PostalAddress.Builder> implements PostalAddressOrBuilderRepresents 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
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > PostalAddress.BuilderImplements
PostalAddressOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
Methods
addAddressLines(String value)
public PostalAddress.Builder addAddressLines(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;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe addressLines to add. |
| Returns | |
|---|---|
| Type | Description |
PostalAddress.Builder | This builder for chaining. |
addAddressLinesBytes(ByteString value)
public PostalAddress.Builder addAddressLinesBytes(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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes of the addressLines to add. |
| Returns | |
|---|---|
| Type | Description |
PostalAddress.Builder | This builder for chaining. |
addAllAddressLines(Iterable<String> values)
public PostalAddress.Builder addAllAddressLines(Iterable<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;
| Parameter | |
|---|---|
| Name | Description |
values | Iterable<String>The addressLines to add. |
| Returns | |
|---|---|
| Type | Description |
PostalAddress.Builder | This builder for chaining. |
addAllRecipients(Iterable<String> values)
public PostalAddress.Builder addAllRecipients(Iterable<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;
| Parameter | |
|---|---|
| Name | Description |
values | Iterable<String>The recipients to add. |
| Returns | |
|---|---|
| Type | Description |
PostalAddress.Builder | This builder for chaining. |
addRecipients(String value)
public PostalAddress.Builder addRecipients(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;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe recipients to add. |
| Returns | |
|---|---|
| Type | Description |
PostalAddress.Builder | This builder for chaining. |
addRecipientsBytes(ByteString value)
public PostalAddress.Builder addRecipientsBytes(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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes of the recipients to add. |
| Returns | |
|---|---|
| Type | Description |
PostalAddress.Builder | This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public PostalAddress.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
PostalAddress.Builder | |
build()
public PostalAddress build()| Returns | |
|---|---|
| Type | Description |
PostalAddress | |
buildPartial()
public PostalAddress buildPartial()| Returns | |
|---|---|
| Type | Description |
PostalAddress | |
clear()
public PostalAddress.Builder clear()| Returns | |
|---|---|
| Type | Description |
PostalAddress.Builder | |
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 | |
|---|---|
| Type | Description |
PostalAddress.Builder | 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 | |
|---|---|
| Type | Description |
PostalAddress.Builder | This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public PostalAddress.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field | FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
PostalAddress.Builder | |
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 | |
|---|---|
| Type | Description |
PostalAddress.Builder | 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 | |
|---|---|
| Type | Description |
PostalAddress.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public PostalAddress.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof | OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
PostalAddress.Builder | |
clearOrganization()
public PostalAddress.Builder clearOrganization()Optional. The name of the organization at the address.
string organization = 11;
| Returns | |
|---|---|
| Type | Description |
PostalAddress.Builder | 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 | |
|---|---|
| Type | Description |
PostalAddress.Builder | 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 | |
|---|---|
| Type | Description |
PostalAddress.Builder | 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 | |
|---|---|
| Type | Description |
PostalAddress.Builder | 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 | |
|---|---|
| Type | Description |
PostalAddress.Builder | 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 | |
|---|---|
| Type | Description |
PostalAddress.Builder | 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 | |
|---|---|
| Type | Description |
PostalAddress.Builder | This builder for chaining. |
clone()
public PostalAddress.Builder clone()| Returns | |
|---|---|
| Type | Description |
PostalAddress.Builder | |
getAddressLines(int index)
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;
| Parameter | |
|---|---|
| Name | Description |
index | intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String | The addressLines at the given index. |
getAddressLinesBytes(int index)
public 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;
| Parameter | |
|---|---|
| Name | Description |
index | intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes of the addressLines at the given index. |
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;
| Returns | |
|---|---|
| Type | Description |
int | The count of addressLines. |
getAddressLinesList()
public 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;
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList | A list containing the addressLines. |
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;
| Returns | |
|---|---|
| Type | Description |
String | The administrativeArea. |
getAdministrativeAreaBytes()
public 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 | |
|---|---|
| Type | Description |
ByteString | The bytes for administrativeArea. |
getDefaultInstanceForType()
public PostalAddress getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
PostalAddress | |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
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;
| Returns | |
|---|---|
| Type | Description |
String | The languageCode. |
getLanguageCodeBytes()
public 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 | |
|---|---|
| Type | Description |
ByteString | The bytes for languageCode. |
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;
| Returns | |
|---|---|
| Type | Description |
String | The locality. |
getLocalityBytes()
public 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 | |
|---|---|
| Type | Description |
ByteString | The bytes for locality. |
getOrganization()
public String getOrganization()Optional. The name of the organization at the address.
string organization = 11;
| Returns | |
|---|---|
| Type | Description |
String | The organization. |
getOrganizationBytes()
public ByteString getOrganizationBytes()Optional. The name of the organization at the address.
string organization = 11;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for organization. |
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;
| Returns | |
|---|---|
| Type | Description |
String | The postalCode. |
getPostalCodeBytes()
public 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 | |
|---|---|
| Type | Description |
ByteString | The bytes for postalCode. |
getRecipients(int index)
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;
| Parameter | |
|---|---|
| Name | Description |
index | intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String | The recipients at the given index. |
getRecipientsBytes(int index)
public 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;
| Parameter | |
|---|---|
| Name | Description |
index | intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes of the recipients at the given index. |
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;
| Returns | |
|---|---|
| Type | Description |
int | The count of recipients. |
getRecipientsList()
public 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;
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList | A list containing the recipients. |
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;
| Returns | |
|---|---|
| Type | Description |
String | The regionCode. |
getRegionCodeBytes()
public 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 | |
|---|---|
| Type | Description |
ByteString | The bytes for regionCode. |
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;
| Returns | |
|---|---|
| Type | Description |
int | The revision. |
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;
| Returns | |
|---|---|
| Type | Description |
String | The sortingCode. |
getSortingCodeBytes()
public 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 | |
|---|---|
| Type | Description |
ByteString | The bytes for sortingCode. |
getSublocality()
public String getSublocality()Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
string sublocality = 8;
| Returns | |
|---|---|
| Type | Description |
String | The sublocality. |
getSublocalityBytes()
public ByteString getSublocalityBytes()Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
string sublocality = 8;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for sublocality. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public PostalAddress.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
PostalAddress.Builder | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
mergeFrom(Message other)
public PostalAddress.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other | Message |
| Returns | |
|---|---|
| Type | Description |
PostalAddress.Builder | |
mergeFrom(PostalAddress other)
public PostalAddress.Builder mergeFrom(PostalAddress other)| Parameter | |
|---|---|
| Name | Description |
other | PostalAddress |
| Returns | |
|---|---|
| Type | Description |
PostalAddress.Builder | |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final PostalAddress.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
PostalAddress.Builder | |
setAddressLines(int index, String value)
public PostalAddress.Builder setAddressLines(int index, 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 | |
|---|---|
| Name | Description |
index | intThe index to set the value at. |
value | StringThe addressLines to set. |
| Returns | |
|---|---|
| Type | Description |
PostalAddress.Builder | This builder for chaining. |
setAdministrativeArea(String value)
public PostalAddress.Builder setAdministrativeArea(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;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe administrativeArea to set. |
| Returns | |
|---|---|
| Type | Description |
PostalAddress.Builder | This builder for chaining. |
setAdministrativeAreaBytes(ByteString value)
public PostalAddress.Builder setAdministrativeAreaBytes(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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for administrativeArea to set. |
| Returns | |
|---|---|
| Type | Description |
PostalAddress.Builder | This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public PostalAddress.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
PostalAddress.Builder | |
setLanguageCode(String value)
public PostalAddress.Builder setLanguageCode(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;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe languageCode to set. |
| Returns | |
|---|---|
| Type | Description |
PostalAddress.Builder | This builder for chaining. |
setLanguageCodeBytes(ByteString value)
public PostalAddress.Builder setLanguageCodeBytes(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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for languageCode to set. |
| Returns | |
|---|---|
| Type | Description |
PostalAddress.Builder | This builder for chaining. |
setLocality(String value)
public PostalAddress.Builder setLocality(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;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe locality to set. |
| Returns | |
|---|---|
| Type | Description |
PostalAddress.Builder | This builder for chaining. |
setLocalityBytes(ByteString value)
public PostalAddress.Builder setLocalityBytes(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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for locality to set. |
| Returns | |
|---|---|
| Type | Description |
PostalAddress.Builder | This builder for chaining. |
setOrganization(String value)
public PostalAddress.Builder setOrganization(String value)Optional. The name of the organization at the address.
string organization = 11;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe organization to set. |
| Returns | |
|---|---|
| Type | Description |
PostalAddress.Builder | This builder for chaining. |
setOrganizationBytes(ByteString value)
public PostalAddress.Builder setOrganizationBytes(ByteString value)Optional. The name of the organization at the address.
string organization = 11;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for organization to set. |
| Returns | |
|---|---|
| Type | Description |
PostalAddress.Builder | This builder for chaining. |
setPostalCode(String value)
public PostalAddress.Builder setPostalCode(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;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe postalCode to set. |
| Returns | |
|---|---|
| Type | Description |
PostalAddress.Builder | This builder for chaining. |
setPostalCodeBytes(ByteString value)
public PostalAddress.Builder setPostalCodeBytes(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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for postalCode to set. |
| Returns | |
|---|---|
| Type | Description |
PostalAddress.Builder | This builder for chaining. |
setRecipients(int index, String value)
public PostalAddress.Builder setRecipients(int index, 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 | |
|---|---|
| Name | Description |
index | intThe index to set the value at. |
value | StringThe recipients to set. |
| Returns | |
|---|---|
| Type | Description |
PostalAddress.Builder | This builder for chaining. |
setRegionCode(String value)
public PostalAddress.Builder setRegionCode(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;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe regionCode to set. |
| Returns | |
|---|---|
| Type | Description |
PostalAddress.Builder | This builder for chaining. |
setRegionCodeBytes(ByteString value)
public PostalAddress.Builder setRegionCodeBytes(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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for regionCode to set. |
| Returns | |
|---|---|
| Type | Description |
PostalAddress.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public PostalAddress.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
| Returns | |
|---|---|
| Type | Description |
PostalAddress.Builder | |
setRevision(int value)
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;
| Parameter | |
|---|---|
| Name | Description |
value | intThe revision to set. |
| Returns | |
|---|---|
| Type | Description |
PostalAddress.Builder | This builder for chaining. |
setSortingCode(String value)
public PostalAddress.Builder setSortingCode(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;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe sortingCode to set. |
| Returns | |
|---|---|
| Type | Description |
PostalAddress.Builder | This builder for chaining. |
setSortingCodeBytes(ByteString value)
public PostalAddress.Builder setSortingCodeBytes(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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for sortingCode to set. |
| Returns | |
|---|---|
| Type | Description |
PostalAddress.Builder | This builder for chaining. |
setSublocality(String value)
public PostalAddress.Builder setSublocality(String value)Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
string sublocality = 8;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe sublocality to set. |
| Returns | |
|---|---|
| Type | Description |
PostalAddress.Builder | This builder for chaining. |
setSublocalityBytes(ByteString value)
public PostalAddress.Builder setSublocalityBytes(ByteString value)Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
string sublocality = 8;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for sublocality to set. |
| Returns | |
|---|---|
| Type | Description |
PostalAddress.Builder | This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final PostalAddress.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
PostalAddress.Builder | |