How to invoke plugin using opensearch-java client library?

rajesh · June 28, 2023, 5:33am

Versions (relevant - OpenSearch/Dashboard/Server OS/Browser): OpenSearch 2.8.0
Describe the issue: We have custom opensearch plugin. We have been using rest high level client. Since rest high level client will be deprecated from OpenSearch 3.0.0 onwards, we want to migrate to opensearch-java client library. How do we invoke customer plugin from opensearch-client APIs. In order to use opensearch-java client library, I had to make changes in org.opensearch.client.opensearch._types.aggregations.Aggregate, org.opensearch.client.opensearch._types.aggregations and some other files. Please share if there any way I can use our plugin without making changes to client library.

Configuration:

Relevant Logs or Screenshots:

wbeckler · July 2, 2023, 3:50am

Would this address your use case? Maybe you can comment on the issue to broaden the scope or reinforce the use case?

github.com/opensearch-project/opensearch-java

[FEATURE] Support for composing query variants from 3rd party plugins

opened 10:41PM - 24 Jun 23 UTC

jhinch

enhancement

### Is your feature request related to a problem? Some plugins such as the [O…penSearch LTR plugin](https://github.com/opensearch-project/opensearch-learning-to-rank-base) add additional query variants https://elasticsearch-learning-to-rank.readthedocs.io/en/latest/searching-with-your-model.html#searching-with-ltr. opensearch-java current cannot support construction of a query containing such a query variant as [QueryVariant](https://github.com/opensearch-project/opensearch-java/blob/main/java-client/src/main/java/org/opensearch/client/opensearch/_types/query_dsl/QueryVariant.java#L44) interface requiring a kind being specified and [Query.Kind](https://github.com/opensearch-project/opensearch-java/blob/main/java-client/src/main/java/org/opensearch/client/opensearch/_types/query_dsl/Query.java#L69) being a enum, not allowing for variants to be specified in a 3rd party client. ### What solution would you like? There would be a couple possible solutions to this problem. Converting the enum to a type which allows for open extension might be one. Add a `custom` variant to the enum which itself allows for a flexible query construction might be another. ### What alternatives have you considered? See above ### Do you have any additional context? N/A

rajesh · July 3, 2023, 8:08am

Yes. This feature will address our usecase. Thanks for sharing github issue link.

system · September 1, 2023, 8:08am

This topic was automatically closed 60 days after the last reply. New replies are no longer allowed.

Topic		Replies	Views
Migrating custom search plugin from hlrc to java client OpenSearch Client Libraries opensearch-java	1	19	September 29, 2024
RestHighLevelClient - How to use custom plugins? OpenSearch	5	498	March 6, 2023
OpenSearch Plugins or high-level REST client? OpenDistro discuss	3	794	February 15, 2022
How to setup/use Java OpenSearch client OpenSearch Client Libraries opensearch-java	1	1344	February 9, 2022
Java Client not working for OpenSearch document insert OpenSearch troubleshoot	1	382	June 18, 2024

How to invoke plugin using opensearch-java client library?

Related topics