software.amazon.awssdk.services.location.model

Class SearchPlaceIndexForTextResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.location.model.LocationResponse

software.amazon.awssdk.services.location.model.SearchPlaceIndexForTextResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<SearchPlaceIndexForTextResponse.Builder,SearchPlaceIndexForTextResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SearchPlaceIndexForTextResponse.Builder

Method Summary

Modifier and Type	Method and Description
static SearchPlaceIndexForTextResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasResults() For responses, this returns true if the service returned a value for the Results property.
List<SearchForTextResult>	results() A list of Places matching the input text.
List<SdkField<?>>	sdkFields()
static Class<? extends SearchPlaceIndexForTextResponse.Builder>	serializableBuilderClass()
SearchPlaceIndexForTextSummary	summary() Contains a summary of the request.
SearchPlaceIndexForTextResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.location.model.LocationResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

hasResults

public final boolean hasResults()

For responses, this returns true if the service returned a value for the Results 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.

results

public final List<SearchForTextResult> results()

A list of Places matching the input text. Each result contains additional information about the specific point of interest.

Not all response properties are included with all responses. Some properties may only be returned by specific data partners.

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 hasResults() method.

Returns:

A list of Places matching the input text. Each result contains additional information about the specific point of interest.

Not all response properties are included with all responses. Some properties may only be returned by specific data partners.

summary

public final SearchPlaceIndexForTextSummary summary()

Contains a summary of the request. Echoes the input values for BiasPosition, FilterBBox, FilterCountries, Language, MaxResults, and Text. Also includes the DataSource of the place index and the bounding box, ResultBBox, which surrounds the search results.

Returns:

Contains a summary of the request. Echoes the input values for BiasPosition, FilterBBox, FilterCountries, Language, MaxResults, and Text. Also includes the DataSource of the place index and the bounding box, ResultBBox, which surrounds the search results.

toBuilder

public SearchPlaceIndexForTextResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SearchPlaceIndexForTextResponse.Builder,SearchPlaceIndexForTextResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static SearchPlaceIndexForTextResponse.Builder builder()

serializableBuilderClass

public static Class<? extends SearchPlaceIndexForTextResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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 SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo