Package software.amazon.awssdk.services.kendra.model

Class Search

java.lang.Object

software.amazon.awssdk.services.kendra.model.Search

All Implemented Interfaces:

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

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

Provides information about how a custom index field is used during a search.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Search.Builder

Method Summary

Modifier and Type	Method	Description
static Search.Builder	builder()
Boolean	displayable()	Determines whether the field is returned in the query response.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Boolean	facetable()	Indicates that the field can be used to create search facets, a count of results for each value in the field.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
Boolean	searchable()	Determines whether the field is used in the search.
static Class<? extends Search.Builder>	serializableBuilderClass()
Boolean	sortable()	Determines whether the field can be used to sort the results of a query.
Search.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

facetable

public final Boolean facetable()

Indicates that the field can be used to create search facets, a count of results for each value in the field. The default is false .

Returns:

Indicates that the field can be used to create search facets, a count of results for each value in the field. The default is false .

searchable

public final Boolean searchable()

Determines whether the field is used in the search. If the Searchable field is true, you can use relevance tuning to manually tune how Amazon Kendra weights the field in the search. The default is true for string fields and false for number and date fields.

Returns:

Determines whether the field is used in the search. If the Searchable field is true, you can use relevance tuning to manually tune how Amazon Kendra weights the field in the search. The default is true for string fields and false for number and date fields.

displayable

public final Boolean displayable()

Determines whether the field is returned in the query response. The default is true.

Returns:

Determines whether the field is returned in the query response. The default is true.

sortable

public final Boolean sortable()

Determines whether the field can be used to sort the results of a query. If you specify sorting on a field that does not have Sortable set to true, Amazon Kendra returns an exception. The default is false.

Returns:

Determines whether the field can be used to sort the results of a query. If you specify sorting on a field that does not have Sortable set to true, Amazon Kendra returns an exception. The default is false.

toBuilder

public Search.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Search.Builder,Search>

builder

public static Search.Builder builder()

serializableBuilderClass

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