java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.geoplaces.model.GeoPlacesRequest
    - - software.amazon.awssdk.services.geoplaces.model.SuggestRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<SuggestRequest.Builder,SuggestRequest>

@Generated("software.amazon.awssdk:codegen")
public final class SuggestRequest
extends GeoPlacesRequest
implements ToCopyableBuilder<SuggestRequest.Builder,SuggestRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface SuggestRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`List<SuggestAdditionalFeature>`	`additionalFeatures()`	A list of optional additional parameters, such as time zone, that can be requested for each result.
`List<String>`	`additionalFeaturesAsStrings()`	A list of optional additional parameters, such as time zone, that can be requested for each result.
`List<Double>`	`biasPosition()`	The position, in longitude and latitude, that the results should be close to.
`static SuggestRequest.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`SuggestFilter`	`filter()`	A structure which contains a set of inclusion/exclusion properties that results must posses in order to be returned as a result.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAdditionalFeatures()`	For responses, this returns true if the service returned a value for the AdditionalFeatures property.
`boolean`	`hasBiasPosition()`	For responses, this returns true if the service returned a value for the BiasPosition property.
`int`	`hashCode()`
`SuggestIntendedUse`	`intendedUse()`	Indicates if the results will be stored.
`String`	`intendedUseAsString()`	Indicates if the results will be stored.
`String`	`key()`	Optional: The API key to be used for authorization.
`String`	`language()`	A list of BCP 47 compliant language codes for the results to be rendered in.
`Integer`	`maxQueryRefinements()`	Maximum number of query terms to be returned for use with a search text query.
`Integer`	`maxResults()`	An optional limit for the number of results returned in a single call.
`String`	`politicalView()`	The alpha-2 or alpha-3 character code for the political view of a country.
`String`	`queryText()`	The free-form text query to match addresses against.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends SuggestRequest.Builder>`	`serializableBuilderClass()`
`SuggestRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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
  - queryText
```
public final String 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.
    
    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.
  - maxResults
```
public final Integer 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.
  - maxQueryRefinements
```
public final Integer maxQueryRefinements()
```
    Maximum number of query terms to be returned for use with a search text query.
    
    Returns:
    
    Maximum number of query terms to be returned for use with a search text query.
  - 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()
```
    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, and FilterCircle 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, and FilterCircle are mutually exclusive.
  - filter
```
public final SuggestFilter filter()
```
    A structure which contains a set of inclusion/exclusion properties that results must posses in order to be returned as a result.
    
    Returns:
    
    A structure which contains a set of inclusion/exclusion properties that results must posses in order to be returned as a result.
  - additionalFeatures
```
public final List<SuggestAdditionalFeature> additionalFeatures()
```
    A list of optional additional parameters, such as time zone, 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, such as time zone, 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 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.
  - additionalFeaturesAsStrings
```
public final List<String> additionalFeaturesAsStrings()
```
    A list of optional additional parameters, such as time zone, 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, such as time zone, that can be requested for each result.
  - language
```
public final String 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
```
public final String 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.
    
    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.
  - intendedUse
```
public final SuggestIntendedUse 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 return SuggestIntendedUse.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from intendedUseAsString().
    
    Returns:
    
    Indicates if the results will be stored. Defaults to SingleUse, if left empty.
    
    See Also:
    
    SuggestIntendedUse
  - intendedUseAsString
```
public final String 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 return SuggestIntendedUse.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from intendedUseAsString().
    
    Returns:
    
    Indicates if the results will be stored. Defaults to SingleUse, if left empty.
    
    See Also:
    
    SuggestIntendedUse
  - key
```
public final String 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
```
public SuggestRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<SuggestRequest.Builder,SuggestRequest>
    
    Specified by:
    
    toBuilder in class GeoPlacesRequest
  - builder
```
public static SuggestRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends SuggestRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - 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)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class SuggestRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

queryText

maxResults

maxQueryRefinements

hasBiasPosition

biasPosition

filter

additionalFeatures

hasAdditionalFeatures

additionalFeaturesAsStrings

language

politicalView

intendedUse

intendedUseAsString

key

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField