Package software.amazon.awscdk.services.kendra

Class CfnIndex.SearchProperty.Builder

java.lang.Object

software.amazon.awscdk.services.kendra.CfnIndex.SearchProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnIndex.SearchProperty>

Enclosing interface:

CfnIndex.SearchProperty

@Stability(Stable)
public static final class CfnIndex.SearchProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnIndex.SearchProperty>

A builder for CfnIndex.SearchProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnIndex.SearchProperty	build()	Builds the configured instance.
CfnIndex.SearchProperty.Builder	displayable(Boolean displayable)	Sets the value of CfnIndex.SearchProperty.getDisplayable()
CfnIndex.SearchProperty.Builder	displayable(IResolvable displayable)	Sets the value of CfnIndex.SearchProperty.getDisplayable()
CfnIndex.SearchProperty.Builder	facetable(Boolean facetable)	Sets the value of CfnIndex.SearchProperty.getFacetable()
CfnIndex.SearchProperty.Builder	facetable(IResolvable facetable)	Sets the value of CfnIndex.SearchProperty.getFacetable()
CfnIndex.SearchProperty.Builder	searchable(Boolean searchable)	Sets the value of CfnIndex.SearchProperty.getSearchable()
CfnIndex.SearchProperty.Builder	searchable(IResolvable searchable)	Sets the value of CfnIndex.SearchProperty.getSearchable()
CfnIndex.SearchProperty.Builder	sortable(Boolean sortable)	Sets the value of CfnIndex.SearchProperty.getSortable()
CfnIndex.SearchProperty.Builder	sortable(IResolvable sortable)	Sets the value of CfnIndex.SearchProperty.getSortable()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

displayable

@Stability(Stable)
public CfnIndex.SearchProperty.Builder displayable(Boolean displayable)

Sets the value of CfnIndex.SearchProperty.getDisplayable()

Parameters:

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

Returns:

this

displayable

@Stability(Stable)
public CfnIndex.SearchProperty.Builder displayable(IResolvable displayable)

Sets the value of CfnIndex.SearchProperty.getDisplayable()

Parameters:

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

Returns:

this

facetable

@Stability(Stable)
public CfnIndex.SearchProperty.Builder facetable(Boolean facetable)

Sets the value of CfnIndex.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 is false .

Returns:

this

facetable

@Stability(Stable)
public CfnIndex.SearchProperty.Builder facetable(IResolvable facetable)

Sets the value of CfnIndex.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 is false .

Returns:

this

searchable

@Stability(Stable)
public CfnIndex.SearchProperty.Builder searchable(Boolean searchable)

Sets the value of CfnIndex.SearchProperty.getSearchable()

Parameters:

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:

this

searchable

@Stability(Stable)
public CfnIndex.SearchProperty.Builder searchable(IResolvable searchable)

Sets the value of CfnIndex.SearchProperty.getSearchable()

Parameters:

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:

this

sortable

@Stability(Stable)
public CfnIndex.SearchProperty.Builder sortable(Boolean sortable)

Sets the value of CfnIndex.SearchProperty.getSortable()

Parameters:

sortable - Determines whether the field can be used to sort the results of a query. The default is false .

Returns:

this

sortable

@Stability(Stable)
public CfnIndex.SearchProperty.Builder sortable(IResolvable sortable)

Sets the value of CfnIndex.SearchProperty.getSortable()

Parameters:

sortable - Determines whether the field can be used to sort the results of a query. The default is false .

Returns:

this

build

@Stability(Stable)
public CfnIndex.SearchProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnIndex.SearchProperty>

Returns:

a new instance of CfnIndex.SearchProperty

Throws:

NullPointerException - if any required attribute was not provided