Class SearchPlaceIndexForSuggestionsSummary
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<SearchPlaceIndexForSuggestionsSummary.Builder,
SearchPlaceIndexForSuggestionsSummary>
A summary of the request sent by using SearchPlaceIndexForSuggestions
.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionContains the coordinates for the optional bias position specified in the request.builder()
final String
The geospatial data provider attached to the place index resource specified in the request.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.Contains the coordinates for the optional bounding box specified in the request.The optional category filter specified in the request.Contains the optional country filter specified in the request.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the BiasPosition property.final boolean
For responses, this returns true if the service returned a value for the FilterBBox property.final boolean
For responses, this returns true if the service returned a value for the FilterCategories property.final boolean
For responses, this returns true if the service returned a value for the FilterCountries property.final int
hashCode()
final String
language()
The preferred language used to return results.final Integer
Contains the optional result count limit specified in the request.static Class
<? extends SearchPlaceIndexForSuggestionsSummary.Builder> final String
text()
The free-form partial text input specified in the request.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
-
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 theisEmpty()
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
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 latitude49.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 latitude49.2847
.
-
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 theisEmpty()
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
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.
-
hasFilterCategories
public final boolean hasFilterCategories()For responses, this returns true if the service returned a value for the FilterCategories property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
filterCategories
The optional category 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
hasFilterCategories()
method.- Returns:
- The optional category filter 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 theisEmpty()
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
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
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
Contains the optional result count limit specified in the request.
- Returns:
- Contains the optional result count limit specified in the request.
-
text
The free-form partial text input specified in the request.
- Returns:
- The free-form partial text input specified in the request.
-
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<SearchPlaceIndexForSuggestionsSummary.Builder,
SearchPlaceIndexForSuggestionsSummary> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends SearchPlaceIndexForSuggestionsSummary.Builder> serializableBuilderClass() -
hashCode
public final int 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
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. -
getValueForField
-
sdkFields
-