Add start rollup job support to HL REST Client (#34623)

This change adds support for starting a rollup job to High Level REST Client.

Relates to #29827

Author: Christoph Büscher

client/rest-high-level/src/main/java/org/elasticsearch/client/RollupClient.java

@@ -20,12 +20,14 @@
 package org.elasticsearch.client;
 
 import org.elasticsearch.action.ActionListener;
-import org.elasticsearch.client.rollup.GetRollupJobRequest;
-import org.elasticsearch.client.rollup.GetRollupJobResponse;
 import org.elasticsearch.client.rollup.GetRollupCapsRequest;
 import org.elasticsearch.client.rollup.GetRollupCapsResponse;
+import org.elasticsearch.client.rollup.GetRollupJobRequest;
+import org.elasticsearch.client.rollup.GetRollupJobResponse;
 import org.elasticsearch.client.rollup.PutRollupJobRequest;
 import org.elasticsearch.client.rollup.PutRollupJobResponse;
+import org.elasticsearch.client.rollup.StartRollupJobRequest;
+import org.elasticsearch.client.rollup.StartRollupJobResponse;
 
 import java.io.IOException;
 import java.util.Collections;
@@ -56,10 +58,10 @@ public class RollupClient {
      */
     public PutRollupJobResponse putRollupJob(PutRollupJobRequest request, RequestOptions options) throws IOException {
         return restHighLevelClient.performRequestAndParseEntity(request,
-            RollupRequestConverters::putJob,
-            options,
-            PutRollupJobResponse::fromXContent,
-            Collections.emptySet());
+                RollupRequestConverters::putJob,
+                options,
+                PutRollupJobResponse::fromXContent,
+                Collections.emptySet());
     }
 
     /**
@@ -72,10 +74,44 @@ public PutRollupJobResponse putRollupJob(PutRollupJobRequest request, RequestOpt
      */
     public void putRollupJobAsync(PutRollupJobRequest request, RequestOptions options, ActionListener<PutRollupJobResponse> listener) {
         restHighLevelClient.performRequestAsyncAndParseEntity(request,
-            RollupRequestConverters::putJob,
-            options,
-            PutRollupJobResponse::fromXContent,
-            listener, Collections.emptySet());
+                RollupRequestConverters::putJob,
+                options,
+                PutRollupJobResponse::fromXContent,
+                listener, Collections.emptySet());
+    }
+
+    /**
+     * Start a rollup job
+     * See <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-start-job.html">
+     * the docs</a> for more.
+     * @param request the request
+     * @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
+     * @return the response
+     * @throws IOException in case there is a problem sending the request or parsing back the response
+     */
+    public StartRollupJobResponse startRollupJob(StartRollupJobRequest request, RequestOptions options)  throws IOException {
+        return restHighLevelClient.performRequestAndParseEntity(request,
+                RollupRequestConverters::startJob,
+                options,
+                StartRollupJobResponse::fromXContent,
+                Collections.emptySet());
+    }
+
+    /**
+     * Asynchronously start a rollup job
+     * See <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-start-job.html">
+     * the docs</a> for more.
+     * @param request the request
+     * @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
+     * @param listener the listener to be notified upon request completion
+     */
+    public void startRollupJobAsync(StartRollupJobRequest request, RequestOptions options,
+            ActionListener<StartRollupJobResponse> listener) {
+        restHighLevelClient.performRequestAsyncAndParseEntity(request,
+                RollupRequestConverters::startJob,
+                options,
+                StartRollupJobResponse::fromXContent,
+                listener, Collections.emptySet());
     }
 
     /**
@@ -89,10 +125,10 @@ public void putRollupJobAsync(PutRollupJobRequest request, RequestOptions option
      */
     public GetRollupJobResponse getRollupJob(GetRollupJobRequest request, RequestOptions options) throws IOException {
         return restHighLevelClient.performRequestAndParseEntity(request,
-            RollupRequestConverters::getJob,
-            options,
-            GetRollupJobResponse::fromXContent,
-            Collections.emptySet());
+                RollupRequestConverters::getJob,
+                options,
+                GetRollupJobResponse::fromXContent,
+                Collections.emptySet());
     }
 
     /**
@@ -107,10 +143,10 @@ public GetRollupJobResponse getRollupJob(GetRollupJobRequest request, RequestOpt
 
     public void getRollupJobAsync(GetRollupJobRequest request, RequestOptions options, ActionListener<GetRollupJobResponse> listener) {
         restHighLevelClient.performRequestAsyncAndParseEntity(request,
-            RollupRequestConverters::getJob,
-            options,
-            GetRollupJobResponse::fromXContent,
-            listener, Collections.emptySet());
+                RollupRequestConverters::getJob,
+                options,
+                GetRollupJobResponse::fromXContent,
+                listener, Collections.emptySet());
     }
 
     /**
@@ -124,10 +160,10 @@ public void getRollupJobAsync(GetRollupJobRequest request, RequestOptions option
      */
     public GetRollupCapsResponse getRollupCapabilities(GetRollupCapsRequest request, RequestOptions options) throws IOException {
         return restHighLevelClient.performRequestAndParseEntity(request,
-            RollupRequestConverters::getRollupCaps,
-            options,
-            GetRollupCapsResponse::fromXContent,
-            Collections.emptySet());
+                RollupRequestConverters::getRollupCaps,
+                options,
+                GetRollupCapsResponse::fromXContent,
+                Collections.emptySet());
     }
 
     /**
@@ -139,12 +175,12 @@ public GetRollupCapsResponse getRollupCapabilities(GetRollupCapsRequest request,
      * @param listener the listener to be notified upon request completion
      */
     public void getRollupCapabilitiesAsync(GetRollupCapsRequest request, RequestOptions options,
-                                           ActionListener<GetRollupCapsResponse> listener) {
+            ActionListener<GetRollupCapsResponse> listener) {
         restHighLevelClient.performRequestAsyncAndParseEntity(request,
-            RollupRequestConverters::getRollupCaps,
-            options,
-            GetRollupCapsResponse::fromXContent,
-            listener,
-            Collections.emptySet());
+                RollupRequestConverters::getRollupCaps,
+                options,
+                GetRollupCapsResponse::fromXContent,
+                listener,
+                Collections.emptySet());
     }
 }

