software.amazon.awssdk.services.location.model

Class SearchPlaceIndexForSuggestionsSummary

java.lang.Object

software.amazon.awssdk.services.location.model.SearchPlaceIndexForSuggestionsSummary

All Implemented Interfaces:

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

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

A summary of the request sent by using SearchPlaceIndexForSuggestions.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SearchPlaceIndexForSuggestionsSummary.Builder

Method Summary

Modifier and Type	Method and Description
List<Double>	biasPosition() Contains the coordinates for the optional bias position specified in the request.
static SearchPlaceIndexForSuggestionsSummary.Builder	builder()
String	dataSource() The geospatial data provider attached to the place index resource specified in the request.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<Double>	filterBBox() Contains the coordinates for the optional bounding box specified in the request.
List<String>	filterCountries() Contains the optional country filter specified in the 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()
String	language() The preferred language used to return results.
Integer	maxResults() Contains the optional result count limit specified in the request.
List<SdkField<?>>	sdkFields()
static Class<? extends SearchPlaceIndexForSuggestionsSummary.Builder>	serializableBuilderClass()
String	text() The free-form partial text input specified in the request.
SearchPlaceIndexForSuggestionsSummary.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 optional bias position specified in the request.

This parameter contains a pair of numbers. The first number represents the X coordinate, or longitude; the second number represents the Y coordinate, or latitude.

For example, [-123.1174, 49.2847] represents the position with longitude -123.1174 and latitude 49.2847.

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 optional bias position specified in the request.

This parameter contains a pair of numbers. The first number represents the X coordinate, or longitude; the second number represents the Y coordinate, or latitude.

For example, [-123.1174, 49.2847] represents the position with longitude -123.1174 and latitude 49.2847.

dataSource

public final String dataSource()

The geospatial data provider attached to the place index resource specified in the request. Values can be one of the following:

• Esri

• Grab

• Here

For more information about data providers, see Amazon Location Service data providers.

Returns:

The geospatial data provider attached to the place index resource specified in the request. Values can be one of the following:

• Esri

• Grab

• Here

For more information about 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 specified in the 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 specified in the 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 optional country filter specified in the 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 optional country filter specified in the request.

language

public final String language()

The preferred language used to return results. Matches the language in the request. The value is a valid BCP 47 language tag, for example, en for English.

Returns:

The preferred language used to return results. Matches the language in the request. The value is a valid BCP 47 language tag, for example, en for English.

maxResults

public final Integer maxResults()

Contains the optional result count limit specified in the request.

Returns:

Contains the optional result count limit specified in the request.

text

public final String text()

The free-form partial text input specified in the request.

Returns:

The free-form partial text input specified in the request.

toBuilder

public SearchPlaceIndexForSuggestionsSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SearchPlaceIndexForSuggestionsSummary.Builder,SearchPlaceIndexForSuggestionsSummary>

builder

public static SearchPlaceIndexForSuggestionsSummary.Builder builder()

serializableBuilderClass

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