software.amazon.awssdk.services.location.model

Class SearchPlaceIndexForTextRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.location.model.LocationRequest

software.amazon.awssdk.services.location.model.SearchPlaceIndexForTextRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<SearchPlaceIndexForTextRequest.Builder,SearchPlaceIndexForTextRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class SearchPlaceIndexForTextRequest
extends LocationRequest
implements ToCopyableBuilder<SearchPlaceIndexForTextRequest.Builder,SearchPlaceIndexForTextRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SearchPlaceIndexForTextRequest.Builder

Method Summary

Modifier and Type	Method and Description
List<Double>	biasPosition() Searches for results closest to the given position.
static SearchPlaceIndexForTextRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<Double>	filterBBox() Filters the results by returning only Places within the provided bounding box.
List<String>	filterCountries() Limits the search to the given a list of countries/regions.
<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	indexName() The name of the place index resource you want to use for the search.
Integer	maxResults() An optional parameter.
List<SdkField<?>>	sdkFields()
static Class<? extends SearchPlaceIndexForTextRequest.Builder>	serializableBuilderClass()
String	text() The address, name, city, or region to be used in the search.
SearchPlaceIndexForTextRequest.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

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()

Searches for results closest to the given position. An optional parameter defined by longitude, and latitude.

• The first bias position is the X coordinate, or longitude.

• The second bias position is the Y coordinate, or latitude.

For example, bias=xLongitude&bias=yLatitude.

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:

Searches for results closest to the given position. An optional parameter defined by longitude, and latitude.

• The first bias position is the X coordinate, or longitude.

• The second bias position is the Y coordinate, or latitude.

For example, bias=xLongitude&bias=yLatitude.

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()

Filters the results by returning only Places within the provided bounding box. An optional parameter.

The first 2 bbox parameters describe the lower southwest corner:

• The first bbox position is the X coordinate or longitude of the lower southwest corner.

• The second bbox position is the Y coordinate or latitude of the lower southwest corner.

For example, bbox=xLongitudeSW&bbox=yLatitudeSW.

The next bbox parameters describe the upper northeast corner:

• The third bbox position is the X coordinate, or longitude of the upper northeast corner.

• The fourth bbox position is the Y coordinate, or longitude of the upper northeast corner.

For example, bbox=xLongitudeNE&bbox=yLatitudeNE

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:

Filters the results by returning only Places within the provided bounding box. An optional parameter.

The first 2 bbox parameters describe the lower southwest corner:

• The first bbox position is the X coordinate or longitude of the lower southwest corner.

• The second bbox position is the Y coordinate or latitude of the lower southwest corner.

For example, bbox=xLongitudeSW&bbox=yLatitudeSW.

The next bbox parameters describe the upper northeast corner:

• The third bbox position is the X coordinate, or longitude of the upper northeast corner.

• The fourth bbox position is the Y coordinate, or longitude of the upper northeast corner.

For example, bbox=xLongitudeNE&bbox=yLatitudeNE

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()

Limits the search to the given a list of countries/regions. An optional parameter.

• Use the ISO 3166 3-digit country code. 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:

Limits the search to the given a list of countries/regions. An optional parameter.

• Use the ISO 3166 3-digit country code. For example, Australia uses three upper-case characters: AUS.

indexName

public final String 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.

maxResults

public final Integer 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

public final String 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

public SearchPlaceIndexForTextRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SearchPlaceIndexForTextRequest.Builder,SearchPlaceIndexForTextRequest>

Specified by:

toBuilder in class LocationRequest

builder

public static SearchPlaceIndexForTextRequest.Builder builder()

serializableBuilderClass

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