Interface OpensearchConfiguration.Builder

All Superinterfaces:
Buildable, CopyableBuilder<OpensearchConfiguration.Builder,OpensearchConfiguration>, SdkBuilder<OpensearchConfiguration.Builder,OpensearchConfiguration>, SdkPojo
Enclosing class:
OpensearchConfiguration

public static interface OpensearchConfiguration.Builder extends SdkPojo, CopyableBuilder<OpensearchConfiguration.Builder,OpensearchConfiguration>
  • Method Details

    • domainEndpoint

      OpensearchConfiguration.Builder domainEndpoint(String 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

      OpensearchConfiguration.Builder 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.

      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

      OpensearchConfiguration.Builder exactResponseFields(ExactResponseFields 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 the ExactResponseFields.Builder avoiding the need to create one manually via ExactResponseFields.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to exactResponseFields(ExactResponseFields).

      Parameters:
      exactResponseFields - a consumer that will call methods on ExactResponseFields.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • includeFields

      OpensearchConfiguration.Builder 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.

      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

      OpensearchConfiguration.Builder 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.

      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.