Package software.amazon.awssdk.services.geoplaces.model

Class SuggestResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.geoplaces.model.GeoPlacesResponse

software.amazon.awssdk.services.geoplaces.model.SuggestResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<SuggestResponse.Builder,SuggestResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SuggestResponse.Builder

Method Summary

Modifier and Type	Method	Description
static SuggestResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasQueryRefinements()	For responses, this returns true if the service returned a value for the QueryRefinements property.
boolean	hasResultItems()	For responses, this returns true if the service returned a value for the ResultItems property.
String	pricingBucket()	The pricing bucket for which the query is charged at.
List<QueryRefinement>	queryRefinements()	Maximum number of query terms to be returned for use with a search text query.
List<SuggestResultItem>	resultItems()	List of places or results returned for a query.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends SuggestResponse.Builder>	serializableBuilderClass()
SuggestResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.geoplaces.model.GeoPlacesResponse

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

pricingBucket

public final String pricingBucket()

The pricing bucket for which the query is charged at.

For more inforamtion on pricing, please visit Amazon Location Service Pricing.

Returns:

The pricing bucket for which the query is charged at.

For more inforamtion on pricing, please visit Amazon Location Service Pricing.

hasResultItems

public final boolean hasResultItems()

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

resultItems

public final List<SuggestResultItem> resultItems()

List of places or results returned for a query.

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

Returns:

List of places or results returned for a query.

hasQueryRefinements

public final boolean hasQueryRefinements()

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

queryRefinements

public final List<QueryRefinement> queryRefinements()

Maximum number of query terms to be returned for use with a search text query.

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

Returns:

Maximum number of query terms to be returned for use with a search text query.

toBuilder

public SuggestResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SuggestResponse.Builder,SuggestResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static SuggestResponse.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo