Add docValueFields to TopHitsAggregation

Philippus · Oct 11, 2024 · 820de83 · 820de83
1 parent 2363f4f
commit 820de83
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 3 deletions.
diff --git a/...ore/src/main/scala/com/sksamuel/elastic4s/requests/searches/aggs/TopHitsAggregation.scala b/...ore/src/main/scala/com/sksamuel/elastic4s/requests/searches/aggs/TopHitsAggregation.scala
@@ -16,6 +16,7 @@ case class TopHitsAggregation(name: String,
                               version: Option[Boolean] = None,
                               scripts: Map[String, Script] = Map.empty,
                               storedFields: Seq[String] = Nil,
+                              docValueFields: Seq[String] = Nil,
                               subaggs: Seq[AbstractAggregation] = Nil,
                               metadata: Map[String, AnyRef] = Map.empty,
                               highlight: Option[Highlight] = None)
@@ -42,6 +43,9 @@ case class TopHitsAggregation(name: String,
   def storedFields(first: String, rest: String*): TopHitsAggregation = storedFields(first +: rest)
   def storedFields(fields: Iterable[String]): TopHitsAggregation     = copy(storedFields = fields.toSeq)
 
+  def docValueFields(docValueFields: Iterable[String]): TopHitsAggregation =
+    copy(docValueFields = docValueFields.toSeq)
+
   def version(version: Boolean): TopHitsAggregation         = copy(version = version.some)
   def trackScores(trackScores: Boolean): TopHitsAggregation = copy(trackScores = trackScores.some)
 

diff --git a/...la/com/sksamuel/elastic4s/requests/searches/aggs/builders/TopHitsAggregationBuilder.scala b/...la/com/sksamuel/elastic4s/requests/searches/aggs/builders/TopHitsAggregationBuilder.scala
@@ -27,8 +27,8 @@ object TopHitsAggregationBuilder {
 
     agg.explain.foreach(builder.field("explain", _))
 
-    if (agg.storedFields.nonEmpty)
-      builder.array("docvalue_fields", agg.storedFields.toArray)
+    if (agg.docValueFields.nonEmpty)
+      builder.array("docvalue_fields", agg.docValueFields.toArray)
 
     agg.highlight.foreach { highlight =>
       builder.rawField("highlight", HighlightBuilderFn(highlight))

diff --git a/...c/test/scala/com/sksamuel/elastic4s/requests/searches/TopHitsAggregationBuilderTest.scala b/...c/test/scala/com/sksamuel/elastic4s/requests/searches/TopHitsAggregationBuilderTest.scala
@@ -13,7 +13,7 @@ class TopHitsAggregationBuilderTest extends AnyFunSuite with Matchers {
       .from(10)
       .version(true)
       .explain(false)
-      .storedFields(List("name"))
+      .docValueFields(List("name"))
       .sortBy(List(FieldSort("price").sortMode(SortMode.Median)))
     TopHitsAggregationBuilder(q).string shouldBe
       """{"top_hits":{"size":5,"from":10,"sort":[{"price":{"mode":"median","order":"asc"}}],"explain":false,"docvalue_fields":["name"],"version":true}}"""