Interface OpensearchConfiguration.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<OpensearchConfiguration.Builder,
,OpensearchConfiguration> SdkBuilder<OpensearchConfiguration.Builder,
,OpensearchConfiguration> SdkPojo
- Enclosing class:
OpensearchConfiguration
-
Method Summary
Modifier and TypeMethodDescriptiondomainEndpoint
(String domainEndpoint) The endpoint of the Amazon OpenSearch Service domain.exactResponse
(Boolean exactResponse) Specifies whether to return an exact response or to return an answer generated by the model using the fields you specify from the database.default OpensearchConfiguration.Builder
exactResponseFields
(Consumer<ExactResponseFields.Builder> exactResponseFields) Contains the names of the fields used for an exact response to the user.exactResponseFields
(ExactResponseFields exactResponseFields) Contains the names of the fields used for an exact response to the user.includeFields
(String... includeFields) Contains a list of fields from the Amazon OpenSearch Service that the model can use to generate the answer to the query.includeFields
(Collection<String> includeFields) Contains a list of fields from the Amazon OpenSearch Service that the model can use to generate the answer to the query.The name of the Amazon OpenSearch Service index.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
-
domainEndpoint
The endpoint of the Amazon OpenSearch Service domain.
- Parameters:
domainEndpoint
- The endpoint of the Amazon OpenSearch Service domain.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
indexName
The name of the Amazon OpenSearch Service index.
- Parameters:
indexName
- The name of the Amazon OpenSearch Service index.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
exactResponse
Specifies whether to return an exact response or to return an answer generated by the model using the fields you specify from the database.
- Parameters:
exactResponse
- Specifies whether to return an exact response or to return an answer generated by the model using the fields you specify from the database.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
exactResponseFields
Contains the names of the fields used for an exact response to the user.
- Parameters:
exactResponseFields
- Contains the names of the fields used for an exact response to the user.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
exactResponseFields
default OpensearchConfiguration.Builder exactResponseFields(Consumer<ExactResponseFields.Builder> exactResponseFields) Contains the names of the fields used for an exact response to the user.
This is a convenience method that creates an instance of theExactResponseFields.Builder
avoiding the need to create one manually viaExactResponseFields.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toexactResponseFields(ExactResponseFields)
.- Parameters:
exactResponseFields
- a consumer that will call methods onExactResponseFields.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
includeFields
Contains a list of fields from the Amazon OpenSearch Service that the model can use to generate the answer to the query.
- Parameters:
includeFields
- Contains a list of fields from the Amazon OpenSearch Service that the model can use to generate the answer to the query.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
includeFields
Contains a list of fields from the Amazon OpenSearch Service that the model can use to generate the answer to the query.
- Parameters:
includeFields
- Contains a list of fields from the Amazon OpenSearch Service that the model can use to generate the answer to the query.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-