Class AutocompleteRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<AutocompleteRequest.Builder,
AutocompleteRequest>
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionA list of optional additional parameters that can be requested for each result.A list of optional additional parameters that can be requested for each result.The position in longitude and latitude that the results should be close to.static AutocompleteRequest.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final AutocompleteFilter
filter()
A structure which contains a set of inclusion/exclusion properties that results must possess in order to be returned as a result.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 AdditionalFeatures property.final boolean
For responses, this returns true if the service returned a value for the BiasPosition property.final int
hashCode()
final AutocompleteIntendedUse
Indicates if the results will be stored.final String
Indicates if the results will be stored.final String
key()
Optional: The API key to be used for authorization.final String
language()
A list of BCP 47 compliant language codes for the results to be rendered in.final Integer
An optional limit for the number of results returned in a single call.final String
The alpha-2 or alpha-3 character code for the political view of a country.final PostalCodeMode
ThePostalCodeMode
affects how postal code results are returned.final String
ThePostalCodeMode
affects how postal code results are returned.final String
The free-form text query to match addresses against.static Class
<? extends AutocompleteRequest.Builder> 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
-
queryText
The free-form text query to match addresses against. This is usually a partially typed address from an end user in an address box or form.
The fields
QueryText
, andQueryID
are mutually exclusive.- Returns:
- The free-form text query to match addresses against. This is usually a partially typed address from an
end user in an address box or form.
The fields
QueryText
, andQueryID
are mutually exclusive.
-
maxResults
An optional limit for the number of results returned in a single call.
- Returns:
- An optional limit for the number of results returned in a single call.
-
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
The position in longitude and latitude that the results should be close to. Typically, place results returned are ranked higher the closer they are to this position. Stored in
[lng, lat]
and in the WSG84 format.The fields
BiasPosition
,FilterBoundingBox
, andFilterCircle
are mutually exclusive.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:
- The position in longitude and latitude that the results should be close to. Typically, place results
returned are ranked higher the closer they are to this position. Stored in
[lng, lat]
and in the WSG84 format.The fields
BiasPosition
,FilterBoundingBox
, andFilterCircle
are mutually exclusive.
-
filter
A structure which contains a set of inclusion/exclusion properties that results must possess in order to be returned as a result.
- Returns:
- A structure which contains a set of inclusion/exclusion properties that results must possess in order to be returned as a result.
-
postalCodeMode
The
PostalCodeMode
affects how postal code results are returned. If a postal code spans multiple localities and this value is empty, partial district or locality information may be returned under a single postal code result entry. If it's populated with the valueEnumerateSpannedLocalities
, all cities in that postal code are returned.If the service returns an enum value that is not available in the current SDK version,
postalCodeMode
will returnPostalCodeMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frompostalCodeModeAsString()
.- Returns:
- The
PostalCodeMode
affects how postal code results are returned. If a postal code spans multiple localities and this value is empty, partial district or locality information may be returned under a single postal code result entry. If it's populated with the valueEnumerateSpannedLocalities
, all cities in that postal code are returned. - See Also:
-
postalCodeModeAsString
The
PostalCodeMode
affects how postal code results are returned. If a postal code spans multiple localities and this value is empty, partial district or locality information may be returned under a single postal code result entry. If it's populated with the valueEnumerateSpannedLocalities
, all cities in that postal code are returned.If the service returns an enum value that is not available in the current SDK version,
postalCodeMode
will returnPostalCodeMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frompostalCodeModeAsString()
.- Returns:
- The
PostalCodeMode
affects how postal code results are returned. If a postal code spans multiple localities and this value is empty, partial district or locality information may be returned under a single postal code result entry. If it's populated with the valueEnumerateSpannedLocalities
, all cities in that postal code are returned. - See Also:
-
additionalFeatures
A list of optional additional parameters that can be requested for each result.
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
hasAdditionalFeatures()
method.- Returns:
- A list of optional additional parameters that can be requested for each result.
-
hasAdditionalFeatures
public final boolean hasAdditionalFeatures()For responses, this returns true if the service returned a value for the AdditionalFeatures 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. -
additionalFeaturesAsStrings
A list of optional additional parameters that can be requested for each result.
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
hasAdditionalFeatures()
method.- Returns:
- A list of optional additional parameters that can be requested for each result.
-
language
A list of BCP 47 compliant language codes for the results to be rendered in. If there is no data for the result in the requested language, data will be returned in the default language for the entry.
- Returns:
- A list of BCP 47 compliant language codes for the results to be rendered in. If there is no data for the result in the requested language, data will be returned in the default language for the entry.
-
politicalView
The alpha-2 or alpha-3 character code for the political view of a country. The political view applies to the results of the request to represent unresolved territorial claims through the point of view of the specified country.
The following political views are currently supported:
-
ARG
: Argentina's view on the Southern Patagonian Ice Field and Tierra Del Fuego, including the Falkland Islands, South Georgia, and South Sandwich Islands -
EGY
: Egypt's view on Bir Tawil -
IND
: India's view on Gilgit-Baltistan -
KEN
: Kenya's view on the Ilemi Triangle -
MAR
: Morocco's view on Western Sahara -
RUS
: Russia's view on Crimea -
SDN
: Sudan's view on the Halaib Triangle -
SRB
: Serbia's view on Kosovo, Vukovar, and Sarengrad Islands -
SUR
: Suriname's view on the Courantyne Headwaters and Lawa Headwaters -
SYR
: Syria's view on the Golan Heights -
TUR
: Turkey's view on Cyprus and Northern Cyprus -
TZA
: Tanzania's view on Lake Malawi -
URY
: Uruguay's view on Rincon de Artigas -
VNM
: Vietnam's view on the Paracel Islands and Spratly Islands
- Returns:
- The alpha-2 or alpha-3 character code for the political view of a country. The political view applies to
the results of the request to represent unresolved territorial claims through the point of view of the
specified country.
The following political views are currently supported:
-
ARG
: Argentina's view on the Southern Patagonian Ice Field and Tierra Del Fuego, including the Falkland Islands, South Georgia, and South Sandwich Islands -
EGY
: Egypt's view on Bir Tawil -
IND
: India's view on Gilgit-Baltistan -
KEN
: Kenya's view on the Ilemi Triangle -
MAR
: Morocco's view on Western Sahara -
RUS
: Russia's view on Crimea -
SDN
: Sudan's view on the Halaib Triangle -
SRB
: Serbia's view on Kosovo, Vukovar, and Sarengrad Islands -
SUR
: Suriname's view on the Courantyne Headwaters and Lawa Headwaters -
SYR
: Syria's view on the Golan Heights -
TUR
: Turkey's view on Cyprus and Northern Cyprus -
TZA
: Tanzania's view on Lake Malawi -
URY
: Uruguay's view on Rincon de Artigas -
VNM
: Vietnam's view on the Paracel Islands and Spratly Islands
-
-
-
intendedUse
Indicates if the results will be stored. Defaults to
SingleUse
, if left empty.If the service returns an enum value that is not available in the current SDK version,
intendedUse
will returnAutocompleteIntendedUse.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromintendedUseAsString()
.- Returns:
- Indicates if the results will be stored. Defaults to
SingleUse
, if left empty. - See Also:
-
intendedUseAsString
Indicates if the results will be stored. Defaults to
SingleUse
, if left empty.If the service returns an enum value that is not available in the current SDK version,
intendedUse
will returnAutocompleteIntendedUse.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromintendedUseAsString()
.- Returns:
- Indicates if the results will be stored. Defaults to
SingleUse
, if left empty. - See Also:
-
key
Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.
- Returns:
- Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a 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<AutocompleteRequest.Builder,
AutocompleteRequest> - Specified by:
toBuilder
in classGeoPlacesRequest
- 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
-
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
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
- Returns:
- The mapping between the field name and its corresponding field.
-