Add support for retrieving request executionDuration.

Original Pull Request spring-projects#2991
Closes spring-projects#2986

Author: ELHARROUGUI

src/main/antora/modules/ROOT/pages/elasticsearch/template.adoc

@@ -81,7 +81,7 @@ When a document is retrieved with the methods of the  `DocumentOperations` inter
 When searching with the methods of the `SearchOperations` interface, additional information is available for each entity, for example the _score_ or the _sortValues_ of the found entity.
 
 In order to return this information, each entity is wrapped in a `SearchHit` object that contains this entity-specific additional information.
-These `SearchHit` objects themselves are returned within a `SearchHits` object which additionally contains informations about the whole search like the _maxScore_ or requested aggregations.
+These `SearchHit` objects themselves are returned within a `SearchHits` object which additionally contains informations about the whole search like the _maxScore_ or requested aggregations or the execution duration it took to complete the request.
 The following classes and interfaces are now available:
 
 .SearchHit<T>

src/main/java/org/springframework/data/elasticsearch/client/elc/DocumentAdapters.java

@@ -50,6 +50,7 @@
  *
  * @author Peter-Josef Meisch
  * @author Haibo Liu
+ * @author Mohamed El Harrougui
  * @since 4.4
  */
 final class DocumentAdapters {
@@ -74,7 +75,7 @@ public static SearchDocument from(Hit<?> hit, JsonpMapper jsonpMapper) {
 		Map<String, SearchDocumentResponse> innerHits = new LinkedHashMap<>();
 		hit.innerHits().forEach((name, innerHitsResult) -> {
 			// noinspection ReturnOfNull
-			innerHits.put(name, SearchDocumentResponseBuilder.from(innerHitsResult.hits(), null, null, null, null, null,
+			innerHits.put(name, SearchDocumentResponseBuilder.from(innerHitsResult.hits(), null, null, null, 0, null, null,
 					searchDocument -> null, jsonpMapper));
 		});
 

src/main/java/org/springframework/data/elasticsearch/client/elc/SearchDocumentResponseBuilder.java

@@ -29,6 +29,7 @@
 import co.elastic.clients.elasticsearch.core.search.TotalHits;
 import co.elastic.clients.json.JsonpMapper;
 
+import java.time.Duration;
 import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.List;
@@ -56,6 +57,7 @@
  *
  * @author Peter-Josef Meisch
  * @author Haibo Liu
+ * @author Mohamed El Harrougui
  * @since 4.4
  */
 class SearchDocumentResponseBuilder {
@@ -83,8 +85,10 @@ public static <T> SearchDocumentResponse from(ResponseBody<EntityAsMap> response
 		Map<String, List<Suggestion<EntityAsMap>>> suggest = responseBody.suggest();
 		var pointInTimeId = responseBody.pitId();
 		var shards = responseBody.shards();
+		var executionDurationInMillis = responseBody.took();
 
-		return from(hitsMetadata, shards, scrollId, pointInTimeId, aggregations, suggest, entityCreator, jsonpMapper);
+		return from(hitsMetadata, shards, scrollId, pointInTimeId, executionDurationInMillis, aggregations, suggest,
+				entityCreator, jsonpMapper);
 	}
 
 	/**
@@ -109,8 +113,10 @@ public static <T> SearchDocumentResponse from(SearchTemplateResponse<EntityAsMap
 		var aggregations = response.aggregations();
 		var suggest = response.suggest();
 		var pointInTimeId = response.pitId();
+		var executionDurationInMillis = response.took();
 
-		return from(hitsMetadata, shards, scrollId, pointInTimeId, aggregations, suggest, entityCreator, jsonpMapper);
+		return from(hitsMetadata, shards, scrollId, pointInTimeId, executionDurationInMillis, aggregations, suggest,
+				entityCreator, jsonpMapper);
 	}
 
 	/**
@@ -127,7 +133,7 @@ public static <T> SearchDocumentResponse from(SearchTemplateResponse<EntityAsMap
 	 * @return the {@link SearchDocumentResponse}
 	 */
 	public static <T> SearchDocumentResponse from(HitsMetadata<?> hitsMetadata, @Nullable ShardStatistics shards,
-			@Nullable String scrollId, @Nullable String pointInTimeId, @Nullable Map<String, Aggregate> aggregations,
+			@Nullable String scrollId, @Nullable String pointInTimeId, long executionDurationInMillis, @Nullable Map<String, Aggregate> aggregations,
 			Map<String, List<Suggestion<EntityAsMap>>> suggestES, SearchDocumentResponse.EntityCreator<T> entityCreator,
 			JsonpMapper jsonpMapper) {
 
@@ -151,6 +157,8 @@ public static <T> SearchDocumentResponse from(HitsMetadata<?> hitsMetadata, @Nul
 
 		float maxScore = hitsMetadata.maxScore() != null ? hitsMetadata.maxScore().floatValue() : Float.NaN;
 
+		Duration executionDuration = Duration.ofMillis(executionDurationInMillis);
+
 		List<SearchDocument> searchDocuments = new ArrayList<>();
 		for (Hit<?> hit : hitsMetadata.hits()) {
 			searchDocuments.add(DocumentAdapters.from(hit, jsonpMapper));
@@ -163,7 +171,7 @@ public static <T> SearchDocumentResponse from(HitsMetadata<?> hitsMetadata, @Nul
 
 		SearchShardStatistics shardStatistics = shards != null ? shardsFrom(shards) : null;
 
-		return new SearchDocumentResponse(totalHits, totalHitsRelation, maxScore, scrollId, pointInTimeId, searchDocuments,
+		return new SearchDocumentResponse(totalHits, totalHitsRelation, maxScore, executionDuration, scrollId, pointInTimeId, searchDocuments,
 				aggregationsContainer, suggest, shardStatistics);
 	}
 

src/main/java/org/springframework/data/elasticsearch/core/ReactiveSearchHits.java

@@ -17,6 +17,8 @@
 
 import reactor.core.publisher.Flux;
 
+import java.time.Duration;
+
 import org.springframework.data.elasticsearch.core.suggest.response.Suggest;
 import org.springframework.lang.Nullable;
 
@@ -25,6 +27,7 @@
  *
  * @param <T> the result data class.
  * @author Peter-Josef Meisch
+ * @author Mohamed El Harrougui
  * @since 4.4
  */
 public interface ReactiveSearchHits<T> {
@@ -37,6 +40,11 @@ public interface ReactiveSearchHits<T> {
 
 	float getMaxScore();
 
+	/**
+	 * @return the execution duration it took to complete the request
+	 */
+	Duration getExecutionDuration();
+
 	/**
 	 * @return the {@link SearchHit}s from the search result.
 	 */

src/main/java/org/springframework/data/elasticsearch/core/ReactiveSearchHitsImpl.java

@@ -17,11 +17,14 @@
 
 import reactor.core.publisher.Flux;
 
+import java.time.Duration;
+
 import org.springframework.data.elasticsearch.core.suggest.response.Suggest;
 import org.springframework.lang.Nullable;
 
 /**
  * @author Peter-Josef Meisch
+ * @author Mohamed El Harrougui
  * @since 4.4
  */
 public class ReactiveSearchHitsImpl<T> implements ReactiveSearchHits<T> {
@@ -58,6 +61,11 @@ public float getMaxScore() {
 		return delegate.getMaxScore();
 	}
 
+	@Override
+	public Duration getExecutionDuration() {
+		return delegate.getExecutionDuration();
+	}
+
 	@Override
 	public boolean hasSearchHits() {
 		return delegate.hasSearchHits();

src/main/java/org/springframework/data/elasticsearch/core/SearchHitMapping.java

@@ -15,6 +15,7 @@
  */
 package org.springframework.data.elasticsearch.core;
 
+import java.time.Duration;
 import java.util.ArrayList;
 import java.util.LinkedHashMap;
 import java.util.LinkedList;
@@ -47,6 +48,7 @@
  * @author Sascha Woo
  * @author Jakob Hoeper
  * @author Haibo Liu
+ * @author Mohamed El Harrougui
  * @since 4.0
  */
 public class SearchHitMapping<T> {
@@ -87,6 +89,7 @@ private SearchHitsImpl<T> mapHitsFromResponse(SearchDocumentResponse searchDocum
 		long totalHits = searchDocumentResponse.getTotalHits();
 		SearchShardStatistics shardStatistics = searchDocumentResponse.getSearchShardStatistics();
 		float maxScore = searchDocumentResponse.getMaxScore();
+		Duration executionDuration = searchDocumentResponse.getExecutionDuration();
 		String scrollId = searchDocumentResponse.getScrollId();
 		String pointInTimeId = searchDocumentResponse.getPointInTimeId();
 
@@ -104,8 +107,8 @@ private SearchHitsImpl<T> mapHitsFromResponse(SearchDocumentResponse searchDocum
 		Suggest suggest = searchDocumentResponse.getSuggest();
 		mapHitsInCompletionSuggestion(suggest);
 
-		return new SearchHitsImpl<>(totalHits, totalHitsRelation, maxScore, scrollId, pointInTimeId, searchHits,
-				aggregations, suggest, shardStatistics);
+		return new SearchHitsImpl<>(totalHits, totalHitsRelation, maxScore, executionDuration, scrollId, pointInTimeId,
+				searchHits, aggregations, suggest, shardStatistics);
 	}
 
 	@SuppressWarnings("unchecked")
@@ -238,6 +241,7 @@ private SearchHits<?> mapInnerDocuments(SearchHits<SearchDocument> searchHits, C
 				return new SearchHitsImpl<>(searchHits.getTotalHits(),
 						searchHits.getTotalHitsRelation(),
 						searchHits.getMaxScore(),
+						searchHits.getExecutionDuration(),
 						scrollId,
 						searchHits.getPointInTimeId(),
 						convertedSearchHits,

src/main/java/org/springframework/data/elasticsearch/core/SearchHits.java

@@ -15,6 +15,7 @@
  */
 package org.springframework.data.elasticsearch.core;
 
+import java.time.Duration;
 import java.util.Iterator;
 import java.util.List;
 
@@ -28,6 +29,7 @@
  * @param <T> the result data class.
  * @author Sascha Woo
  * @author Haibo Liu
+ * @author Mohamed El Harrougui
  * @since 4.0
  */
 public interface SearchHits<T> extends Streamable<SearchHit<T>> {
@@ -43,6 +45,11 @@ public interface SearchHits<T> extends Streamable<SearchHit<T>> {
 	 */
 	float getMaxScore();
 
+	/**
+	 * @return the execution duration it took to complete the request
+	 */
+	Duration getExecutionDuration();
+
 	/**
 	 * @param index position in List.
 	 * @return the {@link SearchHit} at position {index}

src/main/java/org/springframework/data/elasticsearch/core/SearchHitsImpl.java

@@ -15,6 +15,7 @@
  */
 package org.springframework.data.elasticsearch.core;
 
+import java.time.Duration;
 import java.util.Collections;
 import java.util.List;
 
@@ -30,13 +31,15 @@
  * @author Peter-Josef Meisch
  * @author Sascha Woo
  * @author Haibo Liu
+ * @author Mohamed El Harrougui
  * @since 4.0
  */
 public class SearchHitsImpl<T> implements SearchScrollHits<T> {
 
 	private final long totalHits;
 	private final TotalHitsRelation totalHitsRelation;
 	private final float maxScore;
+	private final Duration executionDuration;
 	@Nullable private final String scrollId;
 	private final List<? extends SearchHit<T>> searchHits;
 	private final Lazy<List<SearchHit<T>>> unmodifiableSearchHits;
@@ -49,12 +52,13 @@ public class SearchHitsImpl<T> implements SearchScrollHits<T> {
 	 * @param totalHits the number of total hits for the search
 	 * @param totalHitsRelation the relation {@see TotalHitsRelation}, must not be {@literal null}
 	 * @param maxScore the maximum score
+	 * @param executionDuration the execution duration it took to complete the request
 	 * @param scrollId the scroll id if available
 	 * @param searchHits must not be {@literal null}
 	 * @param aggregations the aggregations if available
 	 */
-	public SearchHitsImpl(long totalHits, TotalHitsRelation totalHitsRelation, float maxScore, @Nullable String scrollId,
-			@Nullable String pointInTimeId, List<? extends SearchHit<T>> searchHits,
+	public SearchHitsImpl(long totalHits, TotalHitsRelation totalHitsRelation, float maxScore, Duration executionDuration,
+			@Nullable String scrollId, @Nullable String pointInTimeId, List<? extends SearchHit<T>> searchHits,
 			@Nullable AggregationsContainer<?> aggregations, @Nullable Suggest suggest,
 			@Nullable SearchShardStatistics searchShardStatistics) {
 
@@ -63,6 +67,7 @@ public SearchHitsImpl(long totalHits, TotalHitsRelation totalHitsRelation, float
 		this.totalHits = totalHits;
 		this.totalHitsRelation = totalHitsRelation;
 		this.maxScore = maxScore;
+		this.executionDuration = executionDuration;
 		this.scrollId = scrollId;
 		this.pointInTimeId = pointInTimeId;
 		this.searchHits = searchHits;
@@ -88,6 +93,11 @@ public float getMaxScore() {
 		return maxScore;
 	}
 
+	@Override
+	public Duration getExecutionDuration() {
+		return executionDuration;
+	}
+
 	@Override
 	@Nullable
 	public String getScrollId() {
@@ -133,6 +143,7 @@ public String toString() {
 				"totalHits=" + totalHits + //
 				", totalHitsRelation=" + totalHitsRelation + //
 				", maxScore=" + maxScore + //
+				", executionDuration=" + executionDuration + //
 				", scrollId='" + scrollId + '\'' + //
 				", pointInTimeId='" + pointInTimeId + '\'' + //
 				", searchHits={" + searchHits.size() + " elements}" + //

src/main/java/org/springframework/data/elasticsearch/core/SearchHitsIterator.java

@@ -15,6 +15,8 @@
  */
 package org.springframework.data.elasticsearch.core;
 
+import java.time.Duration;
+
 import org.springframework.data.util.CloseableIterator;
 import org.springframework.lang.Nullable;
 
@@ -23,6 +25,7 @@
  * {@link java.util.stream.Stream}.
  *
  * @author Sascha Woo
+ * @author Mohamed El Harrougui
  * @param <T>
  * @since 4.0
  */
@@ -39,6 +42,11 @@ public interface SearchHitsIterator<T> extends CloseableIterator<SearchHit<T>> {
 	 */
 	float getMaxScore();
 
+	/**
+	 * @return the execution duration it took to complete the request
+	 */
+	Duration getExecutionDuration();
+
 	/**
 	 * @return the number of total hits.
 	 */

src/main/java/org/springframework/data/elasticsearch/core/StreamQueries.java

@@ -15,6 +15,7 @@
  */
 package org.springframework.data.elasticsearch.core;
 
+import java.time.Duration;
 import java.util.Iterator;
 import java.util.List;
 import java.util.NoSuchElementException;
@@ -31,6 +32,7 @@
  *
  * @author Mark Paluch
  * @author Sascha Woo
+ * @author Mohamed El Harrougui
  * @since 3.2
  */
 abstract class StreamQueries {
@@ -56,6 +58,7 @@ static <T> SearchHitsIterator<T> streamResults(int maxCount, SearchScrollHits<T>
 
 		AggregationsContainer<?> aggregations = searchHits.getAggregations();
 		float maxScore = searchHits.getMaxScore();
+		Duration executionDuration = searchHits.getExecutionDuration();
 		long totalHits = searchHits.getTotalHits();
 		TotalHitsRelation totalHitsRelation = searchHits.getTotalHitsRelation();
 
@@ -86,6 +89,11 @@ public float getMaxScore() {
 				return maxScore;
 			}
 
+			@Override
+			public Duration getExecutionDuration() {
+				return executionDuration;
+			}
+
 			@Override
 			public long getTotalHits() {
 				return totalHits;