Interface CreateFeaturedResultsSetRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateFeaturedResultsSetRequest.Builder,
,CreateFeaturedResultsSetRequest> KendraRequest.Builder
,SdkBuilder<CreateFeaturedResultsSetRequest.Builder,
,CreateFeaturedResultsSetRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateFeaturedResultsSetRequest
-
Method Summary
Modifier and TypeMethodDescriptionclientToken
(String clientToken) A token that you provide to identify the request to create a set of featured results.description
(String description) A description for the set of featured results.featuredDocuments
(Collection<FeaturedDocument> featuredDocuments) A list of document IDs for the documents you want to feature at the top of the search results page.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.featuredDocuments
(FeaturedDocument... featuredDocuments) A list of document IDs for the documents you want to feature at the top of the search results page.featuredResultsSetName
(String featuredResultsSetName) A name for the set of featured results.The identifier of the index that you want to use for featuring results.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.queryTexts
(String... queryTexts) A list of queries for featuring results.queryTexts
(Collection<String> queryTexts) A list of queries for featuring results.The current status of the set of featured results.status
(FeaturedResultsSetStatus status) The current status of the set of featured results.tags
(Collection<Tag> tags) A list of key-value pairs that identify or categorize the featured results set.tags
(Consumer<Tag.Builder>... tags) A list of key-value pairs that identify or categorize the featured results set.A list of key-value pairs that identify or categorize the featured results set.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.kendra.model.KendraRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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
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
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
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 theCreateFeaturedResultsSet
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
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 toACTIVE
. You can set the status toACTIVE
orINACTIVE
using the UpdateFeaturedResultsSet API. The queries you specify for featured results must be unique per featured results set for each index, whether the status isACTIVE
orINACTIVE
.- Parameters:
status
- The current status of the set of featured results. When the value isACTIVE
, featured results are ready for use. You can still configure your settings before setting the status toACTIVE
. You can set the status toACTIVE
orINACTIVE
using the UpdateFeaturedResultsSet API. The queries you specify for featured results must be unique per featured results set for each index, whether the status isACTIVE
orINACTIVE
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 toACTIVE
. You can set the status toACTIVE
orINACTIVE
using the UpdateFeaturedResultsSet API. The queries you specify for featured results must be unique per featured results set for each index, whether the status isACTIVE
orINACTIVE
.- Parameters:
status
- The current status of the set of featured results. When the value isACTIVE
, featured results are ready for use. You can still configure your settings before setting the status toACTIVE
. You can set the status toACTIVE
orINACTIVE
using the UpdateFeaturedResultsSet API. The queries you specify for featured results must be unique per featured results set for each index, whether the status isACTIVE
orINACTIVE
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
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 theFeaturedDocument.Builder
avoiding the need to create one manually viaFeaturedDocument.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tofeaturedDocuments(List<FeaturedDocument>)
.- Parameters:
featuredDocuments
- a consumer that will call methods onFeaturedDocument.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
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 theTag.Builder
avoiding the need to create one manually viaTag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totags(List<Tag>)
.- Parameters:
tags
- a consumer that will call methods onTag.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
CreateFeaturedResultsSetRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
CreateFeaturedResultsSetRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-