PostalAddress (My Business Account Management API v1-rev20241120-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.mybusinessaccountmanagement.v1.model.PostalAddress

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class PostalAddress
extends com.google.api.client.json.GenericJson
```
Represents a postal address. For example 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 by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-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, see: https://support.google.com/business/answer/6397478
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the My Business Account Management API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

PostalAddress()

Constructors
Constructor and Description
`PostalAddress()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PostalAddress`	`clone()`
`List<String>`	`getAddressLines()` Unstructured address lines describing the lower levels of an address.
`String`	`getAdministrativeArea()` Optional.
`String`	`getLanguageCode()` Optional.
`String`	`getLocality()` Optional.
`String`	`getOrganization()` Optional.
`String`	`getPostalCode()` Optional.
`List<String>`	`getRecipients()` Optional.
`String`	`getRegionCode()` Required.
`Integer`	`getRevision()` The schema revision of the `PostalAddress`.
`String`	`getSortingCode()` Optional.
`String`	`getSublocality()` Optional.
`PostalAddress`	`set(String fieldName, Object value)`
`PostalAddress`	`setAddressLines(List<String> addressLines)` Unstructured address lines describing the lower levels of an address.
`PostalAddress`	`setAdministrativeArea(String administrativeArea)` Optional.
`PostalAddress`	`setLanguageCode(String languageCode)` Optional.
`PostalAddress`	`setLocality(String locality)` Optional.
`PostalAddress`	`setOrganization(String organization)` Optional.
`PostalAddress`	`setPostalCode(String postalCode)` Optional.
`PostalAddress`	`setRecipients(List<String> recipients)` Optional.
`PostalAddress`	`setRegionCode(String regionCode)` Required.
`PostalAddress`	`setRevision(Integer revision)` The schema revision of the `PostalAddress`.
`PostalAddress`	`setSortingCode(String sortingCode)` Optional.
`PostalAddress`	`setSublocality(String sublocality)` Optional.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - PostalAddress
```
public PostalAddress()
```
- Method Detail
  - getAddressLines
```
public List<String> 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 (For example "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 (For example Japan), address_language is used to make it explicit (For example "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).
    
    Returns:
    
    value or null for none
  - setAddressLines
```
public PostalAddress setAddressLines(List<String> addressLines)
```
    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 (For example "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 (For example Japan), address_language is used to make it explicit (For example "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).
    
    Parameters:
    
    addressLines - addressLines or null for none
  - 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 (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
    
    Returns:
    
    value or null for none
  - setAdministrativeArea
```
public PostalAddress setAdministrativeArea(String administrativeArea)
```
    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 (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
    
    Parameters:
    
    administrativeArea - administrativeArea or null for none
  - 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".
    
    Returns:
    
    value or null for none
  - setLanguageCode
```
public PostalAddress setLanguageCode(String languageCode)
```
    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".
    
    Parameters:
    
    languageCode - languageCode or null for none
  - 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.
    
    Returns:
    
    value or null for none
  - setLocality
```
public PostalAddress setLocality(String locality)
```
    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.
    
    Parameters:
    
    locality - locality or null for none
  - getOrganization
```
public String getOrganization()
```
    Optional. The name of the organization at the address.
    
    Returns:
    
    value or null for none
  - setOrganization
```
public PostalAddress setOrganization(String organization)
```
    Optional. The name of the organization at the address.
    
    Parameters:
    
    organization - organization or null for none
  - 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 (For example state/zip validation in the U.S.A.).
    
    Returns:
    
    value or null for none
  - setPostalCode
```
public PostalAddress setPostalCode(String postalCode)
```
    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 (For example state/zip validation in the U.S.A.).
    
    Parameters:
    
    postalCode - postalCode or null for none
  - getRecipients
```
public List<String> getRecipients()
```
    Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
    
    Returns:
    
    value or null for none
  - setRecipients
```
public PostalAddress setRecipients(List<String> recipients)
```
    Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
    
    Parameters:
    
    recipients - recipients or null for none
  - 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 https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
    
    Returns:
    
    value or null for none
  - setRegionCode
```
public PostalAddress setRegionCode(String regionCode)
```
    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 https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
    
    Parameters:
    
    regionCode - regionCode or null for none
  - getRevision
```
public Integer 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.
    
    Returns:
    
    value or null for none
  - setRevision
```
public PostalAddress setRevision(Integer revision)
```
    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.
    
    Parameters:
    
    revision - revision or null for none
  - 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 (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
    
    Returns:
    
    value or null for none
  - setSortingCode
```
public PostalAddress setSortingCode(String sortingCode)
```
    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 (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
    
    Parameters:
    
    sortingCode - sortingCode or null for none
  - getSublocality
```
public String getSublocality()
```
    Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
    
    Returns:
    
    value or null for none
  - setSublocality
```
public PostalAddress setSublocality(String sublocality)
```
    Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
    
    Parameters:
    
    sublocality - sublocality or null for none
  - set
```
public PostalAddress set(String fieldName,
                         Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public PostalAddress clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class PostalAddress

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

PostalAddress

Method Detail

getAddressLines

setAddressLines

getAdministrativeArea

setAdministrativeArea

getLanguageCode

setLanguageCode

getLocality

setLocality

getOrganization

setOrganization

getPostalCode

setPostalCode

getRecipients

setRecipients

getRegionCode

setRegionCode

getRevision

setRevision

getSortingCode

setSortingCode

getSublocality

setSublocality

set

clone