com.oracle.bmc.identitydomains.model

Class Addresses

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.identitydomains.model.Addresses

@Generated(value="OracleSDKGenerator",
           comments="API Version: v1")
public final class Addresses
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

A physical mailing address for this User, as described in (address Element). Canonical Type Values of work, home, and other. The value attribute is a complex type with the following sub-attributes.
Note: Objects should always be created or deserialized using the Addresses.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the Addresses.Builder, which maintain a set of all explicitly set fields called Addresses.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Addresses.Builder
static class	Addresses.Type A label indicating the attribute’s function; e.g., ‘work’ or ‘home’.

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor and Description
Addresses(String formatted, String streetAddress, String locality, String region, String postalCode, String country, Addresses.Type type, Boolean primary) Deprecated.

Method Summary

Modifier and Type	Method and Description
static Addresses.Builder	builder() Create a new builder.
boolean	equals(Object o)
String	getCountry() The country name component.
String	getFormatted() The full mailing address, formatted for display or use with a mailing label.
String	getLocality() The city or locality component.
String	getPostalCode() The zipcode or postal code component.
Boolean	getPrimary() A Boolean value indicating the ‘primary’ or preferred attribute value for this attribute.
String	getRegion() The state or region component.
String	getStreetAddress() The full street address component, which may include house number, street name, PO BOX, and multi-line extended street address information.
Addresses.Type	getType() A label indicating the attribute’s function; e.g., ‘work’ or ‘home’.
int	hashCode()
Addresses.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents) Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Addresses

@Deprecated
 @ConstructorProperties(value={"formatted","streetAddress","locality","region","postalCode","country","type","primary"})
public Addresses(String formatted,
                                                                                                                                                      String streetAddress,
                                                                                                                                                      String locality,
                                                                                                                                                      String region,
                                                                                                                                                      String postalCode,
                                                                                                                                                      String country,
                                                                                                                                                      Addresses.Type type,
                                                                                                                                                      Boolean primary)

Deprecated.

Method Detail

builder

public static Addresses.Builder builder()

Create a new builder.

toBuilder

public Addresses.Builder toBuilder()

getFormatted

public String getFormatted()

The full mailing address, formatted for display or use with a mailing label. This attribute MAY contain newlines.

*SCIM++ Properties:** - caseExact: false - idcsSearchable: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

Returns:

the value

getStreetAddress

public String getStreetAddress()

The full street address component, which may include house number, street name, PO BOX, and multi-line extended street address information. This attribute MAY contain newlines.

*SCIM++ Properties:** - caseExact: false - idcsSearchable: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

Returns:

the value

getLocality

public String getLocality()

The city or locality component.

*SCIM++ Properties:** - caseExact: false - idcsSearchable: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

Returns:

the value

getRegion

public String getRegion()

The state or region component.

*SCIM++ Properties:** - caseExact: false - idcsSearchable: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

Returns:

the value

getPostalCode

public String getPostalCode()

The zipcode or postal code component.

*SCIM++ Properties:** - caseExact: false - idcsSearchable: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

Returns:

the value

getCountry

public String getCountry()

The country name component.

*SCIM++ Properties:** - caseExact: false - idcsCanonicalValueSourceFilter: attrName eq "countries" and attrValues.value eq "upper($(country))" - idcsCanonicalValueSourceResourceType: AllowedValue - idcsSearchable: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

Returns:

the value

getType

public Addresses.Type getType()

A label indicating the attribute’s function; e.g., ‘work’ or ‘home’.

*SCIM++ Properties:** - caseExact: false - idcsSearchable: true - multiValued: false - mutability: readWrite - required: true - returned: default - type: string - uniqueness: none

Returns:

the value

getPrimary

public Boolean getPrimary()

A Boolean value indicating the ‘primary’ or preferred attribute value for this attribute. The primary attribute value ‘true’ MUST appear no more than once.

*SCIM++ Properties:** - caseExact: false - idcsSearchable: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean - uniqueness: none

Returns:

the value

toString

public String toString()

Overrides:

toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel