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

Class GeocodeFilter

java.lang.Object

software.amazon.awssdk.services.geoplaces.model.GeocodeFilter

All Implemented Interfaces:

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

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

Geocode structure which contains a set of inclusion/exclusion properties that results must posses in order to be returned as a result.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GeocodeFilter.Builder

Method Summary

Modifier and Type	Method	Description
static GeocodeFilter.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasIncludeCountries()	For responses, this returns true if the service returned a value for the IncludeCountries property.
boolean	hasIncludePlaceTypes()	For responses, this returns true if the service returned a value for the IncludePlaceTypes property.
List<String>	includeCountries()	A list of countries that all results must be in.
List<GeocodeFilterPlaceType>	includePlaceTypes()	The included place types.
List<String>	includePlaceTypesAsStrings()	The included place types.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends GeocodeFilter.Builder>	serializableBuilderClass()
GeocodeFilter.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

hasIncludeCountries

public final boolean hasIncludeCountries()

For responses, this returns true if the service returned a value for the IncludeCountries property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

includeCountries

public final List<String> includeCountries()

A list of countries that all results must be in. Countries are represented by either their alpha-2 or alpha-3 character codes.

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 hasIncludeCountries() method.

Returns:

A list of countries that all results must be in. Countries are represented by either their alpha-2 or alpha-3 character codes.

includePlaceTypes

public final List<GeocodeFilterPlaceType> includePlaceTypes()

The included place types.

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 hasIncludePlaceTypes() method.

Returns:

The included place types.

hasIncludePlaceTypes

public final boolean hasIncludePlaceTypes()

For responses, this returns true if the service returned a value for the IncludePlaceTypes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

includePlaceTypesAsStrings

public final List<String> includePlaceTypesAsStrings()

The included place types.

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 hasIncludePlaceTypes() method.

Returns:

The included place types.

toBuilder

public GeocodeFilter.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GeocodeFilter.Builder,GeocodeFilter>

builder

public static GeocodeFilter.Builder builder()

serializableBuilderClass

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