Package software.amazon.awssdk.services.geoplaces.model

Class PostalCodeDetails

java.lang.Object

software.amazon.awssdk.services.geoplaces.model.PostalCodeDetails

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<PostalCodeDetails.Builder,PostalCodeDetails>

@Generated("software.amazon.awssdk:codegen")
public final class PostalCodeDetails
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<PostalCodeDetails.Builder,PostalCodeDetails>

Contains details about the postal code of the place or result.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PostalCodeDetails.Builder

Method Summary

Modifier and Type	Method	Description
static PostalCodeDetails.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
PostalAuthority	postalAuthority()	The postal authority or entity.
String	postalAuthorityAsString()	The postal authority or entity.
String	postalCode()	An alphanumeric string included in a postal address to facilitate mail sorting, such as post code, postcode, or ZIP code for which the result should posses.
PostalCodeType	postalCodeType()	The postal code type.
String	postalCodeTypeAsString()	The postal code type.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends PostalCodeDetails.Builder>	serializableBuilderClass()
PostalCodeDetails.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
UspsZip	uspsZip()	The ZIP Classification Code, or in other words what type of postal code is it.
UspsZipPlus4	uspsZipPlus4()	The USPS ZIP+4 Record Type Code.

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

postalCode

public final String postalCode()

An alphanumeric string included in a postal address to facilitate mail sorting, such as post code, postcode, or ZIP code for which the result should posses.

Returns:

An alphanumeric string included in a postal address to facilitate mail sorting, such as post code, postcode, or ZIP code for which the result should posses.

postalAuthority

public final PostalAuthority postalAuthority()

The postal authority or entity. This could be a governmental authority, a regulatory authority, or a designated postal operator.

If the service returns an enum value that is not available in the current SDK version, postalAuthority will return PostalAuthority.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from postalAuthorityAsString().

Returns:

The postal authority or entity. This could be a governmental authority, a regulatory authority, or a designated postal operator.

See Also:

PostalAuthority

postalAuthorityAsString

public final String postalAuthorityAsString()

The postal authority or entity. This could be a governmental authority, a regulatory authority, or a designated postal operator.

If the service returns an enum value that is not available in the current SDK version, postalAuthority will return PostalAuthority.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from postalAuthorityAsString().

Returns:

The postal authority or entity. This could be a governmental authority, a regulatory authority, or a designated postal operator.

See Also:

PostalAuthority

postalCodeType

public final PostalCodeType postalCodeType()

The postal code type.

If the service returns an enum value that is not available in the current SDK version, postalCodeType will return PostalCodeType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from postalCodeTypeAsString().

Returns:

The postal code type.

See Also:

PostalCodeType

postalCodeTypeAsString

public final String postalCodeTypeAsString()

The postal code type.

If the service returns an enum value that is not available in the current SDK version, postalCodeType will return PostalCodeType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from postalCodeTypeAsString().

Returns:

The postal code type.

See Also:

PostalCodeType

uspsZip

public final UspsZip uspsZip()

The ZIP Classification Code, or in other words what type of postal code is it.

Returns:

The ZIP Classification Code, or in other words what type of postal code is it.

uspsZipPlus4

public final UspsZipPlus4 uspsZipPlus4()

The USPS ZIP+4 Record Type Code.

Returns:

The USPS ZIP+4 Record Type Code.

toBuilder

public PostalCodeDetails.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PostalCodeDetails.Builder,PostalCodeDetails>

builder

public static PostalCodeDetails.Builder builder()

serializableBuilderClass

public static Class<? extends PostalCodeDetails.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo