Address (People API v1 (Rev. 277) 1.23.0)

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

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>
```
public final class Address
extends com.google.api.client.json.GenericJson
```
A person's physical address. May be a P.O. box or street address. All fields are optional.
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 People 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
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

Address()

Constructors
Constructor and Description
`Address()`

Method Summary

Methods
Modifier and Type	Method and Description
`Address`	`clone()`
`java.lang.String`	`getCity()` The city of the address.
`java.lang.String`	`getCountry()` The country of the address.
`java.lang.String`	`getCountryCode()` The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country code of the address.
`java.lang.String`	`getExtendedAddress()` The extended address of the address; for example, the apartment number.
`java.lang.String`	`getFormattedType()` The read-only type of the address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
`java.lang.String`	`getFormattedValue()` The unstructured value of the address.
`FieldMetadata`	`getMetadata()` Metadata about the address.
`java.lang.String`	`getPoBox()` The P.O.
`java.lang.String`	`getPostalCode()` The postal code of the address.
`java.lang.String`	`getRegion()` The region of the address; for example, the state or province.
`java.lang.String`	`getStreetAddress()` The street address.
`java.lang.String`	`getType()` The type of the address.
`Address`	`set(java.lang.String fieldName, java.lang.Object value)`
`Address`	`setCity(java.lang.String city)` The city of the address.
`Address`	`setCountry(java.lang.String country)` The country of the address.
`Address`	`setCountryCode(java.lang.String countryCode)` The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country code of the address.
`Address`	`setExtendedAddress(java.lang.String extendedAddress)` The extended address of the address; for example, the apartment number.
`Address`	`setFormattedType(java.lang.String formattedType)` The read-only type of the address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
`Address`	`setFormattedValue(java.lang.String formattedValue)` The unstructured value of the address.
`Address`	`setMetadata(FieldMetadata metadata)` Metadata about the address.
`Address`	`setPoBox(java.lang.String poBox)` The P.O.
`Address`	`setPostalCode(java.lang.String postalCode)` The postal code of the address.
`Address`	`setRegion(java.lang.String region)` The region of the address; for example, the state or province.
`Address`	`setStreetAddress(java.lang.String streetAddress)` The street address.
`Address`	`setType(java.lang.String type)` The type of the address.

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, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

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

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

- Constructor Detail
  - Address
```
public Address()
```
- Method Detail
  - getCity
```
public java.lang.String getCity()
```
    The city of the address.
    
    Returns:
    value or null for none
  - setCity
```
public Address setCity(java.lang.String city)
```
    The city of the address.
    
    Parameters:
    city - city or null for none
  - getCountry
```
public java.lang.String getCountry()
```
    The country of the address.
    
    Returns:
    value or null for none
  - setCountry
```
public Address setCountry(java.lang.String country)
```
    The country of the address.
    
    Parameters:
    country - country or null for none
  - getCountryCode
```
public java.lang.String getCountryCode()
```
    The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country code of the address.
    
    Returns:
    value or null for none
  - setCountryCode
```
public Address setCountryCode(java.lang.String countryCode)
```
    The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country code of the address.
    
    Parameters:
    countryCode - countryCode or null for none
  - getExtendedAddress
```
public java.lang.String getExtendedAddress()
```
    The extended address of the address; for example, the apartment number.
    
    Returns:
    value or null for none
  - setExtendedAddress
```
public Address setExtendedAddress(java.lang.String extendedAddress)
```
    The extended address of the address; for example, the apartment number.
    
    Parameters:
    extendedAddress - extendedAddress or null for none
  - getFormattedType
```
public java.lang.String getFormattedType()
```
    The read-only type of the address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
    
    Returns:
    value or null for none
  - setFormattedType
```
public Address setFormattedType(java.lang.String formattedType)
```
    The read-only type of the address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
    
    Parameters:
    formattedType - formattedType or null for none
  - getFormattedValue
```
public java.lang.String getFormattedValue()
```
    The unstructured value of the address. If this is not set by the user it will be automatically constructed from structured values.
    
    Returns:
    value or null for none
  - setFormattedValue
```
public Address setFormattedValue(java.lang.String formattedValue)
```
    The unstructured value of the address. If this is not set by the user it will be automatically constructed from structured values.
    
    Parameters:
    formattedValue - formattedValue or null for none
  - getMetadata
```
public FieldMetadata getMetadata()
```
    Metadata about the address.
    
    Returns:
    value or null for none
  - setMetadata
```
public Address setMetadata(FieldMetadata metadata)
```
    Metadata about the address.
    
    Parameters:
    metadata - metadata or null for none
  - getPoBox
```
public java.lang.String getPoBox()
```
    The P.O. box of the address.
    
    Returns:
    value or null for none
  - setPoBox
```
public Address setPoBox(java.lang.String poBox)
```
    The P.O. box of the address.
    
    Parameters:
    poBox - poBox or null for none
  - getPostalCode
```
public java.lang.String getPostalCode()
```
    The postal code of the address.
    
    Returns:
    value or null for none
  - setPostalCode
```
public Address setPostalCode(java.lang.String postalCode)
```
    The postal code of the address.
    
    Parameters:
    postalCode - postalCode or null for none
  - getRegion
```
public java.lang.String getRegion()
```
    The region of the address; for example, the state or province.
    
    Returns:
    value or null for none
  - setRegion
```
public Address setRegion(java.lang.String region)
```
    The region of the address; for example, the state or province.
    
    Parameters:
    region - region or null for none
  - getStreetAddress
```
public java.lang.String getStreetAddress()
```
    The street address.
    
    Returns:
    value or null for none
  - setStreetAddress
```
public Address setStreetAddress(java.lang.String streetAddress)
```
    The street address.
    
    Parameters:
    streetAddress - streetAddress or null for none
  - getType
```
public java.lang.String getType()
```
    The type of the address. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `home` * `work` * `other`
    
    Returns:
    value or null for none
  - setType
```
public Address setType(java.lang.String type)
```
    The type of the address. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `home` * `work` * `other`
    
    Parameters:
    type - type or null for none
  - set
```
public Address set(java.lang.String fieldName,
          java.lang.Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public Address clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

People API v1 (revision 277)

Class Address

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

Constructor Detail

Address

Method Detail

getCity

setCity

getCountry

setCountry

getCountryCode

setCountryCode

getExtendedAddress

setExtendedAddress

getFormattedType

setFormattedType

getFormattedValue

setFormattedValue

getMetadata

setMetadata

getPoBox

setPoBox

getPostalCode

setPostalCode

getRegion

setRegion

getStreetAddress

setStreetAddress

getType

setType

set

clone