software.amazon.awssdk.services.kendra.model

Interface CreateFeaturedResultsSetRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateFeaturedResultsSetRequest.Builder,CreateFeaturedResultsSetRequest>, KendraRequest.Builder, SdkBuilder<CreateFeaturedResultsSetRequest.Builder,CreateFeaturedResultsSetRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateFeaturedResultsSetRequest

public static interface CreateFeaturedResultsSetRequest.Builder
extends KendraRequest.Builder, SdkPojo, CopyableBuilder<CreateFeaturedResultsSetRequest.Builder,CreateFeaturedResultsSetRequest>

Method Summary

Modifier and Type	Method and Description
CreateFeaturedResultsSetRequest.Builder	clientToken(String clientToken) A token that you provide to identify the request to create a set of featured results.
CreateFeaturedResultsSetRequest.Builder	description(String description) A description for the set of featured results.
CreateFeaturedResultsSetRequest.Builder	featuredDocuments(Collection<FeaturedDocument> featuredDocuments) A list of document IDs for the documents you want to feature at the top of the search results page.
CreateFeaturedResultsSetRequest.Builder	featuredDocuments(Consumer<FeaturedDocument.Builder>... featuredDocuments) A list of document IDs for the documents you want to feature at the top of the search results page.
CreateFeaturedResultsSetRequest.Builder	featuredDocuments(FeaturedDocument... featuredDocuments) A list of document IDs for the documents you want to feature at the top of the search results page.
CreateFeaturedResultsSetRequest.Builder	featuredResultsSetName(String featuredResultsSetName) A name for the set of featured results.
CreateFeaturedResultsSetRequest.Builder	indexId(String indexId) The identifier of the index that you want to use for featuring results.
CreateFeaturedResultsSetRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateFeaturedResultsSetRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreateFeaturedResultsSetRequest.Builder	queryTexts(Collection<String> queryTexts) A list of queries for featuring results.
CreateFeaturedResultsSetRequest.Builder	queryTexts(String... queryTexts) A list of queries for featuring results.
CreateFeaturedResultsSetRequest.Builder	status(FeaturedResultsSetStatus status) The current status of the set of featured results.
CreateFeaturedResultsSetRequest.Builder	status(String status) The current status of the set of featured results.
CreateFeaturedResultsSetRequest.Builder	tags(Collection<Tag> tags) A list of key-value pairs that identify or categorize the featured results set.
CreateFeaturedResultsSetRequest.Builder	tags(Consumer<Tag.Builder>... tags) A list of key-value pairs that identify or categorize the featured results set.
CreateFeaturedResultsSetRequest.Builder	tags(Tag... tags) A list of key-value pairs that identify or categorize the featured results set.

Methods inherited from interface software.amazon.awssdk.services.kendra.model.KendraRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

indexId

CreateFeaturedResultsSetRequest.Builder indexId(String indexId)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

featuredResultsSetName

CreateFeaturedResultsSetRequest.Builder featuredResultsSetName(String featuredResultsSetName)

A name for the set of featured results.

Parameters:

featuredResultsSetName - A name for the set of featured results.

Returns:

Returns a reference to this object so that method calls can be chained together.

description

CreateFeaturedResultsSetRequest.Builder description(String description)

A description for the set of featured results.

Parameters:

description - A description for the set of featured results.

Returns:

Returns a reference to this object so that method calls can be chained together.

clientToken

CreateFeaturedResultsSetRequest.Builder clientToken(String clientToken)

A token that you provide to identify the request to create a set of featured results. Multiple calls to the CreateFeaturedResultsSet API with the same client token will create only one featured results set.

Parameters:

clientToken - A token that you provide to identify the request to create a set of featured results. Multiple calls to the CreateFeaturedResultsSet API with the same client token will create only one featured results set.

Returns:

Returns a reference to this object so that method calls can be chained together.

status

CreateFeaturedResultsSetRequest.Builder status(String status)

The current status of the set of featured results. When the value is ACTIVE, featured results are ready for use. You can still configure your settings before setting the status to ACTIVE. You can set the status to ACTIVE or INACTIVE using the UpdateFeaturedResultsSet API. The queries you specify for featured results must be unique per featured results set for each index, whether the status is ACTIVE or INACTIVE.

Parameters:

status - The current status of the set of featured results. When the value is ACTIVE, featured results are ready for use. You can still configure your settings before setting the status to ACTIVE. You can set the status to ACTIVE or INACTIVE using the UpdateFeaturedResultsSet API. The queries you specify for featured results must be unique per featured results set for each index, whether the status is ACTIVE or INACTIVE.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

