DATAES-1003 - Polishing.

Author: sothawo

Diff for: src/main/java/org/springframework/data/elasticsearch/core/RequestFactory.java

@@ -1172,9 +1172,9 @@ private SearchRequest prepareSearchRequest(Query query, @Nullable Class<?> clazz
 		if (StringUtils.hasLength(query.getRoute())) {
 			request.routing(query.getRoute());
 		}
-		
+
 		TimeValue timeout = query.getTimeout();
-		if (timeout !=null) {
+		if (timeout != null) {
 			sourceBuilder.timeout(timeout);
 		}
 
@@ -1252,9 +1252,9 @@ private SearchRequestBuilder prepareSearchRequestBuilder(Query query, Client cli
 		if (StringUtils.hasLength(query.getRoute())) {
 			searchRequestBuilder.setRouting(query.getRoute());
 		}
-		
+
 		TimeValue timeout = query.getTimeout();
-		if (timeout !=null) {
+		if (timeout != null) {
 			searchRequestBuilder.setTimeout(timeout);
 		}
 

Diff for: src/main/java/org/springframework/data/elasticsearch/core/query/AbstractQuery.java

@@ -254,14 +254,20 @@ public Duration getScrollTime() {
 	public void setScrollTime(@Nullable Duration scrollTime) {
 		this.scrollTime = scrollTime;
 	}
-	
+
 	@Nullable
 	@Override
 	public TimeValue getTimeout() {
 		return timeout;
 	}
 
-	public void setTimeout(TimeValue timeout) {
+	/**
+	 * set the query timeout
+	 *
+	 * @param timeout
+	 * @since 4.2
+	 */
+	public void setTimeout(@Nullable TimeValue timeout) {
 		this.timeout = timeout;
 	}
 }

Diff for: src/main/java/org/springframework/data/elasticsearch/core/query/Query.java

@@ -198,7 +198,7 @@ default Integer getMaxResults() {
 
 	/**
 	 * Sets the {@link HighlightQuery}.
-	 * 
+	 *
 	 * @param highlightQuery the query to set
 	 * @since 4.0
 	 */
@@ -216,7 +216,7 @@ default Optional<HighlightQuery> getHighlightQuery() {
 	 * Sets the flag whether to set the Track_total_hits parameter on queries {@see <a href=
 	 * "https://www.elastic.co/guide/en/elasticsearch/reference/7.0/search-request-track-total-hits.html">Elasticseacrh
 	 * documentation</>}
-	 * 
+	 *
 	 * @param trackTotalHits the value to set.
 	 * @since 4.0
 	 */
@@ -235,7 +235,7 @@ default Optional<HighlightQuery> getHighlightQuery() {
 
 	/**
 	 * Sets the maximum value up to which total hits are tracked. Only relevant if #getTrackTotalHits is {@literal null}
-	 * 
+	 *
 	 * @param trackTotalHitsUpTo max limit for trackTotalHits
 	 * @since 4.1
 	 */
@@ -253,7 +253,7 @@ default Optional<HighlightQuery> getHighlightQuery() {
 	/**
 	 * For queries that are used in delete request, these are internally handled by Elasticsearch as scroll/bulk delete
 	 * queries. Must not return {@literal null} when {@link #hasScrollTime()} returns {@literal true}.
-	 * 
+	 *
 	 * @return the scrolltime settings
 	 * @since 4.0
 	 */
@@ -263,7 +263,7 @@ default Optional<HighlightQuery> getHighlightQuery() {
 	/**
 	 * For queries that are used in delete request, these are internally handled by Elasticsearch as scroll/bulk delete
 	 * queries.
-	 * 
+	 *
 	 * @param scrollTime the scrolltime settings
 	 * @since 4.0
 	 */
@@ -276,11 +276,12 @@ default Optional<HighlightQuery> getHighlightQuery() {
 	default boolean hasScrollTime() {
 		return getScrollTime() != null;
 	}
-	
+
 	/**
-	 * Get timeout
+	 * Get the query timeout.
 	 *
 	 * @return null if not set
+	 * @since 4.2
 	 */
 	@Nullable
 	TimeValue getTimeout();

Diff for: src/test/java/org/springframework/data/elasticsearch/core/RequestFactoryTests.java

@@ -482,30 +482,31 @@ void shouldSetOpTypeIndexIfSpecified() {
 
 		assertThat(indexRequest.opType()).isEqualTo(DocWriteRequest.OpType.INDEX);
 	}
-	
-	@Test
+
+	@Test // DATAES-1003
 	@DisplayName("should set timeout to request")
 	void shouldSetTimeoutToRequest() {
-		Query query = new NativeSearchQueryBuilder().withQuery(matchAllQuery()).withTimeout(TimeValue.timeValueSeconds(1)).build();
+		Query query = new NativeSearchQueryBuilder().withQuery(matchAllQuery()).withTimeout(TimeValue.timeValueSeconds(1))
+				.build();
 
 		SearchRequest searchRequest = requestFactory.searchRequest(query, Person.class, IndexCoordinates.of("persons"));
 
 		assertThat(searchRequest.source().timeout()).isEqualTo(TimeValue.timeValueSeconds(1));
 	}
 
-	@Test
+	@Test // DATAES-1003
 	@DisplayName("should set timeout to requestbuilder")
 	void shouldSetTimeoutToRequestBuilder() {
 		when(client.prepareSearch(any())).thenReturn(new SearchRequestBuilder(client, SearchAction.INSTANCE));
-		Query query = new NativeSearchQueryBuilder().withQuery(matchAllQuery()).withTimeout(TimeValue.timeValueSeconds(1)).build();
+		Query query = new NativeSearchQueryBuilder().withQuery(matchAllQuery()).withTimeout(TimeValue.timeValueSeconds(1))
+				.build();
 
 		SearchRequestBuilder searchRequestBuilder = requestFactory.searchRequestBuilder(client, query, Person.class,
 				IndexCoordinates.of("persons"));
 
 		assertThat(searchRequestBuilder.request().source().timeout()).isEqualTo(TimeValue.timeValueSeconds(1));
 	}
 
-
 	private String requestToString(ToXContent request) throws IOException {
 		return XContentHelper.toXContent(request, XContentType.JSON, true).utf8ToString();
 	}