[Backport] [2.x] add toBuilder method on some models (#766) (#797)

* add toBuilder method on some models (#766)

* add toQuery() on SearchRequest

Signed-off-by: channel-dante <[email protected]>

* add toBuilder() on all Request in org.opensearch.client.opensearch.core

Signed-off-by: channel-dante <[email protected]>

* add toBuilder() on all Builder in org.opensearch.client.opensearch._types.query_dsl

Signed-off-by: channel-dante <[email protected]>

* update CHANGELOG.md

Signed-off-by: channel-dante <[email protected]>

* apply spotlessApply

Signed-off-by: channel-dante <[email protected]>

* fix CommonTermsQuery.toBuilder()

Signed-off-by: channel-dante <[email protected]>

* fix FuzzyQuery.toBuilder()

Signed-off-by: channel-dante <[email protected]>

* fix toBuilders

Signed-off-by: channel-dante <[email protected]>

* add test for _types/query_dsl package

Signed-off-by: channel-dante <[email protected]>

* add test for core package

Signed-off-by: channel-dante <[email protected]>

* spotlessApply

Signed-off-by: channel-dante <[email protected]>

* fix test

Signed-off-by: channel-dante <[email protected]>

* revert ModelTestCase

Signed-off-by: channel-dante <[email protected]>

* revert ModelTestCase

Signed-off-by: channel-dante <[email protected]>

* add pr link on CHANGELOG.md

Signed-off-by: channel-dante <[email protected]>

* add pr link on CHANGELOG.md

Signed-off-by: channel-dante <[email protected]>

* apply spotless

Signed-off-by: channel-dante <[email protected]>

---------

Signed-off-by: channel-dante <[email protected]>

(cherry picked from commit a8fea24)
Signed-off-by: channel-dante <[email protected]>

* removed not related test code

Signed-off-by: channel-dante <[email protected]>

---------

Signed-off-by: channel-dante <[email protected]>

CHANGELOG.md

@@ -6,6 +6,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 - Added support for icu_collation_keyword type ([#725](https://github.com/opensearch-project/opensearch-java/pull/725))
 - Added support for flat_object field property ([#735](https://github.com/opensearch-project/opensearch-java/pull/735))
 - Expose HTTP status code through `ResponseException#status` ([#756](https://github.com/opensearch-project/opensearch-java/pull/756))
+- Added toBuilder method to all request model in core package & _types.query_dsl package ([#766](https://github.com/opensearch-project/opensearch-java/pull/766))
 
 ### Dependencies
 - Bumps `com.diffplug.spotless` from 6.22.0 to 6.23.3

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

@@ -171,6 +171,10 @@ protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
 
     }
 
+    public Builder toBuilder() {
+        return new Builder().filter(filter).minimumShouldMatch(minimumShouldMatch).must(must).mustNot(mustNot).should(should);
+    }
+
     // ---------------------------------------------------------------------------------------------
 
     /**

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

@@ -110,6 +110,10 @@ protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
 
     }
 
+    public Builder toBuilder() {
+        return new Builder().negativeBoost(negativeBoost).negative(negative).positive(positive);
+    }
+
     // ---------------------------------------------------------------------------------------------
 
     /**

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

@@ -173,6 +173,15 @@ protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
 
     }
 
+    public Builder toBuilder() {
+        return new Builder().fields(fields)
+            .query(query)
+            .autoGenerateSynonymsPhraseQuery(autoGenerateSynonymsPhraseQuery)
+            .operator(operator)
+            .mimimumShouldMatch(mimimumShouldMatch)
+            .zeroTermsQuery(zeroTermsQuery);
+    }
+
     // ---------------------------------------------------------------------------------------------
 
     /**

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

@@ -182,6 +182,16 @@ protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
 
     }
 
+    public Builder toBuilder() {
+        return new Builder().field(field)
+            .analyzer(analyzer)
+            .cutoffFrequency(cutoffFrequency)
+            .highFreqOperator(highFreqOperator)
+            .lowFreqOperator(lowFreqOperator)
+            .minimumShouldMatch(minimumShouldMatch)
+            .query(query);
+    }
+
     // ---------------------------------------------------------------------------------------------
 
     /**

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

@@ -84,6 +84,10 @@ protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
 
     }
 
+    public Builder toBuilder() {
+        return new Builder().filter(filter);
+    }
+
     // ---------------------------------------------------------------------------------------------
 
     /**

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

@@ -93,6 +93,10 @@ protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
 
     }
 
+    public Builder toBuilder() {
+        return new Builder().field(field).placement(placement);
+    }
+
     // ---------------------------------------------------------------------------------------------
 
     /**

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

@@ -142,6 +142,10 @@ protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
 
     }
 
+    public Builder toBuilder() {
+        return new Builder().decay(decay).offset(offset).scale(scale).origin(origin);
+    }
+
     // ---------------------------------------------------------------------------------------------
 
     /**

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

@@ -111,6 +111,10 @@ protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
 
     }
 
+    public Builder toBuilder() {
+        return new Builder().queries(queries).tieBreaker(tieBreaker);
+    }
+
     // ---------------------------------------------------------------------------------------------
 
     /**

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

@@ -111,6 +111,10 @@ protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
 
     }
 
+    public Builder toBuilder() {
+        return new Builder().origin(origin).pivot(pivot).field(field);
+    }
+
     // ---------------------------------------------------------------------------------------------
 
     /**

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

@@ -84,6 +84,10 @@ protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
 
     }
 
+    public Builder toBuilder() {
+        return new Builder().field(field);
+    }
+
     // ---------------------------------------------------------------------------------------------
 
     /**

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

@@ -131,6 +131,10 @@ protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
 
     }
 
+    public Builder toBuilder() {
+        return new Builder().field(field).format(format).includeUnmapped(includeUnmapped);
+    }
+
     // ---------------------------------------------------------------------------------------------
 
     /**

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

@@ -138,6 +138,10 @@ protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
 
     }
 
+    public Builder toBuilder() {
+        return new Builder().id(id).index(index).path(path).routing(routing);
+    }
+
     // ---------------------------------------------------------------------------------------------
 
     /**

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

@@ -136,6 +136,10 @@ protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
 
     }
 
+    public Builder toBuilder() {
+        return new Builder().field(field).factor(factor).missing(missing).modifier(modifier);
+    }
+
     // ---------------------------------------------------------------------------------------------
 
     /**

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

@@ -275,6 +275,10 @@ public void serialize(JsonGenerator generator, JsonpMapper mapper) {
 
     }
 
+    public Builder toBuilder() {
+        return new Builder()._kind(_kind)._value(_value).filter(filter).weight(weight);
+    }
+
     public static class Builder extends ObjectBuilderBase {
         private Kind _kind;
         private Object _value;
@@ -285,6 +289,16 @@ public static class Builder extends ObjectBuilderBase {
         @Nullable
         private Double weight;
 
+        protected final Builder _kind(Kind v) {
+            this._kind = v;
+            return this;
+        }
+
+        protected final Builder _value(Object v) {
+            this._value = v;
+            return this;
+        }
+
         /**
          * API name: {@code filter}
          */

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

@@ -177,6 +177,15 @@ protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
 
     }
 
+    public Builder toBuilder() {
+        return new Builder().boostMode(boostMode)
+            .functions(functions)
+            .maxBoost(maxBoost)
+            .minScore(minScore)
+            .query(query)
+            .scoreMode(scoreMode);
+    }
+
     // ---------------------------------------------------------------------------------------------
 
     /**

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

@@ -185,6 +185,17 @@ protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
 
     }
 
+    public Builder toBuilder() {
+        return new Builder().field(field)
+            .value(value)
+            .maxExpansions(maxExpansions)
+            .prefixLength(prefixLength)
+            .rewrite(rewrite)
+            .transpositions(transpositions)
+            .fuzziness(fuzziness)
+            .value(value);
+    }
+
     // ---------------------------------------------------------------------------------------------
 
     /**

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

@@ -148,6 +148,14 @@ protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
 
     }
 
+    public Builder toBuilder() {
+        return new Builder().field(field)
+            .boundingBox(boundingBox)
+            .type(type)
+            .validationMethod(validationMethod)
+            .ignoreUnmapped(ignoreUnmapped);
+    }
+
     // ---------------------------------------------------------------------------------------------
 
     /**

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

@@ -146,6 +146,10 @@ protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
 
     }
 
+    public Builder toBuilder() {
+        return new Builder().field(field).location(location);
+    }
+
     // ---------------------------------------------------------------------------------------------
 
     /**

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

@@ -95,6 +95,10 @@ protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
 
     }
 
+    public Builder toBuilder() {
+        return new Builder().points(points);
+    }
+
     // ---------------------------------------------------------------------------------------------
 
     /**

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

@@ -125,6 +125,10 @@ protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
 
     }
 
+    public Builder toBuilder() {
+        return new Builder().shape(shape).indexedShape(indexedShape).relation(relation);
+    }
+
     // ---------------------------------------------------------------------------------------------
 
     /**

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

@@ -112,6 +112,10 @@ protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
 
     }
 
+    public Builder toBuilder() {
+        return new Builder().field(field).shape(shape);
+    }
+
     // ---------------------------------------------------------------------------------------------
 
     /**

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

@@ -183,6 +183,16 @@ protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
 
     }
 
+    public Builder toBuilder() {
+        return new Builder().ignoreUnmapped(ignoreUnmapped)
+            .innerHits(innerHits)
+            .maxChildren(maxChildren)
+            .minChildren(minChildren)
+            .query(query)
+            .scoreMode(scoreMode)
+            .type(type);
+    }
+
     // ---------------------------------------------------------------------------------------------
 
     /**

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

@@ -151,6 +151,10 @@ protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
 
     }
 
+    public Builder toBuilder() {
+        return new Builder().ignoreUnmapped(ignoreUnmapped).innerHits(innerHits).parentType(parentType).query(query).score(score);
+    }
+
     // ---------------------------------------------------------------------------------------------
 
     /**

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

@@ -94,6 +94,10 @@ protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
 
     }
 
+    public Builder toBuilder() {
+        return new Builder().values(values);
+    }
+
     // ---------------------------------------------------------------------------------------------
 
     /**

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

@@ -242,10 +242,24 @@ public void serialize(JsonGenerator generator, JsonpMapper mapper) {
 
     }
 
+    public Builder toBuilder() {
+        return new Builder()._kind(_kind)._value(_value);
+    }
+
     public static class Builder extends ObjectBuilderBase implements ObjectBuilder<Intervals> {
         private Kind _kind;
         private Object _value;
 
+        protected final Builder _kind(Kind v) {
+            this._kind = v;
+            return this;
+        }
+
+        protected final Builder _value(Object v) {
+            this._value = v;
+            return this;
+        }
+
         public ObjectBuilder<Intervals> allOf(IntervalsAllOf v) {
             this._kind = Kind.AllOf;
             this._value = v;

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

@@ -162,6 +162,10 @@ protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
 
     }
 
+    public Builder toBuilder() {
+        return new Builder().intervals(intervals).maxGaps(maxGaps).ordered(ordered).filter(filter);
+    }
+
     // ---------------------------------------------------------------------------------------------
 
     /**

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

@@ -128,6 +128,10 @@ protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
 
     }
 
+    public Builder toBuilder() {
+        return new Builder().intervals(intervals);
+    }
+
     // ---------------------------------------------------------------------------------------------
 
     /**

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

@@ -294,10 +294,24 @@ public void serialize(JsonGenerator generator, JsonpMapper mapper) {
 
     }
 
+    public Builder toBuilder() {
+        return new Builder()._kind(_kind)._value(_value);
+    }
+
     public static class Builder extends ObjectBuilderBase implements ObjectBuilder<IntervalsFilter> {
         private Kind _kind;
         private Object _value;
 
+        protected final Builder _kind(Kind v) {
+            this._kind = v;
+            return this;
+        }
+
+        protected final Builder _value(Object v) {
+            this._value = v;
+            return this;
+        }
+
         public ObjectBuilder<IntervalsFilter> after(Intervals v) {
             this._kind = Kind.After;
             this._value = v;