Class CfnIndexPropsMixin.SearchProperty.Builder
java.lang.Object
software.amazon.awscdk.cfnpropertymixins.services.kendra.CfnIndexPropsMixin.SearchProperty.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnIndexPropsMixin.SearchProperty>
- Enclosing interface:
CfnIndexPropsMixin.SearchProperty
@Stability(Stable)
public static final class CfnIndexPropsMixin.SearchProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnIndexPropsMixin.SearchProperty>
A builder for
CfnIndexPropsMixin.SearchProperty-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()Builds the configured instance.displayable(Boolean displayable) Sets the value ofCfnIndexPropsMixin.SearchProperty.getDisplayable()displayable(IResolvable displayable) Sets the value ofCfnIndexPropsMixin.SearchProperty.getDisplayable()Sets the value ofCfnIndexPropsMixin.SearchProperty.getFacetable()facetable(IResolvable facetable) Sets the value ofCfnIndexPropsMixin.SearchProperty.getFacetable()searchable(Boolean searchable) Sets the value ofCfnIndexPropsMixin.SearchProperty.getSearchable()searchable(IResolvable searchable) Sets the value ofCfnIndexPropsMixin.SearchProperty.getSearchable()Sets the value ofCfnIndexPropsMixin.SearchProperty.getSortable()sortable(IResolvable sortable) Sets the value ofCfnIndexPropsMixin.SearchProperty.getSortable()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
displayable
@Stability(Stable) public CfnIndexPropsMixin.SearchProperty.Builder displayable(Boolean displayable) Sets the value ofCfnIndexPropsMixin.SearchProperty.getDisplayable()- Parameters:
displayable- Determines whether the field is returned in the query response. The default istrue.- Returns:
this
-
displayable
@Stability(Stable) public CfnIndexPropsMixin.SearchProperty.Builder displayable(IResolvable displayable) Sets the value ofCfnIndexPropsMixin.SearchProperty.getDisplayable()- Parameters:
displayable- Determines whether the field is returned in the query response. The default istrue.- Returns:
this
-
facetable
Sets the value ofCfnIndexPropsMixin.SearchProperty.getFacetable()- Parameters:
facetable- Indicates that the field can be used to create search facets, a count of results for each value in the field. The default isfalse.- Returns:
this
-
facetable
@Stability(Stable) public CfnIndexPropsMixin.SearchProperty.Builder facetable(IResolvable facetable) Sets the value ofCfnIndexPropsMixin.SearchProperty.getFacetable()- Parameters:
facetable- Indicates that the field can be used to create search facets, a count of results for each value in the field. The default isfalse.- Returns:
this
-
searchable
Sets the value ofCfnIndexPropsMixin.SearchProperty.getSearchable()- Parameters:
searchable- Determines whether the field is used in the search. If theSearchablefield istrue, you can use relevance tuning to manually tune how Amazon Kendra weights the field in the search. The default istruefor string fields andfalsefor number and date fields.- Returns:
this
-
searchable
@Stability(Stable) public CfnIndexPropsMixin.SearchProperty.Builder searchable(IResolvable searchable) Sets the value ofCfnIndexPropsMixin.SearchProperty.getSearchable()- Parameters:
searchable- Determines whether the field is used in the search. If theSearchablefield istrue, you can use relevance tuning to manually tune how Amazon Kendra weights the field in the search. The default istruefor string fields andfalsefor number and date fields.- Returns:
this
-
sortable
Sets the value ofCfnIndexPropsMixin.SearchProperty.getSortable()- Parameters:
sortable- Determines whether the field can be used to sort the results of a query. The default isfalse.- Returns:
this
-
sortable
Sets the value ofCfnIndexPropsMixin.SearchProperty.getSortable()- Parameters:
sortable- Determines whether the field can be used to sort the results of a query. The default isfalse.- Returns:
this
-
build
Builds the configured instance.- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<CfnIndexPropsMixin.SearchProperty>- Returns:
- a new instance of
CfnIndexPropsMixin.SearchProperty - Throws:
NullPointerException- if any required attribute was not provided
-