Interface DocumentRelevanceConfiguration.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<DocumentRelevanceConfiguration.Builder,
,DocumentRelevanceConfiguration> SdkBuilder<DocumentRelevanceConfiguration.Builder,
,DocumentRelevanceConfiguration> SdkPojo
- Enclosing class:
DocumentRelevanceConfiguration
public static interface DocumentRelevanceConfiguration.Builder
extends SdkPojo, CopyableBuilder<DocumentRelevanceConfiguration.Builder,DocumentRelevanceConfiguration>
-
Method Summary
Modifier and TypeMethodDescriptionThe name of the index field.relevance
(Consumer<Relevance.Builder> relevance) Provides information for tuning the relevance of a field in a search.Provides information for tuning the relevance of a field in a search.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
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
-
name
The name of the index field.
- Parameters:
name
- The name of the index field.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
relevance
Provides information for tuning the relevance of a field in a search. When a query includes terms that match the field, the results are given a boost in the response based on these tuning parameters.
- Parameters:
relevance
- Provides information for tuning the relevance of a field in a search. When a query includes terms that match the field, the results are given a boost in the response based on these tuning parameters.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
relevance
Provides information for tuning the relevance of a field in a search. When a query includes terms that match the field, the results are given a boost in the response based on these tuning parameters.
This is a convenience method that creates an instance of theRelevance.Builder
avoiding the need to create one manually viaRelevance.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed torelevance(Relevance)
.- Parameters:
relevance
- a consumer that will call methods onRelevance.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-