client/rest-high-level/src/main/java/org/elasticsearch/client/RollupRequestConverters.java

@@ -19,10 +19,12 @@
 package org.elasticsearch.client;
 
 import org.apache.http.client.methods.HttpGet;
+import org.apache.http.client.methods.HttpPost;
 import org.apache.http.client.methods.HttpPut;
-import org.elasticsearch.client.rollup.GetRollupJobRequest;
 import org.elasticsearch.client.rollup.GetRollupCapsRequest;
+import org.elasticsearch.client.rollup.GetRollupJobRequest;
 import org.elasticsearch.client.rollup.PutRollupJobRequest;
+import org.elasticsearch.client.rollup.StartRollupJobRequest;
 
 import java.io.IOException;
 
@@ -36,33 +38,38 @@ private RollupRequestConverters() {
 
     static Request putJob(final PutRollupJobRequest putRollupJobRequest) throws IOException {
         String endpoint = new RequestConverters.EndpointBuilder()
-            .addPathPartAsIs("_xpack")
-            .addPathPartAsIs("rollup")
-            .addPathPartAsIs("job")
-            .addPathPart(putRollupJobRequest.getConfig().getId())
-            .build();
+                .addPathPartAsIs("_xpack", "rollup", "job")
+                .addPathPart(putRollupJobRequest.getConfig().getId())
+                .build();
         Request request = new Request(HttpPut.METHOD_NAME, endpoint);
         request.setEntity(createEntity(putRollupJobRequest, REQUEST_BODY_CONTENT_TYPE));
         return request;
     }
 
+    static Request startJob(final StartRollupJobRequest startRollupJobRequest) throws IOException {
+        String endpoint = new RequestConverters.EndpointBuilder()
+                .addPathPartAsIs("_xpack", "rollup", "job")
+                .addPathPart(startRollupJobRequest.getJobId())
+                .addPathPartAsIs("_start")
+                .build();
+        Request request = new Request(HttpPost.METHOD_NAME, endpoint);
+        return request;
+    }
+
     static Request getJob(final GetRollupJobRequest getRollupJobRequest) {
         String endpoint = new RequestConverters.EndpointBuilder()
-            .addPathPartAsIs("_xpack")
-            .addPathPartAsIs("rollup")
-            .addPathPartAsIs("job")
-            .addPathPart(getRollupJobRequest.getJobId())
-            .build();
+                .addPathPartAsIs("_xpack", "rollup", "job")
+                .addPathPart(getRollupJobRequest.getJobId())
+                .build();
         return new Request(HttpGet.METHOD_NAME, endpoint);
     }
 
+
     static Request getRollupCaps(final GetRollupCapsRequest getRollupCapsRequest) throws IOException {
         String endpoint = new RequestConverters.EndpointBuilder()
-            .addPathPartAsIs("_xpack")
-            .addPathPartAsIs("rollup")
-            .addPathPartAsIs("data")
-            .addPathPart(getRollupCapsRequest.getIndexPattern())
-            .build();
+                .addPathPartAsIs("_xpack", "rollup", "data")
+                .addPathPart(getRollupCapsRequest.getIndexPattern())
+                .build();
         Request request = new Request(HttpGet.METHOD_NAME, endpoint);
         request.setEntity(createEntity(getRollupCapsRequest, REQUEST_BODY_CONTENT_TYPE));
         return request;

client/rest-high-level/src/main/java/org/elasticsearch/client/rollup/AcknowledgedResponse.java

@@ -0,0 +1,86 @@
+/*
+ * Licensed to Elasticsearch under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.elasticsearch.client.rollup;
+
+import org.elasticsearch.common.ParseField;
+import org.elasticsearch.common.xcontent.ConstructingObjectParser;
+import org.elasticsearch.common.xcontent.ToXContent;
+import org.elasticsearch.common.xcontent.ToXContentObject;
+import org.elasticsearch.common.xcontent.XContentBuilder;
+
+import java.io.IOException;
+import java.util.Objects;
+import java.util.function.Function;
+
+import static org.elasticsearch.common.xcontent.ConstructingObjectParser.constructorArg;
+
+public abstract class AcknowledgedResponse implements ToXContentObject {
+
+    protected static final String PARSE_FIELD_NAME = "acknowledged";
+    private final boolean acknowledged;
+
+    public AcknowledgedResponse(final boolean acknowledged) {
+        this.acknowledged = acknowledged;
+    }
+
+    public boolean isAcknowledged() {
+        return acknowledged;
+    }
+
+    protected static <T> ConstructingObjectParser<T, Void> generateParser(String name, Function<Boolean, T> ctor, String parseField) {
+        ConstructingObjectParser<T, Void> p = new ConstructingObjectParser<>(name, true, args -> ctor.apply((boolean) args[0]));
+        p.declareBoolean(constructorArg(), new ParseField(parseField));
+        return p;
+    }
+
+    @Override
+    public boolean equals(Object o) {
+        if (this == o) {
+            return true;
+        }
+        if (o == null || getClass() != o.getClass()) {
+            return false;
+        }
+        final AcknowledgedResponse that = (AcknowledgedResponse) o;
+        return isAcknowledged() == that.isAcknowledged();
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hash(acknowledged);
+    }
+
+    @Override
+    public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws IOException {
+        builder.startObject();
+        {
+            builder.field(getFieldName(), isAcknowledged());
+        }
+        builder.endObject();
+        return builder;
+    }
+
+    /**
+     * @return the field name this response uses to output the acknowledged flag
+     */
+    protected String getFieldName() {
+        return PARSE_FIELD_NAME;
+    }
+}

client/rest-high-level/src/main/java/org/elasticsearch/client/rollup/PutRollupJobResponse.java

@@ -18,61 +18,20 @@
  */
 package org.elasticsearch.client.rollup;
 
-import org.elasticsearch.common.ParseField;
 import org.elasticsearch.common.xcontent.ConstructingObjectParser;
-import org.elasticsearch.common.xcontent.ToXContentObject;
-import org.elasticsearch.common.xcontent.XContentBuilder;
 import org.elasticsearch.common.xcontent.XContentParser;
 
 import java.io.IOException;
-import java.util.Objects;
 
-import static org.elasticsearch.common.xcontent.ConstructingObjectParser.constructorArg;
 
-public class PutRollupJobResponse implements ToXContentObject {
+public class PutRollupJobResponse extends AcknowledgedResponse {
 
-    private final boolean acknowledged;
-
-    public PutRollupJobResponse(final boolean acknowledged) {
-        this.acknowledged = acknowledged;
-    }
-
-    public boolean isAcknowledged() {
-        return acknowledged;
-    }
-
-    @Override
-    public boolean equals(Object o) {
-        if (this == o) {
-            return true;
-        }
-        if (o == null || getClass() != o.getClass()) {
-            return false;
-        }
-        final PutRollupJobResponse that = (PutRollupJobResponse) o;
-        return isAcknowledged() == that.isAcknowledged();
+    public PutRollupJobResponse(boolean acknowledged) {
+        super(acknowledged);
     }
 
-    @Override
-    public int hashCode() {
-        return Objects.hash(acknowledged);
-    }
-
-    @Override
-    public XContentBuilder toXContent(XContentBuilder builder, Params params) throws IOException {
-        builder.startObject();
-        {
-            builder.field("acknowledged", isAcknowledged());
-        }
-        builder.endObject();
-        return builder;
-    }
-
-    private static final ConstructingObjectParser<PutRollupJobResponse, Void> PARSER
-        = new ConstructingObjectParser<>("put_rollup_job_response", true, args -> new PutRollupJobResponse((boolean) args[0]));
-    static {
-        PARSER.declareBoolean(constructorArg(), new ParseField("acknowledged"));
-    }
+    private static final ConstructingObjectParser<PutRollupJobResponse, Void> PARSER = AcknowledgedResponse
+            .generateParser("delete_rollup_job_response", PutRollupJobResponse::new, AcknowledgedResponse.PARSE_FIELD_NAME);
 
     public static PutRollupJobResponse fromXContent(final XContentParser parser) throws IOException {
         return PARSER.parse(parser, null);