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

Class SuggestQueryResult

java.lang.Object

software.amazon.awssdk.services.geoplaces.model.SuggestQueryResult

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<SuggestQueryResult.Builder,SuggestQueryResult>

@Generated("software.amazon.awssdk:codegen")
public final class SuggestQueryResult
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<SuggestQueryResult.Builder,SuggestQueryResult>

The suggested query results.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SuggestQueryResult.Builder

Method Summary

Modifier and Type	Method	Description
static SuggestQueryResult.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	queryId()	QueryId can be used to complete a follow up query through the SearchText API.
QueryType	queryType()	The query type.
String	queryTypeAsString()	The query type.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends SuggestQueryResult.Builder>	serializableBuilderClass()
SuggestQueryResult.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

queryId

public final String queryId()

QueryId can be used to complete a follow up query through the SearchText API. The QueryId retains context from the original Suggest request such as filters, political view and language. See the SearchText API documentation for more details SearchText API docs.

Returns:

QueryId can be used to complete a follow up query through the SearchText API. The QueryId retains context from the original Suggest request such as filters, political view and language. See the SearchText API documentation for more details SearchText API docs.

queryType

public final QueryType queryType()

The query type. Category qeuries will search for places which have an entry matching the given category, for example "doctor office". BusinessChain queries will search for instances of a given business.

If the service returns an enum value that is not available in the current SDK version, queryType will return QueryType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from queryTypeAsString().

Returns:

The query type. Category qeuries will search for places which have an entry matching the given category, for example "doctor office". BusinessChain queries will search for instances of a given business.

See Also:

QueryType

queryTypeAsString

public final String queryTypeAsString()

The query type. Category qeuries will search for places which have an entry matching the given category, for example "doctor office". BusinessChain queries will search for instances of a given business.

If the service returns an enum value that is not available in the current SDK version, queryType will return QueryType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from queryTypeAsString().

Returns:

The query type. Category qeuries will search for places which have an entry matching the given category, for example "doctor office". BusinessChain queries will search for instances of a given business.

See Also:

QueryType

toBuilder

public SuggestQueryResult.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SuggestQueryResult.Builder,SuggestQueryResult>

builder

public static SuggestQueryResult.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

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