Remove redundant o.e.search.Scroll class (#119718)

This is just a pointless wrapper around `TimeValue` at this point.
It can be removed and all its uses replaced by `TimeValue` without
any change to the transport protocol or logic => no reason to keep
a redundant class around.

Author: original-brownbear

modules/lang-mustache/src/test/java/org/elasticsearch/script/mustache/MultiSearchTemplateRequestTests.java

@@ -13,7 +13,6 @@
 import org.elasticsearch.common.bytes.BytesArray;
 import org.elasticsearch.rest.RestRequest;
 import org.elasticsearch.script.ScriptType;
-import org.elasticsearch.search.Scroll;
 import org.elasticsearch.search.builder.SearchSourceBuilder;
 import org.elasticsearch.test.ESTestCase;
 import org.elasticsearch.test.StreamsUtils;
@@ -102,7 +101,7 @@ public void testMultiSearchTemplateToJson() throws Exception {
             String[] indices = { "test" };
             SearchRequest searchRequest = new SearchRequest(indices);
             // scroll is not supported in the current msearch or msearchtemplate api, so unset it:
-            searchRequest.scroll((Scroll) null);
+            searchRequest.scroll(null);
             // batched reduce size is currently not set-able on a per-request basis as it is a query string parameter only
             searchRequest.setBatchedReduceSize(SearchRequest.DEFAULT_BATCHED_REDUCE_SIZE);
             SearchTemplateRequest searchTemplateRequest = new SearchTemplateRequest(searchRequest);

modules/reindex/src/main/java/org/elasticsearch/reindex/AbstractAsyncBulkByScrollAction.java

@@ -43,7 +43,6 @@
 import org.elasticsearch.script.Metadata;
 import org.elasticsearch.script.Script;
 import org.elasticsearch.script.ScriptService;
-import org.elasticsearch.search.Scroll;
 import org.elasticsearch.search.builder.SearchSourceBuilder;
 import org.elasticsearch.search.sort.SortBuilder;
 import org.elasticsearch.threadpool.ThreadPool;
@@ -212,7 +211,7 @@ static <Request extends AbstractBulkByScrollRequest<Request>> SearchRequest prep
         if (mainRequest.getMaxDocs() != MAX_DOCS_ALL_MATCHES
             && mainRequest.getMaxDocs() <= preparedSearchRequest.source().size()
             && mainRequest.isAbortOnVersionConflict()) {
-            preparedSearchRequest.scroll((Scroll) null);
+            preparedSearchRequest.scroll(null);
         }
 
         return preparedSearchRequest;

modules/reindex/src/main/java/org/elasticsearch/reindex/remote/RemoteRequestBuilders.java

@@ -53,7 +53,7 @@ static Request initialSearch(SearchRequest searchRequest, BytesReference query,
         Request request = new Request("POST", path.toString());
 
         if (searchRequest.scroll() != null) {
-            TimeValue keepAlive = searchRequest.scroll().keepAlive();
+            TimeValue keepAlive = searchRequest.scroll();
             // V_5_0_0
             if (remoteVersion.before(Version.fromId(5000099))) {
                 /* Versions of Elasticsearch before 5.0 couldn't parse nanos or micros

modules/reindex/src/main/java/org/elasticsearch/reindex/remote/RemoteScrollableHitSource.java

@@ -100,7 +100,7 @@ private void onStartResponse(RejectAwareActionListener<Response> searchListener,
 
     @Override
     protected void doStartNextScroll(String scrollId, TimeValue extraKeepAlive, RejectAwareActionListener<Response> searchListener) {
-        TimeValue keepAlive = timeValueNanos(searchRequest.scroll().keepAlive().nanos() + extraKeepAlive.nanos());
+        TimeValue keepAlive = timeValueNanos(searchRequest.scroll().nanos() + extraKeepAlive.nanos());
         execute(RemoteRequestBuilders.scroll(scrollId, keepAlive, remoteVersion), RESPONSE_PARSER, searchListener);
     }
 

modules/reindex/src/test/java/org/elasticsearch/reindex/AsyncBulkByScrollActionTests.java

@@ -597,7 +597,7 @@ protected RequestWrapper<?> buildRequest(Hit doc) {
             capturedCommand.get().run();
 
             // So the next request is going to have to wait an extra 100 seconds or so (base was 10 seconds, so 110ish)
-            assertThat(client.lastScroll.get().request.scroll().keepAlive().seconds(), either(equalTo(110L)).or(equalTo(109L)));
+            assertThat(client.lastScroll.get().request.scroll().seconds(), either(equalTo(110L)).or(equalTo(109L)));
 
             // Now we can simulate a response and check the delay that we used for the task
             if (randomBoolean()) {

modules/reindex/src/test/java/org/elasticsearch/reindex/ClientScrollableHitSourceTests.java

@@ -155,10 +155,7 @@ public void testScrollKeepAlive() {
         );
 
         hitSource.startNextScroll(timeValueSeconds(100));
-        client.validateRequest(
-            TransportSearchScrollAction.TYPE,
-            (SearchScrollRequest r) -> assertEquals(r.scroll().keepAlive().seconds(), 110)
-        );
+        client.validateRequest(TransportSearchScrollAction.TYPE, (SearchScrollRequest r) -> assertEquals(r.scroll().seconds(), 110));
     }
 
     private SearchResponse createSearchResponse() {

server/src/internalClusterTest/java/org/elasticsearch/search/slice/SearchSliceIT.java

@@ -24,7 +24,6 @@
 import org.elasticsearch.common.bytes.BytesReference;
 import org.elasticsearch.common.settings.Settings;
 import org.elasticsearch.core.TimeValue;
-import org.elasticsearch.search.Scroll;
 import org.elasticsearch.search.SearchHit;
 import org.elasticsearch.search.builder.PointInTimeBuilder;
 import org.elasticsearch.search.sort.ShardDocSortField;
@@ -97,14 +96,14 @@ public void testSearchSort() throws Exception {
             int fetchSize = randomIntBetween(10, 100);
             // test _doc sort
             SearchRequestBuilder request = prepareSearch("test").setQuery(matchAllQuery())
-                .setScroll(new Scroll(TimeValue.timeValueSeconds(10)))
+                .setScroll(TimeValue.timeValueSeconds(10))
                 .setSize(fetchSize)
                 .addSort(SortBuilders.fieldSort("_doc"));
             assertSearchSlicesWithScroll(request, field, max, numDocs);
 
             // test numeric sort
             request = prepareSearch("test").setQuery(matchAllQuery())
-                .setScroll(new Scroll(TimeValue.timeValueSeconds(10)))
+                .setScroll(TimeValue.timeValueSeconds(10))
                 .addSort(SortBuilders.fieldSort("random_int"))
                 .setSize(fetchSize);
             assertSearchSlicesWithScroll(request, field, max, numDocs);
@@ -121,7 +120,7 @@ public void testWithPreferenceAndRoutings() throws Exception {
             int max = randomIntBetween(2, numShards * 3);
             int fetchSize = randomIntBetween(10, 100);
             SearchRequestBuilder request = prepareSearch("test").setQuery(matchAllQuery())
-                .setScroll(new Scroll(TimeValue.timeValueSeconds(10)))
+                .setScroll(TimeValue.timeValueSeconds(10))
                 .setSize(fetchSize)
                 .setPreference("_shards:1,4")
                 .addSort(SortBuilders.fieldSort("_doc"));
@@ -133,7 +132,7 @@ public void testWithPreferenceAndRoutings() throws Exception {
             int max = randomIntBetween(2, numShards * 3);
             int fetchSize = randomIntBetween(10, 100);
             SearchRequestBuilder request = prepareSearch("test").setQuery(matchAllQuery())
-                .setScroll(new Scroll(TimeValue.timeValueSeconds(10)))
+                .setScroll(TimeValue.timeValueSeconds(10))
                 .setSize(fetchSize)
                 .setRouting("foo", "bar")
                 .addSort(SortBuilders.fieldSort("_doc"));
@@ -151,7 +150,7 @@ public void testWithPreferenceAndRoutings() throws Exception {
             int max = randomIntBetween(2, numShards * 3);
             int fetchSize = randomIntBetween(10, 100);
             SearchRequestBuilder request = prepareSearch("alias1", "alias3").setQuery(matchAllQuery())
-                .setScroll(new Scroll(TimeValue.timeValueSeconds(10)))
+                .setScroll(TimeValue.timeValueSeconds(10))
                 .setSize(fetchSize)
                 .addSort(SortBuilders.fieldSort("_doc"));
             assertSearchSlicesWithScroll(request, "_id", max, numDocs);
@@ -176,7 +175,7 @@ private void assertSearchSlicesWithScroll(SearchRequestBuilder request, String f
                     searchResponse.decRef();
                     searchResponse = client().prepareSearchScroll("test")
                         .setScrollId(scrollId)
-                        .setScroll(new Scroll(TimeValue.timeValueSeconds(10)))
+                        .setScroll(TimeValue.timeValueSeconds(10))
                         .get();
                     scrollId = searchResponse.getScrollId();
                     totalResults += searchResponse.getHits().getHits().length;
@@ -271,7 +270,7 @@ public void testInvalidFields() throws Exception {
         SearchPhaseExecutionException exc = expectThrows(
             SearchPhaseExecutionException.class,
             prepareSearch("test").setQuery(matchAllQuery())
-                .setScroll(new Scroll(TimeValue.timeValueSeconds(10)))
+                .setScroll(TimeValue.timeValueSeconds(10))
                 .slice(new SliceBuilder("invalid_random_int", 0, 10))
 
         );
@@ -282,7 +281,7 @@ public void testInvalidFields() throws Exception {
         exc = expectThrows(
             SearchPhaseExecutionException.class,
             prepareSearch("test").setQuery(matchAllQuery())
-                .setScroll(new Scroll(TimeValue.timeValueSeconds(10)))
+                .setScroll(TimeValue.timeValueSeconds(10))
                 .slice(new SliceBuilder("invalid_random_kw", 0, 10))
         );
         rootCause = findRootCause(exc);

server/src/main/java/org/elasticsearch/action/search/CanMatchNodeRequest.java

@@ -21,7 +21,6 @@
 import org.elasticsearch.core.TimeValue;
 import org.elasticsearch.index.query.QueryBuilder;
 import org.elasticsearch.index.shard.ShardId;
-import org.elasticsearch.search.Scroll;
 import org.elasticsearch.search.aggregations.AggregationBuilder;
 import org.elasticsearch.search.builder.SearchSourceBuilder;
 import org.elasticsearch.search.builder.SubSearchSourceBuilder;
@@ -49,7 +48,8 @@ public class CanMatchNodeRequest extends TransportRequest implements IndicesRequ
     private final SearchType searchType;
     private final Boolean requestCache;
     private final boolean allowPartialSearchResults;
-    private final Scroll scroll;
+    @Nullable
+    private final TimeValue scroll;
     private final int numberOfShards;
     private final long nowInMillis;
     @Nullable
@@ -195,7 +195,7 @@ public CanMatchNodeRequest(StreamInput in) throws IOException {
                 );
             }
         }
-        scroll = in.readOptionalWriteable(Scroll::new);
+        scroll = in.readOptionalTimeValue();
         requestCache = in.readOptionalBoolean();
         allowPartialSearchResults = in.readBoolean();
         numberOfShards = in.readVInt();
@@ -216,7 +216,7 @@ public void writeTo(StreamOutput out) throws IOException {
             // types not supported so send an empty array to previous versions
             out.writeStringArray(Strings.EMPTY_ARRAY);
         }
-        out.writeOptionalWriteable(scroll);
+        out.writeOptionalTimeValue(scroll);
         out.writeOptionalBoolean(requestCache);
         out.writeBoolean(allowPartialSearchResults);
         out.writeVInt(numberOfShards);

server/src/main/java/org/elasticsearch/action/search/SearchRequest.java

@@ -24,7 +24,6 @@
 import org.elasticsearch.index.mapper.SourceLoader;
 import org.elasticsearch.index.query.QueryRewriteContext;
 import org.elasticsearch.index.query.Rewriteable;
-import org.elasticsearch.search.Scroll;
 import org.elasticsearch.search.builder.PointInTimeBuilder;
 import org.elasticsearch.search.builder.SearchSourceBuilder;
 import org.elasticsearch.search.internal.SearchContext;
@@ -82,7 +81,7 @@ public class SearchRequest extends ActionRequest implements IndicesRequest.Repla
 
     private Boolean allowPartialSearchResults;
 
-    private Scroll scroll;
+    private TimeValue scrollKeepAlive;
 
     private int batchedReduceSize = DEFAULT_BATCHED_REDUCE_SIZE;
 
@@ -206,7 +205,7 @@ private SearchRequest(
         this.preFilterShardSize = searchRequest.preFilterShardSize;
         this.requestCache = searchRequest.requestCache;
         this.routing = searchRequest.routing;
-        this.scroll = searchRequest.scroll;
+        this.scrollKeepAlive = searchRequest.scrollKeepAlive;
         this.searchType = searchRequest.searchType;
         this.source = searchRequest.source;
         this.localClusterAlias = localClusterAlias;
@@ -229,7 +228,7 @@ public SearchRequest(StreamInput in) throws IOException {
         indices = in.readStringArray();
         routing = in.readOptionalString();
         preference = in.readOptionalString();
-        scroll = in.readOptionalWriteable(Scroll::new);
+        scrollKeepAlive = in.readOptionalTimeValue();
         source = in.readOptionalWriteable(SearchSourceBuilder::new);
         if (in.getTransportVersion().before(TransportVersions.V_8_0_0)) {
             // types no longer relevant so ignore
@@ -276,7 +275,7 @@ public void writeTo(StreamOutput out) throws IOException {
         out.writeStringArray(indices);
         out.writeOptionalString(routing);
         out.writeOptionalString(preference);
-        out.writeOptionalWriteable(scroll);
+        out.writeOptionalTimeValue(scrollKeepAlive);
         out.writeOptionalWriteable(source);
         if (out.getTransportVersion().before(TransportVersions.V_8_0_0)) {
             // types not supported so send an empty array to previous versions
@@ -525,23 +524,16 @@ public String[] indices() {
     /**
      * If set, will enable scrolling of the search request.
      */
-    public Scroll scroll() {
-        return scroll;
-    }
-
-    /**
-     * If set, will enable scrolling of the search request.
-     */
-    public SearchRequest scroll(Scroll scroll) {
-        this.scroll = scroll;
-        return this;
+    public TimeValue scroll() {
+        return scrollKeepAlive;
     }
 
     /**
      * If set, will enable scrolling of the search request for the specified timeout.
      */
     public SearchRequest scroll(TimeValue keepAlive) {
-        return scroll(new Scroll(keepAlive));
+        this.scrollKeepAlive = keepAlive;
+        return this;
     }
 
     /**
@@ -681,7 +673,7 @@ public boolean hasKnnSearch() {
     }
 
     public int resolveTrackTotalHitsUpTo() {
-        return resolveTrackTotalHitsUpTo(scroll, source);
+        return resolveTrackTotalHitsUpTo(scrollKeepAlive, source);
     }
 
     /**
@@ -731,7 +723,7 @@ public SearchRequest rewrite(QueryRewriteContext ctx) throws IOException {
         return hasChanged ? new SearchRequest(this).source(source) : this;
     }
 
-    public static int resolveTrackTotalHitsUpTo(Scroll scroll, SearchSourceBuilder source) {
+    public static int resolveTrackTotalHitsUpTo(TimeValue scroll, SearchSourceBuilder source) {
         if (scroll != null) {
             // no matter what the value of track_total_hits is
             return SearchContext.TRACK_TOTAL_HITS_ACCURATE;
@@ -752,8 +744,8 @@ public final String buildDescription() {
         Strings.arrayToDelimitedString(indices, ",", sb);
         sb.append("]");
         sb.append(", search_type[").append(searchType).append("]");
-        if (scroll != null) {
-            sb.append(", scroll[").append(scroll.keepAlive()).append("]");
+        if (scrollKeepAlive != null) {
+            sb.append(", scroll[").append(scrollKeepAlive).append("]");
         }
         if (source != null) {
             sb.append(", source[").append(source.toString(FORMAT_PARAMS)).append("]");
@@ -784,7 +776,7 @@ public boolean equals(Object o) {
             && Objects.equals(preference, that.preference)
             && Objects.equals(source, that.source)
             && Objects.equals(requestCache, that.requestCache)
-            && Objects.equals(scroll, that.scroll)
+            && Objects.equals(scrollKeepAlive, that.scrollKeepAlive)
             && Objects.equals(batchedReduceSize, that.batchedReduceSize)
             && Objects.equals(maxConcurrentShardRequests, that.maxConcurrentShardRequests)
             && Objects.equals(preFilterShardSize, that.preFilterShardSize)
@@ -805,7 +797,7 @@ public int hashCode() {
             preference,
             source,
             requestCache,
-            scroll,
+            scrollKeepAlive,
             indicesOptions,
             batchedReduceSize,
             maxConcurrentShardRequests,
@@ -836,7 +828,7 @@ public String toString() {
             + ", requestCache="
             + requestCache
             + ", scroll="
-            + scroll
+            + scrollKeepAlive
             + ", maxConcurrentShardRequests="
             + maxConcurrentShardRequests
             + ", batchedReduceSize="

server/src/main/java/org/elasticsearch/action/search/SearchRequestBuilder.java

@@ -16,7 +16,6 @@
 import org.elasticsearch.core.TimeValue;
 import org.elasticsearch.index.query.QueryBuilder;
 import org.elasticsearch.script.Script;
-import org.elasticsearch.search.Scroll;
 import org.elasticsearch.search.aggregations.AggregationBuilder;
 import org.elasticsearch.search.aggregations.PipelineAggregationBuilder;
 import org.elasticsearch.search.builder.PointInTimeBuilder;
@@ -62,14 +61,6 @@ public SearchRequestBuilder setSearchType(SearchType searchType) {
         return this;
     }
 
-    /**
-     * If set, will enable scrolling of the search request.
-     */
-    public SearchRequestBuilder setScroll(Scroll scroll) {
-        request.scroll(scroll);
-        return this;
-    }
-
     /**
      * If set, will enable scrolling of the search request for the specified timeout.
      */