Package software.amazon.awscdk.cfnpropertymixins.services.kendra

Class CfnFeaturedResultsSetMixinProps.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.kendra.CfnFeaturedResultsSetMixinProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnFeaturedResultsSetMixinProps>

Enclosing interface:

CfnFeaturedResultsSetMixinProps

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

A builder for CfnFeaturedResultsSetMixinProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnFeaturedResultsSetMixinProps	build()	Builds the configured instance.
CfnFeaturedResultsSetMixinProps.Builder	description(String description)	Sets the value of CfnFeaturedResultsSetMixinProps.getDescription()
CfnFeaturedResultsSetMixinProps.Builder	featuredDocuments(List<? extends Object> featuredDocuments)	Sets the value of CfnFeaturedResultsSetMixinProps.getFeaturedDocuments()
CfnFeaturedResultsSetMixinProps.Builder	featuredDocuments(IResolvable featuredDocuments)	Sets the value of CfnFeaturedResultsSetMixinProps.getFeaturedDocuments()
CfnFeaturedResultsSetMixinProps.Builder	featuredResultsSetName(String featuredResultsSetName)	Sets the value of CfnFeaturedResultsSetMixinProps.getFeaturedResultsSetName()
CfnFeaturedResultsSetMixinProps.Builder	indexId(String indexId)	Sets the value of CfnFeaturedResultsSetMixinProps.getIndexId()
CfnFeaturedResultsSetMixinProps.Builder	queryTexts(List<String> queryTexts)	Sets the value of CfnFeaturedResultsSetMixinProps.getQueryTexts()
CfnFeaturedResultsSetMixinProps.Builder	status(String status)	Sets the value of CfnFeaturedResultsSetMixinProps.getStatus()
CfnFeaturedResultsSetMixinProps.Builder	tags(List<? extends CfnTag> tags)	Sets the value of CfnFeaturedResultsSetMixinProps.getTags()

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

description

@Stability(Stable)
public CfnFeaturedResultsSetMixinProps.Builder description(String description)

Sets the value of CfnFeaturedResultsSetMixinProps.getDescription()

Parameters:

description - A description for the set of featured results.

Returns:

this

featuredDocuments

@Stability(Stable)
public CfnFeaturedResultsSetMixinProps.Builder featuredDocuments(IResolvable featuredDocuments)

Sets the value of CfnFeaturedResultsSetMixinProps.getFeaturedDocuments()

Parameters:

featuredDocuments - A list of document IDs for the documents you want to feature at the top of the search results page.

Returns:

this

featuredDocuments

@Stability(Stable)
public CfnFeaturedResultsSetMixinProps.Builder featuredDocuments(List<? extends Object> featuredDocuments)

Sets the value of CfnFeaturedResultsSetMixinProps.getFeaturedDocuments()

Parameters:

featuredDocuments - A list of document IDs for the documents you want to feature at the top of the search results page.

Returns:

this

featuredResultsSetName

@Stability(Stable)
public CfnFeaturedResultsSetMixinProps.Builder featuredResultsSetName(String featuredResultsSetName)

Sets the value of CfnFeaturedResultsSetMixinProps.getFeaturedResultsSetName()

Parameters:

featuredResultsSetName - A name for the set of featured results.

Returns:

this

indexId

@Stability(Stable)
public CfnFeaturedResultsSetMixinProps.Builder indexId(String indexId)

Sets the value of CfnFeaturedResultsSetMixinProps.getIndexId()

Parameters:

indexId - The identifier of the index that you want to use for featuring results.

Returns:

this

queryTexts

@Stability(Stable)
public CfnFeaturedResultsSetMixinProps.Builder queryTexts(List<String> queryTexts)

Sets the value of CfnFeaturedResultsSetMixinProps.getQueryTexts()

Parameters:

queryTexts - A list of queries for featuring results.

Returns:

this

status

@Stability(Stable)
public CfnFeaturedResultsSetMixinProps.Builder status(String status)

Sets the value of CfnFeaturedResultsSetMixinProps.getStatus()

Parameters:

status - The current status of the set of featured results. When the value is ACTIVE, featured results are ready for use.

Returns:

this

tags

@Stability(Stable)
public CfnFeaturedResultsSetMixinProps.Builder tags(List<? extends CfnTag> tags)

Sets the value of CfnFeaturedResultsSetMixinProps.getTags()

Parameters:

tags - A list of key-value pairs that identify or categorize the featured results set.

Returns:

this

build

@Stability(Stable)
public CfnFeaturedResultsSetMixinProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnFeaturedResultsSetMixinProps>

Returns:

a new instance of CfnFeaturedResultsSetMixinProps

Throws:

NullPointerException - if any required attribute was not provided