BeaconUserAddress (com.plaid:plaid-java 18.0.0 API)

java.lang.Object
- com.plaid.client.model.BeaconUserAddress

```
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-10-17T22:44:09.100608Z[Etc/UTC]")
public class BeaconUserAddress
extends Object
```
Even if an address has been collected, some fields may be null depending on the region's addressing system. For example: Addresses from the United Kingdom will not include a region Addresses from Hong Kong will not include a postal code

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`SERIALIZED_NAME_CITY`
`static String`	`SERIALIZED_NAME_COUNTRY`
`static String`	`SERIALIZED_NAME_POSTAL_CODE`
`static String`	`SERIALIZED_NAME_REGION`
`static String`	`SERIALIZED_NAME_STREET`
`static String`	`SERIALIZED_NAME_STREET2`

Constructor Summary

Constructors
Constructor and Description

BeaconUserAddress()

Constructors
Constructor and Description
`BeaconUserAddress()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BeaconUserAddress`	`city(String city)`
`BeaconUserAddress`	`country(String country)`
`boolean`	`equals(Object o)`
`String`	`getCity()` City from the end user's address
`String`	`getCountry()` Valid, capitalized, two-letter ISO code representing the country of this object.
`String`	`getPostalCode()` The postal code for the associated address.
`String`	`getRegion()` An ISO 3166-2 subdivision code.
`String`	`getStreet()` The primary street portion of an address.
`String`	`getStreet2()` Extra street information, like an apartment or suite number.
`int`	`hashCode()`
`BeaconUserAddress`	`postalCode(String postalCode)`
`BeaconUserAddress`	`region(String region)`
`void`	`setCity(String city)`
`void`	`setCountry(String country)`
`void`	`setPostalCode(String postalCode)`
`void`	`setRegion(String region)`
`void`	`setStreet(String street)`
`void`	`setStreet2(String street2)`
`BeaconUserAddress`	`street(String street)`
`BeaconUserAddress`	`street2(String street2)`
`String`	`toString()`

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

- Field Detail
  - SERIALIZED_NAME_STREET
```
public static final String SERIALIZED_NAME_STREET
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_STREET2
```
public static final String SERIALIZED_NAME_STREET2
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_CITY
```
public static final String SERIALIZED_NAME_CITY
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_REGION
```
public static final String SERIALIZED_NAME_REGION
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_POSTAL_CODE
```
public static final String SERIALIZED_NAME_POSTAL_CODE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_COUNTRY
```
public static final String SERIALIZED_NAME_COUNTRY
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - BeaconUserAddress
```
public BeaconUserAddress()
```
- Method Detail
  - street
```
public BeaconUserAddress street(String street)
```
  - getStreet
```
public String getStreet()
```
    The primary street portion of an address. If the user has submitted their address, this field will always be filled.
    
    Returns:
    
    street
  - setStreet
```
public void setStreet(String street)
```
  - street2
```
public BeaconUserAddress street2(String street2)
```
  - getStreet2
```
@Nullable
public String getStreet2()
```
    Extra street information, like an apartment or suite number.
    
    Returns:
    
    street2
  - setStreet2
```
public void setStreet2(String street2)
```
  - city
```
public BeaconUserAddress city(String city)
```
  - getCity
```
public String getCity()
```
    City from the end user's address
    
    Returns:
    
    city
  - setCity
```
public void setCity(String city)
```
  - region
```
public BeaconUserAddress region(String region)
```
  - getRegion
```
@Nullable
public String getRegion()
```
    An ISO 3166-2 subdivision code. Related terms would be \"state\", \"province\", \"prefecture\", \"zone\", \"subdivision\", etc.
    
    Returns:
    
    region
  - setRegion
```
public void setRegion(String region)
```
  - postalCode
```
public BeaconUserAddress postalCode(String postalCode)
```
  - getPostalCode
```
@Nullable
public String getPostalCode()
```
    The postal code for the associated address. Between 2 and 10 alphanumeric characters. For US-based addresses this must be 5 numeric digits.
    
    Returns:
    
    postalCode
  - setPostalCode
```
public void setPostalCode(String postalCode)
```
  - country
```
public BeaconUserAddress country(String country)
```
  - getCountry
```
public String getCountry()
```
    Valid, capitalized, two-letter ISO code representing the country of this object. Must be in ISO 3166-1 alpha-2 form.
    
    Returns:
    
    country
  - setCountry
```
public void setCountry(String country)
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class BeaconUserAddress

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_STREET

SERIALIZED_NAME_STREET2

SERIALIZED_NAME_CITY

SERIALIZED_NAME_REGION

SERIALIZED_NAME_POSTAL_CODE

SERIALIZED_NAME_COUNTRY

Constructor Detail

BeaconUserAddress

Method Detail

street

getStreet

setStreet

street2

getStreet2

setStreet2

city

getCity

setCity

region

getRegion

setRegion

postalCode

getPostalCode

setPostalCode

country

getCountry

setCountry

equals

hashCode

toString