FeaturedResultsSetStatus, FeaturedResultsSetStatus

status

CreateFeaturedResultsSetRequest.Builder status(FeaturedResultsSetStatus status)

The current status of the set of featured results. When the value is ACTIVE, featured results are ready for use. You can still configure your settings before setting the status to ACTIVE. You can set the status to ACTIVE or INACTIVE using the UpdateFeaturedResultsSet API. The queries you specify for featured results must be unique per featured results set for each index, whether the status is ACTIVE or INACTIVE.

Parameters:

status - The current status of the set of featured results. When the value is ACTIVE, featured results are ready for use. You can still configure your settings before setting the status to ACTIVE. You can set the status to ACTIVE or INACTIVE using the UpdateFeaturedResultsSet API. The queries you specify for featured results must be unique per featured results set for each index, whether the status is ACTIVE or INACTIVE.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

FeaturedResultsSetStatus, FeaturedResultsSetStatus

queryTexts

CreateFeaturedResultsSetRequest.Builder queryTexts(Collection<String> queryTexts)

A list of queries for featuring results. For more information on the list of queries, see FeaturedResultsSet.

Parameters:

queryTexts - A list of queries for featuring results. For more information on the list of queries, see FeaturedResultsSet.

Returns:

Returns a reference to this object so that method calls can be chained together.

queryTexts

CreateFeaturedResultsSetRequest.Builder queryTexts(String... queryTexts)

A list of queries for featuring results. For more information on the list of queries, see FeaturedResultsSet.

Parameters:

queryTexts - A list of queries for featuring results. For more information on the list of queries, see FeaturedResultsSet.

Returns:

Returns a reference to this object so that method calls can be chained together.

featuredDocuments

CreateFeaturedResultsSetRequest.Builder featuredDocuments(Collection<FeaturedDocument> featuredDocuments)

A list of document IDs for the documents you want to feature at the top of the search results page. For more information on the list of documents, see FeaturedResultsSet.

Parameters:

featuredDocuments - A list of document IDs for the documents you want to feature at the top of the search results page. For more information on the list of documents, see FeaturedResultsSet.

Returns:

Returns a reference to this object so that method calls can be chained together.

featuredDocuments

CreateFeaturedResultsSetRequest.Builder featuredDocuments(FeaturedDocument... featuredDocuments)

A list of document IDs for the documents you want to feature at the top of the search results page. For more information on the list of documents, see FeaturedResultsSet.

Parameters:

featuredDocuments - A list of document IDs for the documents you want to feature at the top of the search results page. For more information on the list of documents, see FeaturedResultsSet.

Returns:

Returns a reference to this object so that method calls can be chained together.

featuredDocuments

CreateFeaturedResultsSetRequest.Builder featuredDocuments(Consumer<FeaturedDocument.Builder>... featuredDocuments)

A list of document IDs for the documents you want to feature at the top of the search results page. For more information on the list of documents, see FeaturedResultsSet.

This is a convenience method that creates an instance of the FeaturedDocument.Builder avoiding the need to create one manually via FeaturedDocument.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #featuredDocuments(List).

Parameters:

featuredDocuments - a consumer that will call methods on FeaturedDocument.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#featuredDocuments(java.util.Collection)

tags

CreateFeaturedResultsSetRequest.Builder tags(Collection<Tag> tags)

A list of key-value pairs that identify or categorize the featured results set. You can also use tags to help control access to the featured results set. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols:_ . : / = + - @.

Parameters:

tags - A list of key-value pairs that identify or categorize the featured results set. You can also use tags to help control access to the featured results set. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols:_ . : / = + - @.

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

CreateFeaturedResultsSetRequest.Builder tags(Tag... tags)

A list of key-value pairs that identify or categorize the featured results set. You can also use tags to help control access to the featured results set. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols:_ . : / = + - @.

Parameters:

tags - A list of key-value pairs that identify or categorize the featured results set. You can also use tags to help control access to the featured results set. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols:_ . : / = + - @.

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

CreateFeaturedResultsSetRequest.Builder tags(Consumer<Tag.Builder>... tags)

A list of key-value pairs that identify or categorize the featured results set. You can also use tags to help control access to the featured results set. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols:_ . : / = + - @.

This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

Parameters:

tags - a consumer that will call methods on Tag.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#tags(java.util.Collection)

overrideConfiguration

CreateFeaturedResultsSetRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

CreateFeaturedResultsSetRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder