Add support for wrapper queries (#630)

* add wrapperquery

Signed-off-by: Andrew Parmet <[email protected]>

* add changelog entry

Signed-off-by: Andrew Parmet <[email protected]>

* add test

Signed-off-by: Andrew Parmet <[email protected]>

---------

Signed-off-by: Andrew Parmet <[email protected]>

CHANGELOG.md

@@ -6,6 +6,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 ### Added
 - Document HTTP/2 support ([#330](https://github.com/opensearch-project/opensearch-java/pull/330))
 - Added support for "cjk" analyzer ([#604](https://github.com/opensearch-project/opensearch-java/pull/604))
+- Added support for wrapper queries ([#630](https://github.com/opensearch-project/opensearch-java/pull/630))
 
 ### Dependencies
 - Bumps `org.ajoberstar.grgit:grgit-gradle` from 5.0.0 to 5.2.0
@@ -191,4 +192,4 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 [2.5.0]: https://github.com/opensearch-project/opensearch-java/compare/v2.4.0...v2.5.0
 [2.4.0]: https://github.com/opensearch-project/opensearch-java/compare/v2.3.0...v2.4.0
 [2.3.0]: https://github.com/opensearch-project/opensearch-java/compare/v2.2.0...v2.3.0
-[2.2.0]: https://github.com/opensearch-project/opensearch-java/compare/v2.1.0...v2.2.0
+[2.2.0]: https://github.com/opensearch-project/opensearch-java/compare/v2.1.0...v2.2.0

java-client/src/main/java/org/opensearch/client/opensearch/_types/query_dsl/Query.java

@@ -169,6 +169,8 @@ public enum Kind implements JsonEnum {
 
 		Wildcard("wildcard"),
 
+		Wrapper("wrapper"),
+
 		Type("type"),
 
 		;

java-client/src/main/java/org/opensearch/client/opensearch/_types/query_dsl/QueryBuilders.java

@@ -446,6 +446,14 @@ public static WildcardQuery.Builder wildcard() {
 		return new WildcardQuery.Builder();
 	}
 
+	/**
+	 * Creates a builder for the {@link WrapperQuery wrapper} {@code Query}
+	 * variant.
+	 */
+	public static WrapperQuery.Builder wrapper() {
+		return new WrapperQuery.Builder();
+	}
+
 	/**
 	 * Creates a builder for the {@link TypeQuery type} {@code Query} variant.
 	 */

java-client/src/main/java/org/opensearch/client/opensearch/_types/query_dsl/WrapperQuery.java

@@ -0,0 +1,144 @@
+/*
+ * 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.
+ */
+
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+/*
+ * Modifications Copyright OpenSearch Contributors. See
+ * GitHub history for details.
+ */
+
+package org.opensearch.client.opensearch._types.query_dsl;
+
+import org.opensearch.client.json.JsonpDeserializable;
+import org.opensearch.client.json.JsonpDeserializer;
+import org.opensearch.client.json.JsonpMapper;
+import org.opensearch.client.json.ObjectBuilderDeserializer;
+import org.opensearch.client.json.ObjectDeserializer;
+import org.opensearch.client.util.ApiTypeHelper;
+import org.opensearch.client.util.ObjectBuilder;
+import jakarta.json.stream.JsonGenerator;
+import java.lang.String;
+import java.util.function.Function;
+
+// typedef: _types.query_dsl.WrapperQuery
+
+
+@JsonpDeserializable
+public class WrapperQuery extends QueryBase implements QueryVariant {
+    private final String query;
+
+    // ---------------------------------------------------------------------------------------------
+
+    private WrapperQuery(Builder builder) {
+        super(builder);
+
+        this.query = ApiTypeHelper.requireNonNull(builder.query, this, "query");
+
+    }
+
+    public static WrapperQuery of(Function<Builder, ObjectBuilder<WrapperQuery>> fn) {
+        return fn.apply(new Builder()).build();
+    }
+
+    /**
+     * Query variant kind.
+     */
+    @Override
+    public Query.Kind _queryKind() {
+        return Query.Kind.Wrapper;
+    }
+
+    /**
+     * Required - A base64 encoded query. The binary data format can be any of JSON,
+     * YAML, CBOR or SMILE encodings
+     * <p>
+     * API name: {@code query}
+     */
+    public final String query() {
+        return this.query;
+    }
+
+    protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
+
+        super.serializeInternal(generator, mapper);
+        generator.writeKey("query");
+        generator.write(this.query);
+
+    }
+
+    // ---------------------------------------------------------------------------------------------
+
+    /**
+     * Builder for {@link WrapperQuery}.
+     */
+
+    public static class Builder extends QueryBase.AbstractBuilder<Builder> implements ObjectBuilder<WrapperQuery> {
+        private String query;
+
+        /**
+         * Required - A base64 encoded query. The binary data format can be any of JSON,
+         * YAML, CBOR or SMILE encodings
+         * <p>
+         * API name: {@code query}
+         */
+        public final Builder query(String value) {
+            this.query = value;
+            return this;
+        }
+
+        @Override
+        protected Builder self() {
+            return this;
+        }
+
+        /**
+         * Builds a {@link WrapperQuery}.
+         *
+         * @throws NullPointerException
+         *             if some of the required fields are null.
+         */
+        public WrapperQuery build() {
+            _checkSingleUse();
+
+            return new WrapperQuery(this);
+        }
+    }
+
+    // ---------------------------------------------------------------------------------------------
+
+    /**
+     * Json deserializer for {@link WrapperQuery}
+     */
+    public static final JsonpDeserializer<WrapperQuery> _DESERIALIZER = ObjectBuilderDeserializer.lazy(Builder::new,
+            WrapperQuery::setupWrapperQueryDeserializer);
+
+    protected static void setupWrapperQueryDeserializer(ObjectDeserializer<WrapperQuery.Builder> op) {
+        QueryBase.setupQueryBaseDeserializer(op);
+        op.add(Builder::query, JsonpDeserializer.stringDeserializer(), "query");
+
+    }
+
+}

java-client/src/test/java/org/opensearch/client/opensearch/model/BehaviorsTest.java

@@ -43,6 +43,7 @@
 import org.opensearch.client.opensearch._types.query_dsl.ShapeQuery;
 import org.opensearch.client.opensearch._types.query_dsl.TermQuery;
 import org.opensearch.client.json.JsonData;
+import org.opensearch.client.opensearch._types.query_dsl.WrapperQuery;
 import org.opensearch.client.util.MapBuilder;
 import org.junit.Test;
 
@@ -84,6 +85,19 @@ public void testAdditionalPropertyOnClass() {
         System.out.println(toJson(q));
     }
 
+    @Test
+    public void testWrapperQuery() {
+        WrapperQuery q = new WrapperQuery.Builder()
+            .query("encoded_query")
+            .build();
+
+        q = checkJsonRoundtrip(q,
+            "{\"query\":\"encoded_query\"}"
+        );
+
+        assertEquals("encoded_query", q.query());
+    }
+
     @Test
     public void testAdditionalPropertyOnContainer() {
         // Regular variant