Interface CfnIndex.SearchProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnIndex.SearchProperty.Jsii$Proxy
- Enclosing class:
CfnIndex
@Stability(Stable)
public static interface CfnIndex.SearchProperty
extends software.amazon.jsii.JsiiSerializable
Provides information about how a custom index field is used during a search.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.kendra.*; SearchProperty searchProperty = SearchProperty.builder() .displayable(false) .facetable(false) .searchable(false) .sortable(false) .build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnIndex.SearchProperty
static final class
An implementation forCfnIndex.SearchProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default Object
Determines whether the field is returned in the query response.default Object
Indicates that the field can be used to create search facets, a count of results for each value in the field.default Object
Determines whether the field is used in the search.default Object
Determines whether the field can be used to sort the results of a query.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getDisplayable
Determines whether the field is returned in the query response.The default is
true
.- See Also:
-
getFacetable
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
.- See Also:
-
getSearchable
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.- See Also:
-
getSortable
Determines whether the field can be used to sort the results of a query.The default is
false
.- See Also:
-
builder
- Returns:
- a
CfnIndex.SearchProperty.Builder
ofCfnIndex.SearchProperty
-