Package software.amazon.awscdk.services.kendra

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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-search.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnIndex.SearchProperty.Builder	A builder for CfnIndex.SearchProperty
static final class	CfnIndex.SearchProperty.Jsii$Proxy	An implementation for CfnIndex.SearchProperty

Method Summary

Modifier and Type	Method	Description
static CfnIndex.SearchProperty.Builder	builder()
default Object	getDisplayable()	Determines whether the field is returned in the query response.
default Object	getFacetable()	Indicates that the field can be used to create search facets, a count of results for each value in the field.
default Object	getSearchable()	Determines whether the field is used in the search.
default Object	getSortable()	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

@Stability(Stable)
@Nullable
default Object getDisplayable()

Determines whether the field is returned in the query response.

The default is true .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-search.html#cfn-kendra-index-search-displayable

getFacetable

@Stability(Stable)
@Nullable
default Object 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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-search.html#cfn-kendra-index-search-facetable

getSearchable

@Stability(Stable)
@Nullable
default Object getSearchable()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-search.html#cfn-kendra-index-search-searchable

getSortable

@Stability(Stable)
@Nullable
default Object getSortable()

Determines whether the field can be used to sort the results of a query.

The default is false .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-search.html#cfn-kendra-index-search-sortable

builder

@Stability(Stable)
static CfnIndex.SearchProperty.Builder builder()

Returns:

a CfnIndex.SearchProperty.Builder of CfnIndex.SearchProperty