Class SearchPlaceIndexForTextRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<SearchPlaceIndexForTextRequest.Builder,
SearchPlaceIndexForTextRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionAn optional parameter that indicates a preference for places that are closer to a specified position.builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.An optional parameter that limits the search results by returning only places that are within the provided bounding box.A list of one or more Amazon Location categories to filter the returned places.An optional parameter that limits the search results by returning only places that are in a specified list of countries.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.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
The name of the place index resource you want to use for the search.final String
key()
The optional API key to authorize the request.final String
language()
The preferred language used to return results.final Integer
An optional parameter.static Class
<? extends SearchPlaceIndexForTextRequest.Builder> final String
text()
The address, name, city, or region to be used in the search in free-form text format.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 class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
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
An optional parameter that indicates a preference for places that are closer to a specified position.
If provided, this parameter must contain 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
.BiasPosition
andFilterBBox
are mutually exclusive. Specifying both options results in an error.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:
- An optional parameter that indicates a preference for places that are closer to a specified position.
If provided, this parameter must contain 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
.BiasPosition
andFilterBBox
are mutually exclusive. Specifying both options results in an error.
-
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
An optional parameter that limits the search results by returning only places that are within the provided bounding box.
If provided, this parameter must contain a total of four consecutive numbers in two pairs. The first pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the southwest corner of the bounding box; the second pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the northeast corner of the bounding box.
For example,
[-12.7935, -37.4835, -12.0684, -36.9542]
represents a bounding box where the southwest corner has longitude-12.7935
and latitude-37.4835
, and the northeast corner has longitude-12.0684
and latitude-36.9542
.FilterBBox
andBiasPosition
are mutually exclusive. Specifying both options results in an error.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:
- An optional parameter that limits the search results by returning only places that are within the
provided bounding box.
If provided, this parameter must contain a total of four consecutive numbers in two pairs. The first pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the southwest corner of the bounding box; the second pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the northeast corner of the bounding box.
For example,
[-12.7935, -37.4835, -12.0684, -36.9542]
represents a bounding box where the southwest corner has longitude-12.7935
and latitude-37.4835
, and the northeast corner has longitude-12.0684
and latitude-36.9542
.FilterBBox
andBiasPosition
are mutually exclusive. Specifying both options results in an error.
-
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
A list of one or more Amazon Location categories to filter the returned places. If you include more than one category, the results will include results that match any of the categories listed.
For more information about using categories, including a list of Amazon Location categories, see Categories and filtering, in the Amazon Location Service Developer Guide.
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:
- A list of one or more Amazon Location categories to filter the returned places. If you include more than
one category, the results will include results that match any of the categories listed.
For more information about using categories, including a list of Amazon Location categories, see Categories and filtering, in the Amazon Location Service Developer Guide.
-
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
An optional parameter that limits the search results by returning only places that are in a specified list of countries.
-
Valid values include ISO 3166 3-digit country codes. For example, Australia uses three upper-case characters:
AUS
.
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:
- An optional parameter that limits the search results by returning only places that are in a specified
list of countries.
-
Valid values include ISO 3166 3-digit country codes. For example, Australia uses three upper-case characters:
AUS
.
-
-
-
indexName
The name of the place index resource you want to use for the search.
- Returns:
- The name of the place index resource you want to use for the search.
-
key
The optional API key to authorize the request.
- Returns:
- The optional API key to authorize the request.
-
language
The preferred language used to return results. The value must be a valid BCP 47 language tag, for example,
en
for English.This setting affects the languages used in the results, but not the results themselves. If no language is specified, or not supported for a particular result, the partner automatically chooses a language for the result.
For an example, we'll use the Greek language. You search for
Athens, Greece
, with thelanguage
parameter set toen
. The result found will most likely be returned asAthens
.If you set the
language
parameter toel
, for Greek, then the result found will more likely be returned asΑθήνα
.If the data provider does not have a value for Greek, the result will be in a language that the provider does support.
- Returns:
- The preferred language used to return results. The value must be a valid BCP 47 language tag, for example,
en
for English.This setting affects the languages used in the results, but not the results themselves. If no language is specified, or not supported for a particular result, the partner automatically chooses a language for the result.
For an example, we'll use the Greek language. You search for
Athens, Greece
, with thelanguage
parameter set toen
. The result found will most likely be returned asAthens
.If you set the
language
parameter toel
, for Greek, then the result found will more likely be returned asΑθήνα
.If the data provider does not have a value for Greek, the result will be in a language that the provider does support.
-
maxResults
An optional parameter. The maximum number of results returned per request.
The default:
50
- Returns:
- An optional parameter. The maximum number of results returned per request.
The default:
50
-
text
The address, name, city, or region to be used in the search in free-form text format. For example,
123 Any Street
.- Returns:
- The address, name, city, or region to be used in the search in free-form text format. For example,
123 Any Street
.
-
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<SearchPlaceIndexForTextRequest.Builder,
SearchPlaceIndexForTextRequest> - Specified by:
toBuilder
in classLocationRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
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
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-