Add support for Flat Objects

CHANGELOG.md

@@ -29,6 +29,7 @@ This section is for maintaining a changelog for all breaking changes for the cli
 
 ### Added
 - 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))
 
 ### Dependencies
 

java-client/src/main/java/org/opensearch/client/opensearch/_types/mapping/FieldType.java

@@ -107,7 +107,7 @@ public enum FieldType implements JsonEnum {
 
     RankFeatures("rank_features"),
 
-    Flattened("flattened"),
+    FlatObject("flat_object"),
 
     Shape("shape"),
 

java-client/src/main/java/org/opensearch/client/opensearch/_types/mapping/FlattenedProperty.java → java-client/src/main/java/org/opensearch/client/opensearch/_types/mapping/FlatObjectProperty.java

@@ -42,10 +42,10 @@
 import org.opensearch.client.json.ObjectDeserializer;
 import org.opensearch.client.util.ObjectBuilder;
 
-// typedef: _types.mapping.FlattenedProperty
+// typedef: _types.mapping.FlatObjectProperty
 
 @JsonpDeserializable
-public class FlattenedProperty extends PropertyBase implements PropertyVariant {
+public class FlatObjectProperty extends PropertyBase implements PropertyVariant {
     @Nullable
     private final Double boost;
 
@@ -75,7 +75,7 @@ public class FlattenedProperty extends PropertyBase implements PropertyVariant {
 
     // ---------------------------------------------------------------------------------------------
 
-    private FlattenedProperty(Builder builder) {
+    private FlatObjectProperty(Builder builder) {
         super(builder);
 
         this.boost = builder.boost;
@@ -90,7 +90,7 @@ private FlattenedProperty(Builder builder) {
 
     }
 
-    public static FlattenedProperty of(Function<Builder, ObjectBuilder<FlattenedProperty>> fn) {
+    public static FlatObjectProperty of(Function<Builder, ObjectBuilder<FlatObjectProperty>> fn) {
         return fn.apply(new Builder()).build();
     }
 
@@ -99,7 +99,7 @@ public static FlattenedProperty of(Function<Builder, ObjectBuilder<FlattenedProp
      */
     @Override
     public Property.Kind _propertyKind() {
-        return Property.Kind.Flattened;
+        return Property.Kind.FlatObject;
     }
 
     /**
@@ -176,7 +176,7 @@ public final Boolean splitQueriesOnWhitespace() {
 
     protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
 
-        generator.write("type", "flattened");
+        generator.write("type", "flat_object");
         super.serializeInternal(generator, mapper);
         if (this.boost != null) {
             generator.writeKey("boost");
@@ -228,10 +228,10 @@ protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
     // ---------------------------------------------------------------------------------------------
 
     /**
-     * Builder for {@link FlattenedProperty}.
+     * Builder for {@link FlatObjectProperty}.
      */
 
-    public static class Builder extends PropertyBase.AbstractBuilder<Builder> implements ObjectBuilder<FlattenedProperty> {
+    public static class Builder extends PropertyBase.AbstractBuilder<Builder> implements ObjectBuilder<FlatObjectProperty> {
         @Nullable
         private Double boost;
 
@@ -337,29 +337,29 @@ protected Builder self() {
         }
 
         /**
-         * Builds a {@link FlattenedProperty}.
+         * Builds a {@link FlatObjectProperty}.
          *
          * @throws NullPointerException
          *             if some of the required fields are null.
          */
-        public FlattenedProperty build() {
+        public FlatObjectProperty build() {
             _checkSingleUse();
 
-            return new FlattenedProperty(this);
+            return new FlatObjectProperty(this);
         }
     }
 
     // ---------------------------------------------------------------------------------------------
 
     /**
-     * Json deserializer for {@link FlattenedProperty}
+     * Json deserializer for {@link FlatObjectProperty}
      */
-    public static final JsonpDeserializer<FlattenedProperty> _DESERIALIZER = ObjectBuilderDeserializer.lazy(
+    public static final JsonpDeserializer<FlatObjectProperty> _DESERIALIZER = ObjectBuilderDeserializer.lazy(
         Builder::new,
-        FlattenedProperty::setupFlattenedPropertyDeserializer
+        FlatObjectProperty::setupFlatObjectPropertyDeserializer
     );
 
-    protected static void setupFlattenedPropertyDeserializer(ObjectDeserializer<FlattenedProperty.Builder> op) {
+    protected static void setupFlatObjectPropertyDeserializer(ObjectDeserializer<FlatObjectProperty.Builder> op) {
         PropertyBase.setupPropertyBaseDeserializer(op);
         op.add(Builder::boost, JsonpDeserializer.doubleDeserializer(), "boost");
         op.add(Builder::depthLimit, JsonpDeserializer.integerDeserializer(), "depth_limit");

java-client/src/main/java/org/opensearch/client/opensearch/_types/mapping/Property.java

@@ -84,7 +84,7 @@ public enum Kind implements JsonEnum {
 
         Alias("alias"),
 
-        Flattened("flattened"),
+        FlatObject("flat_object"),
 
         Float("float"),
 
@@ -402,20 +402,20 @@ public FieldAliasProperty alias() {
     }
 
     /**
-     * Is this variant instance of kind {@code flattened}?
+     * Is this variant instance of kind {@code flat_oject}?
      */
-    public boolean isFlattened() {
-        return _kind == Kind.Flattened;
+    public boolean isFlatObject() {
+        return _kind == Kind.FlatObject;
     }
 
     /**
-     * Get the {@code flattened} variant value.
+     * Get the {@code flat_object} variant value.
      *
      * @throws IllegalStateException
-     *             if the current variant is not of the {@code flattened} kind.
+     *             if the current variant is not of the {@code flat_object} kind.
      */
-    public FlattenedProperty flattened() {
-        return TaggedUnionUtils.get(this, Kind.Flattened);
+    public FlatObjectProperty flatObject() {
+        return TaggedUnionUtils.get(this, Kind.FlatObject);
     }
 
     /**
@@ -1098,14 +1098,14 @@ public ObjectBuilder<Property> alias(Function<FieldAliasProperty.Builder, Object
             return this.alias(fn.apply(new FieldAliasProperty.Builder()).build());
         }
 
-        public ObjectBuilder<Property> flattened(FlattenedProperty v) {
-            this._kind = Kind.Flattened;
+        public ObjectBuilder<Property> flatObject(FlatObjectProperty v) {
+            this._kind = Kind.FlatObject;
             this._value = v;
             return this;
         }
 
-        public ObjectBuilder<Property> flattened(Function<FlattenedProperty.Builder, ObjectBuilder<FlattenedProperty>> fn) {
-            return this.flattened(fn.apply(new FlattenedProperty.Builder()).build());
+        public ObjectBuilder<Property> flatObject(Function<FlatObjectProperty.Builder, ObjectBuilder<FlatObjectProperty>> fn) {
+            return this.flatObject(fn.apply(new FlatObjectProperty.Builder()).build());
         }
 
         public ObjectBuilder<Property> float_(FloatNumberProperty v) {
@@ -1457,7 +1457,7 @@ protected static void setupPropertyDeserializer(ObjectDeserializer<Builder> op)
         op.add(Builder::double_, DoubleNumberProperty._DESERIALIZER, "double");
         op.add(Builder::doubleRange, DoubleRangeProperty._DESERIALIZER, "double_range");
         op.add(Builder::alias, FieldAliasProperty._DESERIALIZER, "alias");
-        op.add(Builder::flattened, FlattenedProperty._DESERIALIZER, "flattened");
+        op.add(Builder::flatObject, FlatObjectProperty._DESERIALIZER, "flat_object");
         op.add(Builder::float_, FloatNumberProperty._DESERIALIZER, "float");
         op.add(Builder::floatRange, FloatRangeProperty._DESERIALIZER, "float_range");
         op.add(Builder::geoPoint, GeoPointProperty._DESERIALIZER, "geo_point");

java-client/src/main/java/org/opensearch/client/opensearch/_types/mapping/PropertyBuilders.java

@@ -134,11 +134,11 @@ public static FieldAliasProperty.Builder alias() {
     }
 
     /**
-     * Creates a builder for the {@link FlattenedProperty flattened}
+     * Creates a builder for the {@link FlatObjectProperty flatObject}
      * {@code Property} variant.
      */
-    public static FlattenedProperty.Builder flattened() {
-        return new FlattenedProperty.Builder();
+    public static FlatObjectProperty.Builder flatObject() {
+        return new FlatObjectProperty.Builder();
     }
 
     /**

java-client/src/test/java/org/opensearch/client/opensearch/integTest/AbstractIndicesClientIT.java

@@ -12,9 +12,15 @@
 import java.util.Map;
 import java.util.concurrent.CompletableFuture;
 import java.util.concurrent.TimeUnit;
+import org.junit.Test;
+import org.opensearch.Version;
 import org.opensearch.client.opensearch.OpenSearchAsyncClient;
 import org.opensearch.client.opensearch._types.OpenSearchException;
+import org.opensearch.client.opensearch._types.mapping.FlatObjectProperty;
+import org.opensearch.client.opensearch._types.mapping.Property;
+import org.opensearch.client.opensearch.core.InfoResponse;
 import org.opensearch.client.opensearch.indices.CreateDataStreamResponse;
+import org.opensearch.client.opensearch.indices.CreateIndexRequest;
 import org.opensearch.client.opensearch.indices.CreateIndexResponse;
 import org.opensearch.client.opensearch.indices.DataStream;
 import org.opensearch.client.opensearch.indices.DataStreamsStatsResponse;
@@ -192,4 +198,23 @@ public void testGetNotExistingIndexAlias() throws Exception {
             assertEquals(ex.getMessage(), "Request failed: [string_error] " + "alias [alias_not_exists] missing");
         }
     }
+
+    @Test
+    public void createIndex_withFlatObject_IndexCreatesSucessfully() throws IOException {
+        InfoResponse info = javaClient().info();
+        String version = info.version().number();
+        if (version.contains("SNAPSHOT")) {
+            version = version.split("-")[0];
+        }
+        assumeTrue("Flat Object is supported after version 2.7.0 only", Version.fromString(version).onOrAfter(Version.fromString("2.7.0")));
+        try {
+            final CreateIndexRequest createIndexRequest = new CreateIndexRequest.Builder().index("flat-object-test")
+                .mappings(m -> m.properties("sample_flat_object", Property.of(p -> p.flatObject(new FlatObjectProperty.Builder().build()))))
+                .build();
+            final CreateIndexResponse createIndexResponse = javaClient().indices().create(createIndexRequest);
+            assertTrue(createIndexResponse.acknowledged());
+        } catch (OpenSearchException ex) {
+            fail(ex.getMessage());
+        }
+    }
 }