[GRPC][Term-level queries] Add Exists, Regexp, and Wildcard queries (#19392)

* [GRPC] Implement Exists, Ids, Regexp, Wildcard queries

Signed-off-by: karenx <[email protected]>

* changelog

Signed-off-by: karenx <[email protected]>

* remove idsquery

Signed-off-by: Karen X <[email protected]>

* package private

Signed-off-by: Karen X <[email protected]>

* compile with 0.18.0 protos

Signed-off-by: Karen X <[email protected]>

* spotlessApply

Signed-off-by: Karen X <[email protected]>

* add tests

Signed-off-by: Karen X <[email protected]>

* spotless

Signed-off-by: Karen X <[email protected]>

---------

Signed-off-by: karenx <[email protected]>
Signed-off-by: Karen X <[email protected]>
Co-authored-by: karenx <[email protected]>

Author: karenyrx

modules/transport-grpc/src/main/java/org/opensearch/transport/grpc/proto/request/search/query/ExistsQueryBuilderProtoConverter.java

@@ -0,0 +1,41 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+package org.opensearch.transport.grpc.proto.request.search.query;
+
+import org.opensearch.index.query.QueryBuilder;
+import org.opensearch.protobufs.QueryContainer;
+import org.opensearch.transport.grpc.spi.QueryBuilderProtoConverter;
+
+/**
+ * Converter for Exists queries.
+ * This class implements the QueryBuilderProtoConverter interface to provide Exists query support
+ * for the gRPC transport module.
+ */
+public class ExistsQueryBuilderProtoConverter implements QueryBuilderProtoConverter {
+
+    /**
+     * Constructs a new ExistsQueryBuilderProtoConverter.
+     */
+    public ExistsQueryBuilderProtoConverter() {
+        // Default constructor
+    }
+
+    @Override
+    public QueryContainer.QueryContainerCase getHandledQueryCase() {
+        return QueryContainer.QueryContainerCase.EXISTS;
+    }
+
+    @Override
+    public QueryBuilder fromProto(QueryContainer queryContainer) {
+        if (queryContainer == null || !queryContainer.hasExists()) {
+            throw new IllegalArgumentException("QueryContainer does not contain an Exists query");
+        }
+
+        return ExistsQueryBuilderProtoUtils.fromProto(queryContainer.getExists());
+    }
+}

modules/transport-grpc/src/main/java/org/opensearch/transport/grpc/proto/request/search/query/ExistsQueryBuilderProtoUtils.java

@@ -0,0 +1,55 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+package org.opensearch.transport.grpc.proto.request.search.query;
+
+import org.opensearch.core.xcontent.XContentParser;
+import org.opensearch.index.query.ExistsQueryBuilder;
+import org.opensearch.protobufs.ExistsQuery;
+
+/**
+ * Utility class for converting ExistsQuery Protocol Buffers to OpenSearch objects.
+ * This class provides methods to transform Protocol Buffer representations of exists queries
+ * into their corresponding OpenSearch ExistsQueryBuilder implementations for search operations.
+ */
+class ExistsQueryBuilderProtoUtils {
+
+    private ExistsQueryBuilderProtoUtils() {
+        // Utility class, no instances
+    }
+
+    /**
+     * Converts a Protocol Buffer ExistsQuery to an OpenSearch ExistsQueryBuilder.
+     * Similar to {@link ExistsQueryBuilder#fromXContent(XContentParser)}, this method
+     * parses the Protocol Buffer representation and creates a properly configured
+     * ExistsQueryBuilder with the appropriate field name, boost, and query name.
+     *
+     * @param existsQueryProto The Protocol Buffer ExistsQuery object
+     * @return A configured ExistsQueryBuilder instance
+     * @throws IllegalArgumentException if the exists query is null or missing required fields
+     */
+    static ExistsQueryBuilder fromProto(ExistsQuery existsQueryProto) {
+        if (existsQueryProto == null) {
+            throw new IllegalArgumentException("ExistsQuery cannot be null");
+        }
+
+        String field = existsQueryProto.getField();
+
+        ExistsQueryBuilder existsQueryBuilder = new ExistsQueryBuilder(field);
+
+        // Set optional parameters
+        if (existsQueryProto.hasBoost()) {
+            existsQueryBuilder.boost(existsQueryProto.getBoost());
+        }
+
+        if (existsQueryProto.hasXName()) {
+            existsQueryBuilder.queryName(existsQueryProto.getXName());
+        }
+
+        return existsQueryBuilder;
+    }
+}

modules/transport-grpc/src/main/java/org/opensearch/transport/grpc/proto/request/search/query/MatchAllQueryBuilderProtoUtils.java

@@ -14,7 +14,7 @@
 /**
  * Utility class for converting MatchAllQuery Protocol Buffers to OpenSearch query objects.
  */
-public class MatchAllQueryBuilderProtoUtils {
+class MatchAllQueryBuilderProtoUtils {
 
     private MatchAllQueryBuilderProtoUtils() {
         // Utility class, no instances
@@ -29,7 +29,7 @@ private MatchAllQueryBuilderProtoUtils() {
      * @param matchAllQueryProto The Protocol Buffer MatchAllQuery to convert
      * @return A configured MatchAllQueryBuilder instance
      */
-    protected static MatchAllQueryBuilder fromProto(MatchAllQuery matchAllQueryProto) {
+    static MatchAllQueryBuilder fromProto(MatchAllQuery matchAllQueryProto) {
         MatchAllQueryBuilder matchAllQueryBuilder = new MatchAllQueryBuilder();
 
         if (matchAllQueryProto.hasBoost()) {

modules/transport-grpc/src/main/java/org/opensearch/transport/grpc/proto/request/search/query/MatchNoneQueryBuilderProtoUtils.java

@@ -16,7 +16,7 @@
  * This class provides methods to transform Protocol Buffer representations of match_none queries
  * into their corresponding OpenSearch MatchNoneQueryBuilder implementations for search operations.
  */
-public class MatchNoneQueryBuilderProtoUtils {
+class MatchNoneQueryBuilderProtoUtils {
 
     private MatchNoneQueryBuilderProtoUtils() {
         // Utility class, no instances
@@ -31,7 +31,7 @@ private MatchNoneQueryBuilderProtoUtils() {
      * @param matchNoneQueryProto The Protocol Buffer MatchNoneQuery to convert
      * @return A configured MatchNoneQueryBuilder instance
      */
-    protected static MatchNoneQueryBuilder fromProto(MatchNoneQuery matchNoneQueryProto) {
+    static MatchNoneQueryBuilder fromProto(MatchNoneQuery matchNoneQueryProto) {
         MatchNoneQueryBuilder matchNoneQueryBuilder = new MatchNoneQueryBuilder();
 
         if (matchNoneQueryProto.hasBoost()) {

modules/transport-grpc/src/main/java/org/opensearch/transport/grpc/proto/request/search/query/QueryBuilderProtoConverterRegistryImpl.java

@@ -52,6 +52,9 @@ protected void registerBuiltInConverters() {
         delegate.registerConverter(new MultiMatchQueryBuilderProtoConverter());
         delegate.registerConverter(new BoolQueryBuilderProtoConverter());
         delegate.registerConverter(new ScriptQueryBuilderProtoConverter());
+        delegate.registerConverter(new ExistsQueryBuilderProtoConverter());
+        delegate.registerConverter(new RegexpQueryBuilderProtoConverter());
+        delegate.registerConverter(new WildcardQueryBuilderProtoConverter());
 
         // Set the registry on all converters so they can access each other
         delegate.setRegistryOnAllConverters(this);

modules/transport-grpc/src/main/java/org/opensearch/transport/grpc/proto/request/search/query/RegexpQueryBuilderProtoConverter.java

@@ -0,0 +1,41 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+package org.opensearch.transport.grpc.proto.request.search.query;
+
+import org.opensearch.index.query.QueryBuilder;
+import org.opensearch.protobufs.QueryContainer;
+import org.opensearch.transport.grpc.spi.QueryBuilderProtoConverter;
+
+/**
+ * Converter for Regexp queries.
+ * This class implements the QueryBuilderProtoConverter interface to provide Regexp query support
+ * for the gRPC transport module.
+ */
+public class RegexpQueryBuilderProtoConverter implements QueryBuilderProtoConverter {
+
+    /**
+     * Constructs a new RegexpQueryBuilderProtoConverter.
+     */
+    public RegexpQueryBuilderProtoConverter() {
+        // Default constructor
+    }
+
+    @Override
+    public QueryContainer.QueryContainerCase getHandledQueryCase() {
+        return QueryContainer.QueryContainerCase.REGEXP;
+    }
+
+    @Override
+    public QueryBuilder fromProto(QueryContainer queryContainer) {
+        if (queryContainer == null || !queryContainer.hasRegexp()) {
+            throw new IllegalArgumentException("QueryContainer does not contain a Regexp query");
+        }
+
+        return RegexpQueryBuilderProtoUtils.fromProto(queryContainer.getRegexp());
+    }
+}

modules/transport-grpc/src/main/java/org/opensearch/transport/grpc/proto/request/search/query/RegexpQueryBuilderProtoUtils.java

@@ -0,0 +1,86 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+package org.opensearch.transport.grpc.proto.request.search.query;
+
+import org.opensearch.core.xcontent.XContentParser;
+import org.opensearch.index.query.AbstractQueryBuilder;
+import org.opensearch.index.query.RegexpQueryBuilder;
+import org.opensearch.protobufs.MultiTermQueryRewrite;
+import org.opensearch.protobufs.RegexpQuery;
+import org.opensearch.transport.grpc.util.ProtobufEnumUtils;
+
+/**
+ * Utility class for converting RegexpQuery Protocol Buffers to OpenSearch objects.
+ * This class provides methods to transform Protocol Buffer representations of regexp queries
+ * into their corresponding OpenSearch RegexpQueryBuilder implementations for search operations.
+ */
+class RegexpQueryBuilderProtoUtils {
+
+    private RegexpQueryBuilderProtoUtils() {
+        // Utility class, no instances
+    }
+
+    /**
+     * Converts a Protocol Buffer RegexpQuery to an OpenSearch RegexpQueryBuilder.
+     * Similar to {@link RegexpQueryBuilder#fromXContent(XContentParser)}, this method
+     * parses the Protocol Buffer representation and creates a properly configured
+     * RegexpQueryBuilder with the appropriate field name, value, boost, query name,
+     * flags, case sensitivity, max determinized states, and rewrite method.
+     *
+     * @param regexpQueryProto The Protocol Buffer RegexpQuery object
+     * @return A configured RegexpQueryBuilder instance
+     * @throws IllegalArgumentException if the regexp query is null or missing required fields
+     */
+    static RegexpQueryBuilder fromProto(RegexpQuery regexpQueryProto) {
+        String fieldName = regexpQueryProto.getField();
+        String rewrite = null;
+        String value = regexpQueryProto.getValue();
+        float boost = AbstractQueryBuilder.DEFAULT_BOOST;
+        int flagsValue = RegexpQueryBuilder.DEFAULT_FLAGS_VALUE;
+        boolean caseInsensitive = RegexpQueryBuilder.DEFAULT_CASE_INSENSITIVITY;
+        int maxDeterminizedStates = RegexpQueryBuilder.DEFAULT_DETERMINIZE_WORK_LIMIT;
+        String queryName = null;
+
+        if (regexpQueryProto.hasBoost()) {
+            boost = regexpQueryProto.getBoost();
+        }
+
+        if (regexpQueryProto.hasRewrite()) {
+            MultiTermQueryRewrite rewriteEnum = regexpQueryProto.getRewrite();
+            // Skip setting rewrite method if it's UNSPECIFIED
+            if (rewriteEnum != MultiTermQueryRewrite.MULTI_TERM_QUERY_REWRITE_UNSPECIFIED) {
+                rewrite = ProtobufEnumUtils.convertToString(rewriteEnum);
+            }
+        }
+
+        if (regexpQueryProto.hasFlags()) {
+            // Convert string flags to integer value using RegexpFlag.resolveValue
+            flagsValue = org.opensearch.index.query.RegexpFlag.resolveValue(regexpQueryProto.getFlags());
+        }
+
+        if (regexpQueryProto.hasMaxDeterminizedStates()) {
+            maxDeterminizedStates = regexpQueryProto.getMaxDeterminizedStates();
+        }
+
+        if (regexpQueryProto.hasCaseInsensitive()) {
+            caseInsensitive = regexpQueryProto.getCaseInsensitive();
+        }
+
+        if (regexpQueryProto.hasXName()) {
+            queryName = regexpQueryProto.getXName();
+        }
+
+        RegexpQueryBuilder result = new RegexpQueryBuilder(fieldName, value).flags(flagsValue)
+            .maxDeterminizedStates(maxDeterminizedStates)
+            .rewrite(rewrite)
+            .boost(boost)
+            .queryName(queryName);
+        result.caseInsensitive(caseInsensitive);
+        return result;
+    }
+}

modules/transport-grpc/src/main/java/org/opensearch/transport/grpc/proto/request/search/query/TermQueryBuilderProtoUtils.java

@@ -19,7 +19,7 @@
  * This class provides methods to transform Protocol Buffer representations of term queries
  * into their corresponding OpenSearch TermQueryBuilder implementations for search operations.
  */
-public class TermQueryBuilderProtoUtils {
+class TermQueryBuilderProtoUtils {
 
     private TermQueryBuilderProtoUtils() {
         // Utility class, no instances
@@ -36,7 +36,7 @@ private TermQueryBuilderProtoUtils() {
      * @return A configured TermQueryBuilder instance
      * @throws IllegalArgumentException if the field value type is not supported, or if the term query field value is not recognized
      */
-    protected static TermQueryBuilder fromProto(TermQuery termQueryProto) {
+    static TermQueryBuilder fromProto(TermQuery termQueryProto) {
         String queryName = null;
         String fieldName = termQueryProto.getField();
         Object value = null;

modules/transport-grpc/src/main/java/org/opensearch/transport/grpc/proto/request/search/query/TermsQueryBuilderProtoUtils.java

@@ -25,7 +25,7 @@
  * This class provides methods to transform Protocol Buffer representations of terms queries
  * into their corresponding OpenSearch TermsQueryBuilder implementations for search operations.
  */
-public class TermsQueryBuilderProtoUtils {
+class TermsQueryBuilderProtoUtils {
 
     private TermsQueryBuilderProtoUtils() {
         // Utility class, no instances
@@ -42,7 +42,7 @@ private TermsQueryBuilderProtoUtils() {
      * @return A configured TermQueryBuilder instance
      * @throws IllegalArgumentException if the terms query is invalid or missing required fields
      */
-    public static TermsQueryBuilder fromProto(org.opensearch.protobufs.TermsQuery termsQueryProto) {
+    static TermsQueryBuilder fromProto(org.opensearch.protobufs.TermsQuery termsQueryProto) {
         if (termsQueryProto == null) {
             throw new IllegalArgumentException("TermsQuery must not be null");
         }
@@ -83,7 +83,7 @@ public static TermsQueryBuilder fromProto(org.opensearch.protobufs.TermsQuery te
      * @return A configured TermQueryBuilder instance
      * @throws IllegalArgumentException if the term query field value is not recognized
      */
-    protected static TermsQueryBuilder fromProto(TermsQueryField termsQueryProto) {
+    static TermsQueryBuilder fromProto(TermsQueryField termsQueryProto) {
         String fieldName = null;
         List<Object> values = null;
         TermsLookup termsLookup = null;
@@ -124,7 +124,7 @@ protected static TermsQueryBuilder fromProto(TermsQueryField termsQueryProto) {
      * @return configured TermsQueryBuilder
      * @throws IllegalArgumentException if neither values nor lookup is set, or if bitmap validation fails
      */
-    protected static TermsQueryBuilder fromProto(
+    static TermsQueryBuilder fromProto(
         String fieldName,
         org.opensearch.protobufs.TermsQueryField termsQueryField,
         org.opensearch.protobufs.TermsQueryValueType valueTypeProto

modules/transport-grpc/src/main/java/org/opensearch/transport/grpc/proto/request/search/query/WildcardQueryBuilderProtoConverter.java

@@ -0,0 +1,41 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+package org.opensearch.transport.grpc.proto.request.search.query;
+
+import org.opensearch.index.query.QueryBuilder;
+import org.opensearch.protobufs.QueryContainer;
+import org.opensearch.transport.grpc.spi.QueryBuilderProtoConverter;
+
+/**
+ * Converter for Wildcard queries.
+ * This class implements the QueryBuilderProtoConverter interface to provide Wildcard query support
+ * for the gRPC transport module.
+ */
+public class WildcardQueryBuilderProtoConverter implements QueryBuilderProtoConverter {
+
+    /**
+     * Constructs a new WildcardQueryBuilderProtoConverter.
+     */
+    public WildcardQueryBuilderProtoConverter() {
+        // Default constructor
+    }
+
+    @Override
+    public QueryContainer.QueryContainerCase getHandledQueryCase() {
+        return QueryContainer.QueryContainerCase.WILDCARD;
+    }
+
+    @Override
+    public QueryBuilder fromProto(QueryContainer queryContainer) {
+        if (queryContainer == null || !queryContainer.hasWildcard()) {
+            throw new IllegalArgumentException("QueryContainer does not contain a Wildcard query");
+        }
+
+        return WildcardQueryBuilderProtoUtils.fromProto(queryContainer.getWildcard());
+    }
+}