software.amazon.awssdk.services.location.model

Class SearchPlaceIndexForTextSummary

java.lang.Object

software.amazon.awssdk.services.location.model.SearchPlaceIndexForTextSummary

All Implemented Interfaces:

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

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

A summary of the geocoding request sent using SearchPlaceIndexForText.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SearchPlaceIndexForTextSummary.Builder

Method Summary

Modifier and Type	Method and Description
List<Double>	biasPosition() Contains the coordinates for the bias position entered in the geocoding request.
static SearchPlaceIndexForTextSummary.Builder	builder()
String	dataSource() The data provider of geospatial data.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<Double>	filterBBox() Contains the coordinates for the optional bounding box coordinated entered in the geocoding request.
List<String>	filterCountries() Contains the country filter entered in the geocoding request.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasBiasPosition() For responses, this returns true if the service returned a value for the BiasPosition property.
boolean	hasFilterBBox() For responses, this returns true if the service returned a value for the FilterBBox property.
boolean	hasFilterCountries() For responses, this returns true if the service returned a value for the FilterCountries property.
int	hashCode()
boolean	hasResultBBox() For responses, this returns true if the service returned a value for the ResultBBox property.
Integer	maxResults() Contains the maximum number of results indicated for the request.
List<Double>	resultBBox() A bounding box that contains the search results within the specified area indicated by FilterBBox.
List<SdkField<?>>	sdkFields()
static Class<? extends SearchPlaceIndexForTextSummary.Builder>	serializableBuilderClass()
String	text() The address, name, city or region to be used in the geocoding request.
SearchPlaceIndexForTextSummary.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

hasBiasPosition

public final boolean hasBiasPosition()

For responses, this returns true if the service returned a value for the BiasPosition 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.

biasPosition

public final List<Double> biasPosition()

Contains the coordinates for the bias position entered in the geocoding request.

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

Returns:

Contains the coordinates for the bias position entered in the geocoding request.

dataSource

public final String dataSource()

The data provider of geospatial data. Indicates one of the available providers:

• Esri

• HERE

For additional details on data providers, see Amazon Location Service data providers.

Returns:

The data provider of geospatial data. Indicates one of the available providers:

• Esri

• HERE

For additional details on data providers, see Amazon Location Service data providers.

hasFilterBBox

public final boolean hasFilterBBox()

For responses, this returns true if the service returned a value for the FilterBBox 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.

filterBBox

public final List<Double> filterBBox()

Contains the coordinates for the optional bounding box coordinated entered in the geocoding request.

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

Returns:

Contains the coordinates for the optional bounding box coordinated entered in the geocoding request.

hasFilterCountries

public final boolean hasFilterCountries()

For responses, this returns true if the service returned a value for the FilterCountries 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.

filterCountries

public final List<String> filterCountries()

Contains the country filter entered in the geocoding request.

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

Returns:

Contains the country filter entered in the geocoding request.

maxResults

public final Integer maxResults()

Contains the maximum number of results indicated for the request.

Returns:

Contains the maximum number of results indicated for the request.

hasResultBBox

public final boolean hasResultBBox()

For responses, this returns true if the service returned a value for the ResultBBox 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.

resultBBox

public final List<Double> resultBBox()

A bounding box that contains the search results within the specified area indicated by FilterBBox. A subset of bounding box specified using FilterBBox.

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

Returns:

A bounding box that contains the search results within the specified area indicated by FilterBBox. A subset of bounding box specified using FilterBBox.

text

public final String text()

The address, name, city or region to be used in the geocoding request. In free-form text format. For example, Vancouver.

Returns:

The address, name, city or region to be used in the geocoding request. In free-form text format. For example, Vancouver.

toBuilder

public SearchPlaceIndexForTextSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SearchPlaceIndexForTextSummary.Builder,SearchPlaceIndexForTextSummary>

builder

public static SearchPlaceIndexForTextSummary.Builder builder()

serializableBuilderClass

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