Package software.amazon.awscdk.services.kendra

Class CfnFeaturedResultsSetProps.Builder

java.lang.Object

software.amazon.awscdk.services.kendra.CfnFeaturedResultsSetProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnFeaturedResultsSetProps>

Enclosing interface:

CfnFeaturedResultsSetProps

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

A builder for CfnFeaturedResultsSetProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

featuredResultsSetName

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

Sets the value of CfnFeaturedResultsSetProps.getFeaturedResultsSetName()

Parameters:

featuredResultsSetName - A name for the set of featured results. This parameter is required.

Returns:

this

indexId

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

Sets the value of CfnFeaturedResultsSetProps.getIndexId()

Parameters:

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

Returns:

this

description

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

Sets the value of CfnFeaturedResultsSetProps.getDescription()

Parameters:

description - A description for the set of featured results.

Returns:

this

featuredDocuments

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

Sets the value of CfnFeaturedResultsSetProps.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 CfnFeaturedResultsSetProps.Builder featuredDocuments(List<? extends Object> featuredDocuments)

Sets the value of CfnFeaturedResultsSetProps.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

queryTexts

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

Sets the value of CfnFeaturedResultsSetProps.getQueryTexts()

Parameters:

queryTexts - A list of queries for featuring results.

Returns:

this

status

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

Sets the value of CfnFeaturedResultsSetProps.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 CfnFeaturedResultsSetProps.Builder tags(List<? extends CfnTag> tags)

Sets the value of CfnFeaturedResultsSetProps.getTags()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public CfnFeaturedResultsSetProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnFeaturedResultsSetProps

Throws:

NullPointerException - if any required attribute was not provided