Class Search
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Search.Builder,
Search>
Provides information about how a custom index field is used during a search.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic Search.Builder
builder()
final Boolean
Determines whether the field is returned in the query response.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final Boolean
Indicates that the field can be used to create search facets, a count of results for each value in the field.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final Boolean
Determines whether the field is used in the search.static Class
<? extends Search.Builder> final Boolean
sortable()
Determines whether the field can be used to sort the results of a query.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
Determines whether the field is used in the search. If the
Searchable
field istrue
, you can use relevance tuning to manually tune how Amazon Kendra weights the field in the search. The default istrue
for string fields andfalse
for number and date fields.- Returns:
- Determines whether the field is used in the search. If the
Searchable
field istrue
, you can use relevance tuning to manually tune how Amazon Kendra weights the field in the search. The default istrue
for string fields andfalse
for number and date fields.
-
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
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 totrue
, Amazon Kendra returns an exception. The default isfalse
.- 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 totrue
, Amazon Kendra returns an exception. The default isfalse
.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<Search.Builder,
Search> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-