Class GeocodeParsedQueryAddressComponents
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<GeocodeParsedQueryAddressComponents.Builder,
GeocodeParsedQueryAddressComponents>
Parsed address components in the provided QueryText.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal List
<ParsedQueryComponent> The number that identifies an address within a street.final List
<ParsedQueryComponent> block()
Name of the block.builder()
final List
<ParsedQueryComponent> building()
The name of the building at the address.final List
<ParsedQueryComponent> country()
The alpha-2 or alpha-3 character code for the country that the results will be present in.final List
<ParsedQueryComponent> district()
The district or division of a city the results should be present in.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the AddressNumber property.final boolean
hasBlock()
For responses, this returns true if the service returned a value for the Block property.final boolean
For responses, this returns true if the service returned a value for the Building property.final boolean
For responses, this returns true if the service returned a value for the Country property.final boolean
For responses, this returns true if the service returned a value for the District property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Locality property.final boolean
For responses, this returns true if the service returned a value for the PostalCode property.final boolean
For responses, this returns true if the service returned a value for the Region property.final boolean
For responses, this returns true if the service returned a value for the SecondaryAddressComponents property.final boolean
For responses, this returns true if the service returned a value for the Street property.final boolean
For responses, this returns true if the service returned a value for the SubBlock property.final boolean
For responses, this returns true if the service returned a value for the SubDistrict property.final boolean
For responses, this returns true if the service returned a value for the SubRegion property.final List
<ParsedQueryComponent> locality()
The city or locality of the address.final List
<ParsedQueryComponent> 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 possess.final List
<ParsedQueryComponent> region()
The region or state results should be present in.Parsed secondary address components from the provided query text.static Class
<? extends GeocodeParsedQueryAddressComponents.Builder> final List
<ParsedQueryComponent> street()
The name of the street results should be present in.final List
<ParsedQueryComponent> subBlock()
Name of sub-block.final List
<ParsedQueryComponent> A subdivision of a district.final List
<ParsedQueryComponent> The sub-region or county for which results should be present in.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
hasCountry
public final boolean hasCountry()For responses, this returns true if the service returned a value for the Country property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
country
The alpha-2 or alpha-3 character code for the country that the results will be present in.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasCountry()
method.- Returns:
- The alpha-2 or alpha-3 character code for the country that the results will be present in.
-
hasRegion
public final boolean hasRegion()For responses, this returns true if the service returned a value for the Region property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
region
The region or state results should be present in.
Example:
North Rhine-Westphalia
.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasRegion()
method.- Returns:
- The region or state results should be present in.
Example:
North Rhine-Westphalia
.
-
hasSubRegion
public final boolean hasSubRegion()For responses, this returns true if the service returned a value for the SubRegion property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
subRegion
The sub-region or county for which results should be present in.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasSubRegion()
method.- Returns:
- The sub-region or county for which results should be present in.
-
hasLocality
public final boolean hasLocality()For responses, this returns true if the service returned a value for the Locality property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
locality
The city or locality of the address.
Example:
Vancouver
.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasLocality()
method.- Returns:
- The city or locality of the address.
Example:
Vancouver
.
-
hasDistrict
public final boolean hasDistrict()For responses, this returns true if the service returned a value for the District property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
district
The district or division of a city the results should be present in.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasDistrict()
method.- Returns:
- The district or division of a city the results should be present in.
-
hasSubDistrict
public final boolean hasSubDistrict()For responses, this returns true if the service returned a value for the SubDistrict property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
subDistrict
A subdivision of a district.
Example:
Minden-Lübbecke
.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasSubDistrict()
method.- Returns:
- A subdivision of a district.
Example:
Minden-Lübbecke
.
-
hasPostalCode
public final boolean hasPostalCode()For responses, this returns true if the service returned a value for the PostalCode property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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 possess.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasPostalCode()
method.- 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 possess.
-
hasBlock
public final boolean hasBlock()For responses, this returns true if the service returned a value for the Block property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
block
Name of the block.
Example:
Sunny Mansion 203 block: 2 Chome
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasBlock()
method.- Returns:
- Name of the block.
Example:
Sunny Mansion 203 block: 2 Chome
-
hasSubBlock
public final boolean hasSubBlock()For responses, this returns true if the service returned a value for the SubBlock property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
subBlock
Name of sub-block.
Example:
Sunny Mansion 203 sub-block: 4
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasSubBlock()
method.- Returns:
- Name of sub-block.
Example:
Sunny Mansion 203 sub-block: 4
-
hasStreet
public final boolean hasStreet()For responses, this returns true if the service returned a value for the Street property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
street
The name of the street results should be present in.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasStreet()
method.- Returns:
- The name of the street results should be present in.
-
hasAddressNumber
public final boolean hasAddressNumber()For responses, this returns true if the service returned a value for the AddressNumber property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
addressNumber
The number that identifies an address within a street.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasAddressNumber()
method.- Returns:
- The number that identifies an address within a street.
-
hasBuilding
public final boolean hasBuilding()For responses, this returns true if the service returned a value for the Building property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
building
The name of the building at the address.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasBuilding()
method.- Returns:
- The name of the building at the address.
-
hasSecondaryAddressComponents
public final boolean hasSecondaryAddressComponents()For responses, this returns true if the service returned a value for the SecondaryAddressComponents property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
secondaryAddressComponents
Parsed secondary address components from the provided query text.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasSecondaryAddressComponents()
method.- Returns:
- Parsed secondary address components from the provided query text.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<GeocodeParsedQueryAddressComponents.Builder,
GeocodeParsedQueryAddressComponents> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends GeocodeParsedQueryAddressComponents.Builder> serializableBuilderClass() -
hashCode
-
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
- Returns:
- The mapping between the field name and its corresponding field.
-