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

Class GeocodeQueryComponents

java.lang.Object

software.amazon.awssdk.services.geoplaces.model.GeocodeQueryComponents

All Implemented Interfaces:

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

@Generated("software.amazon.awssdk:codegen")
public final class GeocodeQueryComponents
extends Object
implements SdkPojo, Serializable, 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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GeocodeQueryComponents.Builder

Method Summary

Modifier and Type	Method	Description
String	addressNumber()	The house number or address results should have.
static GeocodeQueryComponents.Builder	builder()
String	country()	The alpha-2 or alpha-3 character code for the country that the results will be present in.
String	district()	The district or division of a city the results should be present in.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	locality()	City or locality results should be present in.
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.
String	region()	The region or state results should be to be present in.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends GeocodeQueryComponents.Builder>	serializableBuilderClass()
String	street()	The name of the street results should be present in.
String	subRegion()	The sub-region or county for which results should be present in.
GeocodeQueryComponents.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

country

public final String 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

public final String 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

public final String 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

public final String locality()

City or locality results should be present in.

Example: Vancouver.

Returns:

City or locality results should be present in.

Example: Vancouver.

district

public final String 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

public final String street()

The name of the street results should be present in.

Returns:

The name of the street results should be present in.

addressNumber

public final String addressNumber()

The house number or address results should have.

Returns:

The house number or address results should have.

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.

toBuilder

public GeocodeQueryComponents.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GeocodeQueryComponents.Builder,GeocodeQueryComponents>

builder

public static GeocodeQueryComponents.Builder builder()

serializableBuilderClass

public static Class<? extends GeocodeQueryComponents.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