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

Class QueryRefinement

java.lang.Object

software.amazon.awssdk.services.geoplaces.model.QueryRefinement

All Implemented Interfaces:

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

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

Suggestions for refining individual query terms. Suggestions are returned as objects which note the term, suggested replacement, and its index in the query.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	QueryRefinement.Builder

Method Summary

Modifier and Type	Method	Description
static QueryRefinement.Builder	builder()
Integer	endIndex()	End index of the parsed query.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	originalTerm()	The sub-string of the original query that is replaced by this query term.
String	refinedTerm()	The term that will be suggested to the user.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends QueryRefinement.Builder>	serializableBuilderClass()
Integer	startIndex()	Start index of the parsed component.
QueryRefinement.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

refinedTerm

public final String refinedTerm()

The term that will be suggested to the user.

Returns:

The term that will be suggested to the user.

originalTerm

public final String originalTerm()

The sub-string of the original query that is replaced by this query term.

Returns:

The sub-string of the original query that is replaced by this query term.

startIndex

public final Integer startIndex()

Start index of the parsed component.

Returns:

Start index of the parsed component.

endIndex

public final Integer endIndex()

End index of the parsed query.

Returns:

End index of the parsed query.

toBuilder

public QueryRefinement.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<QueryRefinement.Builder,QueryRefinement>

builder

public static QueryRefinement.Builder builder()

serializableBuilderClass

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