Class GeocodeQueryComponents
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<GeocodeQueryComponents.Builder,
GeocodeQueryComponents>
A structured free text query allows you to search for places by the name or text representation of specific properties of the place.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal String
The house number or address results should have.builder()
final String
country()
The alpha-2 or alpha-3 character code for the country that the results will be present in.final String
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 int
hashCode()
final String
locality()
The city or locality results should be present in.final String
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 String
region()
The region or state results should be to be present in.static Class
<? extends GeocodeQueryComponents.Builder> final String
street()
The name of the street results should be present in.final String
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
-
country
The alpha-2 or alpha-3 character code for the country that the results will be present in.
- Returns:
- The alpha-2 or alpha-3 character code for the country that the results will be present in.
-
region
The region or state results should be to be present in.
Example:
North Rhine-Westphalia
.- Returns:
- The region or state results should be to be present in.
Example:
North Rhine-Westphalia
.
-
subRegion
The sub-region or county for which results should be present in.
- Returns:
- The sub-region or county for which results should be present in.
-
locality
The city or locality results should be present in.
Example:
Vancouver
.- Returns:
- The city or locality results should be present in.
Example:
Vancouver
.
-
district
The district or division of a city the results should be present in.
- Returns:
- The district or division of a city the results should be present in.
-
street
The name of the street results should be present in.
- Returns:
- The name of the street results should be present in.
-
addressNumber
The house number or address results should have.
- Returns:
- The house number or address results should have.
-
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.
- 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.
-
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<GeocodeQueryComponents.Builder,
GeocodeQueryComponents> - Returns:
- a builder for type T
-
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.
-