[Connectors API] Unify update sync jobs API responses (#103403)

Unify the update sync jobs API responses by using ConnectorUpdateActionResponse instead of AcknowledgedResponse.

x-pack/plugin/ent-search/qa/rest/src/yamlRestTest/resources/rest-api-spec/test/entsearch/420_connector_sync_job_check_in.yml

@@ -34,7 +34,7 @@ setup:
       connector_sync_job.check_in:
         connector_sync_job_id: $sync-job-id-to-check-in
 
-  - match: { acknowledged: true }
+  - match: { result: updated }
 
   - do:
       connector_sync_job.get:

x-pack/plugin/ent-search/qa/rest/src/yamlRestTest/resources/rest-api-spec/test/entsearch/430_connector_sync_job_cancel.yml

@@ -27,7 +27,7 @@ setup:
       connector_sync_job.cancel:
         connector_sync_job_id: $sync-job-id-to-cancel
 
-  - match: { acknowledged: true }
+  - match: { result: updated }
 
   - do:
       connector_sync_job.get:

x-pack/plugin/ent-search/qa/rest/src/yamlRestTest/resources/rest-api-spec/test/entsearch/450_connector_sync_job_error.yml

@@ -29,7 +29,7 @@ setup:
         body:
           error: error
 
-  - match: { acknowledged: true }
+  - match: { result: updated }
 
   - do:
       connector_sync_job.get:

x-pack/plugin/ent-search/qa/rest/src/yamlRestTest/resources/rest-api-spec/test/entsearch/460_connector_sync_job_update_stats.yml

@@ -32,7 +32,7 @@ setup:
           indexed_document_count: 20
           indexed_document_volume: 1000
 
-  - match: { acknowledged: true }
+  - match: { result: updated }
 
   - do:
       connector_sync_job.get:
@@ -143,7 +143,7 @@ setup:
           indexed_document_volume: 1000
           total_document_count: 20
 
-  - match: { acknowledged: true }
+  - match: { result: updated }
 
   - do:
       connector_sync_job.get:
@@ -173,7 +173,7 @@ setup:
           indexed_document_volume: 1000
           last_seen: 2023-12-04T08:45:50.567149Z
 
-  - match: { acknowledged: true }
+  - match: { result: updated }
 
   - do:
       connector_sync_job.get:

x-pack/plugin/ent-search/src/main/java/org/elasticsearch/xpack/application/connector/action/ConnectorUpdateActionResponse.java

@@ -14,12 +14,14 @@ import org.elasticsearch.common.io.stream.StreamOutput;
 import org.elasticsearch.rest.RestStatus;
 import org.elasticsearch.xcontent.ToXContentObject;
 import org.elasticsearch.xcontent.XContentBuilder;
+import org.elasticsearch.xpack.application.connector.Connector;
+import org.elasticsearch.xpack.application.connector.syncjob.ConnectorSyncJob;
 
 import java.io.IOException;
 import java.util.Objects;
 
 /**
- * Represents a response for update actions related to connectors and sync jobs.
+ * Represents a response for update actions related to {@link Connector} and {@link ConnectorSyncJob}.
  * The response encapsulates the result of the update action, represented by a {@link DocWriteResponse.Result}.
  */
 public class ConnectorUpdateActionResponse extends ActionResponse implements ToXContentObject {

x-pack/plugin/ent-search/src/main/java/org/elasticsearch/xpack/application/connector/syncjob/action/CancelConnectorSyncJobAction.java

@@ -10,7 +10,6 @@ package org.elasticsearch.xpack.application.connector.syncjob.action;
 import org.elasticsearch.action.ActionRequest;
 import org.elasticsearch.action.ActionRequestValidationException;
 import org.elasticsearch.action.ActionType;
-import org.elasticsearch.action.support.master.AcknowledgedResponse;
 import org.elasticsearch.common.Strings;
 import org.elasticsearch.common.io.stream.StreamInput;
 import org.elasticsearch.common.io.stream.StreamOutput;
@@ -19,6 +18,7 @@ import org.elasticsearch.xcontent.ParseField;
 import org.elasticsearch.xcontent.ToXContentObject;
 import org.elasticsearch.xcontent.XContentBuilder;
 import org.elasticsearch.xcontent.XContentParser;
+import org.elasticsearch.xpack.application.connector.action.ConnectorUpdateActionResponse;
 
 import java.io.IOException;
 import java.util.Objects;
@@ -27,13 +27,13 @@ import static org.elasticsearch.action.ValidateActions.addValidationError;
 import static org.elasticsearch.xcontent.ConstructingObjectParser.constructorArg;
 import static org.elasticsearch.xpack.application.connector.syncjob.ConnectorSyncJobConstants.EMPTY_CONNECTOR_SYNC_JOB_ID_ERROR_MESSAGE;
 
-public class CancelConnectorSyncJobAction extends ActionType<AcknowledgedResponse> {
+public class CancelConnectorSyncJobAction extends ActionType<ConnectorUpdateActionResponse> {
 
     public static final CancelConnectorSyncJobAction INSTANCE = new CancelConnectorSyncJobAction();
     public static final String NAME = "cluster:admin/xpack/connector/sync_job/cancel";
 
     private CancelConnectorSyncJobAction() {
-        super(NAME, AcknowledgedResponse::readFrom);
+        super(NAME, ConnectorUpdateActionResponse::new);
     }
 
     public static class Request extends ActionRequest implements ToXContentObject {

x-pack/plugin/ent-search/src/main/java/org/elasticsearch/xpack/application/connector/syncjob/action/CheckInConnectorSyncJobAction.java

@@ -10,7 +10,6 @@ package org.elasticsearch.xpack.application.connector.syncjob.action;
 import org.elasticsearch.action.ActionRequest;
 import org.elasticsearch.action.ActionRequestValidationException;
 import org.elasticsearch.action.ActionType;
-import org.elasticsearch.action.support.master.AcknowledgedResponse;
 import org.elasticsearch.common.Strings;
 import org.elasticsearch.common.io.stream.StreamInput;
 import org.elasticsearch.common.io.stream.StreamOutput;
@@ -19,6 +18,7 @@ import org.elasticsearch.xcontent.ParseField;
 import org.elasticsearch.xcontent.ToXContentObject;
 import org.elasticsearch.xcontent.XContentBuilder;
 import org.elasticsearch.xcontent.XContentParser;
+import org.elasticsearch.xpack.application.connector.action.ConnectorUpdateActionResponse;
 import org.elasticsearch.xpack.application.connector.syncjob.ConnectorSyncJobConstants;
 
 import java.io.IOException;
@@ -27,13 +27,13 @@ import java.util.Objects;
 import static org.elasticsearch.action.ValidateActions.addValidationError;
 import static org.elasticsearch.xcontent.ConstructingObjectParser.constructorArg;
 
-public class CheckInConnectorSyncJobAction extends ActionType<AcknowledgedResponse> {
+public class CheckInConnectorSyncJobAction extends ActionType<ConnectorUpdateActionResponse> {
 
     public static final CheckInConnectorSyncJobAction INSTANCE = new CheckInConnectorSyncJobAction();
     public static final String NAME = "cluster:admin/xpack/connector/sync_job/check_in";
 
     private CheckInConnectorSyncJobAction() {
-        super(NAME, AcknowledgedResponse::readFrom);
+        super(NAME, ConnectorUpdateActionResponse::new);
     }
 
     public static class Request extends ActionRequest implements ToXContentObject {

x-pack/plugin/ent-search/src/main/java/org/elasticsearch/xpack/application/connector/syncjob/action/RestCancelConnectorSyncJobAction.java

@@ -12,6 +12,7 @@ import org.elasticsearch.rest.BaseRestHandler;
 import org.elasticsearch.rest.RestRequest;
 import org.elasticsearch.rest.action.RestToXContentListener;
 import org.elasticsearch.xpack.application.EnterpriseSearch;
+import org.elasticsearch.xpack.application.connector.action.ConnectorUpdateActionResponse;
 
 import java.io.IOException;
 import java.util.List;
@@ -42,6 +43,10 @@ public class RestCancelConnectorSyncJobAction extends BaseRestHandler {
         CancelConnectorSyncJobAction.Request request = new CancelConnectorSyncJobAction.Request(
             restRequest.param(CONNECTOR_SYNC_JOB_ID_PARAM)
         );
-        return restChannel -> client.execute(CancelConnectorSyncJobAction.INSTANCE, request, new RestToXContentListener<>(restChannel));
+        return restChannel -> client.execute(
+            CancelConnectorSyncJobAction.INSTANCE,
+            request,
+            new RestToXContentListener<>(restChannel, ConnectorUpdateActionResponse::status)
+        );
     }
 }

x-pack/plugin/ent-search/src/main/java/org/elasticsearch/xpack/application/connector/syncjob/action/RestCheckInConnectorSyncJobAction.java

@@ -12,6 +12,7 @@ import org.elasticsearch.rest.BaseRestHandler;
 import org.elasticsearch.rest.RestRequest;
 import org.elasticsearch.rest.action.RestToXContentListener;
 import org.elasticsearch.xpack.application.EnterpriseSearch;
+import org.elasticsearch.xpack.application.connector.action.ConnectorUpdateActionResponse;
 
 import java.io.IOException;
 import java.util.List;
@@ -41,6 +42,10 @@ public class RestCheckInConnectorSyncJobAction extends BaseRestHandler {
             restRequest.param(CONNECTOR_SYNC_JOB_ID_PARAM)
         );
 
-        return restChannel -> client.execute(CheckInConnectorSyncJobAction.INSTANCE, request, new RestToXContentListener<>(restChannel));
+        return restChannel -> client.execute(
+            CheckInConnectorSyncJobAction.INSTANCE,
+            request,
+            new RestToXContentListener<>(restChannel, ConnectorUpdateActionResponse::status)
+        );
     }
 }

x-pack/plugin/ent-search/src/main/java/org/elasticsearch/xpack/application/connector/syncjob/action/RestUpdateConnectorSyncJobErrorAction.java

@@ -12,6 +12,7 @@ import org.elasticsearch.rest.BaseRestHandler;
 import org.elasticsearch.rest.RestRequest;
 import org.elasticsearch.rest.action.RestToXContentListener;
 import org.elasticsearch.xpack.application.EnterpriseSearch;
+import org.elasticsearch.xpack.application.connector.action.ConnectorUpdateActionResponse;
 
 import java.io.IOException;
 import java.util.List;
@@ -46,7 +47,7 @@ public class RestUpdateConnectorSyncJobErrorAction extends BaseRestHandler {
         return restChannel -> client.execute(
             UpdateConnectorSyncJobErrorAction.INSTANCE,
             request,
-            new RestToXContentListener<>(restChannel)
+            new RestToXContentListener<>(restChannel, ConnectorUpdateActionResponse::status)
         );
     }
 }

x-pack/plugin/ent-search/src/main/java/org/elasticsearch/xpack/application/connector/syncjob/action/RestUpdateConnectorSyncJobIngestionStatsAction.java

@@ -10,9 +10,9 @@ package org.elasticsearch.xpack.application.connector.syncjob.action;
 import org.elasticsearch.client.internal.node.NodeClient;
 import org.elasticsearch.rest.BaseRestHandler;
 import org.elasticsearch.rest.RestRequest;
-import org.elasticsearch.rest.RestStatus;
 import org.elasticsearch.rest.action.RestToXContentListener;
 import org.elasticsearch.xpack.application.EnterpriseSearch;
+import org.elasticsearch.xpack.application.connector.action.ConnectorUpdateActionResponse;
 
 import java.io.IOException;
 import java.util.List;
@@ -46,7 +46,7 @@ public class RestUpdateConnectorSyncJobIngestionStatsAction extends BaseRestHand
         return channel -> client.execute(
             UpdateConnectorSyncJobIngestionStatsAction.INSTANCE,
             request,
-            new RestToXContentListener<>(channel, r -> RestStatus.OK)
+            new RestToXContentListener<>(channel, ConnectorUpdateActionResponse::status)
         );
     }
 }

x-pack/plugin/ent-search/src/main/java/org/elasticsearch/xpack/application/connector/syncjob/action/TransportCancelConnectorSyncJobAction.java

@@ -10,18 +10,18 @@ package org.elasticsearch.xpack.application.connector.syncjob.action;
 import org.elasticsearch.action.ActionListener;
 import org.elasticsearch.action.support.ActionFilters;
 import org.elasticsearch.action.support.HandledTransportAction;
-import org.elasticsearch.action.support.master.AcknowledgedResponse;
 import org.elasticsearch.client.internal.Client;
 import org.elasticsearch.cluster.service.ClusterService;
 import org.elasticsearch.common.inject.Inject;
 import org.elasticsearch.common.util.concurrent.EsExecutors;
 import org.elasticsearch.tasks.Task;
 import org.elasticsearch.transport.TransportService;
+import org.elasticsearch.xpack.application.connector.action.ConnectorUpdateActionResponse;
 import org.elasticsearch.xpack.application.connector.syncjob.ConnectorSyncJobIndexService;
 
 public class TransportCancelConnectorSyncJobAction extends HandledTransportAction<
     CancelConnectorSyncJobAction.Request,
-    AcknowledgedResponse> {
+    ConnectorUpdateActionResponse> {
 
     protected ConnectorSyncJobIndexService connectorSyncJobIndexService;
 
@@ -43,7 +43,14 @@ public class TransportCancelConnectorSyncJobAction extends HandledTransportActio
     }
 
     @Override
-    protected void doExecute(Task task, CancelConnectorSyncJobAction.Request request, ActionListener<AcknowledgedResponse> listener) {
-        connectorSyncJobIndexService.cancelConnectorSyncJob(request.getConnectorSyncJobId(), listener.map(r -> AcknowledgedResponse.TRUE));
+    protected void doExecute(
+        Task task,
+        CancelConnectorSyncJobAction.Request request,
+        ActionListener<ConnectorUpdateActionResponse> listener
+    ) {
+        connectorSyncJobIndexService.cancelConnectorSyncJob(
+            request.getConnectorSyncJobId(),
+            listener.map(r -> new ConnectorUpdateActionResponse(r.getResult()))
+        );
     }
 }

x-pack/plugin/ent-search/src/main/java/org/elasticsearch/xpack/application/connector/syncjob/action/TransportCheckInConnectorSyncJobAction.java

@@ -10,18 +10,18 @@ package org.elasticsearch.xpack.application.connector.syncjob.action;
 import org.elasticsearch.action.ActionListener;
 import org.elasticsearch.action.support.ActionFilters;
 import org.elasticsearch.action.support.HandledTransportAction;
-import org.elasticsearch.action.support.master.AcknowledgedResponse;
 import org.elasticsearch.client.internal.Client;
 import org.elasticsearch.cluster.service.ClusterService;
 import org.elasticsearch.common.inject.Inject;
 import org.elasticsearch.common.util.concurrent.EsExecutors;
 import org.elasticsearch.tasks.Task;
 import org.elasticsearch.transport.TransportService;
+import org.elasticsearch.xpack.application.connector.action.ConnectorUpdateActionResponse;
 import org.elasticsearch.xpack.application.connector.syncjob.ConnectorSyncJobIndexService;
 
 public class TransportCheckInConnectorSyncJobAction extends HandledTransportAction<
     CheckInConnectorSyncJobAction.Request,
-    AcknowledgedResponse> {
+    ConnectorUpdateActionResponse> {
 
     protected final ConnectorSyncJobIndexService connectorSyncJobIndexService;
 
@@ -43,7 +43,14 @@ public class TransportCheckInConnectorSyncJobAction extends HandledTransportActi
     }
 
     @Override
-    protected void doExecute(Task task, CheckInConnectorSyncJobAction.Request request, ActionListener<AcknowledgedResponse> listener) {
-        connectorSyncJobIndexService.checkInConnectorSyncJob(request.getConnectorSyncJobId(), listener.map(r -> AcknowledgedResponse.TRUE));
+    protected void doExecute(
+        Task task,
+        CheckInConnectorSyncJobAction.Request request,
+        ActionListener<ConnectorUpdateActionResponse> listener
+    ) {
+        connectorSyncJobIndexService.checkInConnectorSyncJob(
+            request.getConnectorSyncJobId(),
+            listener.map(r -> new ConnectorUpdateActionResponse(r.getResult()))
+        );
     }
 }

x-pack/plugin/ent-search/src/main/java/org/elasticsearch/xpack/application/connector/syncjob/action/TransportUpdateConnectorSyncJobErrorAction.java

@@ -10,18 +10,18 @@ package org.elasticsearch.xpack.application.connector.syncjob.action;
 import org.elasticsearch.action.ActionListener;
 import org.elasticsearch.action.support.ActionFilters;
 import org.elasticsearch.action.support.HandledTransportAction;
-import org.elasticsearch.action.support.master.AcknowledgedResponse;
 import org.elasticsearch.client.internal.Client;
 import org.elasticsearch.cluster.service.ClusterService;
 import org.elasticsearch.common.inject.Inject;
 import org.elasticsearch.common.util.concurrent.EsExecutors;
 import org.elasticsearch.tasks.Task;
 import org.elasticsearch.transport.TransportService;
+import org.elasticsearch.xpack.application.connector.action.ConnectorUpdateActionResponse;
 import org.elasticsearch.xpack.application.connector.syncjob.ConnectorSyncJobIndexService;
 
 public class TransportUpdateConnectorSyncJobErrorAction extends HandledTransportAction<
     UpdateConnectorSyncJobErrorAction.Request,
-    AcknowledgedResponse> {
+    ConnectorUpdateActionResponse> {
 
     protected final ConnectorSyncJobIndexService connectorSyncJobIndexService;
 
@@ -43,11 +43,15 @@ public class TransportUpdateConnectorSyncJobErrorAction extends HandledTransport
     }
 
     @Override
-    protected void doExecute(Task task, UpdateConnectorSyncJobErrorAction.Request request, ActionListener<AcknowledgedResponse> listener) {
+    protected void doExecute(
+        Task task,
+        UpdateConnectorSyncJobErrorAction.Request request,
+        ActionListener<ConnectorUpdateActionResponse> listener
+    ) {
         connectorSyncJobIndexService.updateConnectorSyncJobError(
             request.getConnectorSyncJobId(),
             request.getError(),
-            listener.map(r -> AcknowledgedResponse.TRUE)
+            listener.map(r -> new ConnectorUpdateActionResponse(r.getResult()))
         );
     }
 }

x-pack/plugin/ent-search/src/main/java/org/elasticsearch/xpack/application/connector/syncjob/action/TransportUpdateConnectorSyncJobIngestionStatsAction.java

@@ -10,18 +10,18 @@ package org.elasticsearch.xpack.application.connector.syncjob.action;
 import org.elasticsearch.action.ActionListener;
 import org.elasticsearch.action.support.ActionFilters;
 import org.elasticsearch.action.support.HandledTransportAction;
-import org.elasticsearch.action.support.master.AcknowledgedResponse;
 import org.elasticsearch.client.internal.Client;
 import org.elasticsearch.cluster.service.ClusterService;
 import org.elasticsearch.common.inject.Inject;
 import org.elasticsearch.common.util.concurrent.EsExecutors;
 import org.elasticsearch.tasks.Task;
 import org.elasticsearch.transport.TransportService;
+import org.elasticsearch.xpack.application.connector.action.ConnectorUpdateActionResponse;
 import org.elasticsearch.xpack.application.connector.syncjob.ConnectorSyncJobIndexService;
 
 public class TransportUpdateConnectorSyncJobIngestionStatsAction extends HandledTransportAction<
     UpdateConnectorSyncJobIngestionStatsAction.Request,
-    AcknowledgedResponse> {
+    ConnectorUpdateActionResponse> {
 
     protected final ConnectorSyncJobIndexService connectorSyncJobIndexService;
 
@@ -46,8 +46,11 @@ public class TransportUpdateConnectorSyncJobIngestionStatsAction extends Handled
     protected void doExecute(
         Task task,
         UpdateConnectorSyncJobIngestionStatsAction.Request request,
-        ActionListener<AcknowledgedResponse> listener
+        ActionListener<ConnectorUpdateActionResponse> listener
     ) {
-        connectorSyncJobIndexService.updateConnectorSyncJobIngestionStats(request, listener.map(r -> AcknowledgedResponse.TRUE));
+        connectorSyncJobIndexService.updateConnectorSyncJobIngestionStats(
+            request,
+            listener.map(r -> new ConnectorUpdateActionResponse(r.getResult()))
+        );
     }
 }

x-pack/plugin/ent-search/src/main/java/org/elasticsearch/xpack/application/connector/syncjob/action/UpdateConnectorSyncJobErrorAction.java

@@ -11,7 +11,6 @@ import org.elasticsearch.ElasticsearchParseException;
 import org.elasticsearch.action.ActionRequest;
 import org.elasticsearch.action.ActionRequestValidationException;
 import org.elasticsearch.action.ActionType;
-import org.elasticsearch.action.support.master.AcknowledgedResponse;
 import org.elasticsearch.common.Strings;
 import org.elasticsearch.common.bytes.BytesReference;
 import org.elasticsearch.common.io.stream.StreamInput;
@@ -23,6 +22,7 @@ import org.elasticsearch.xcontent.XContentBuilder;
 import org.elasticsearch.xcontent.XContentParser;
 import org.elasticsearch.xcontent.XContentParserConfiguration;
 import org.elasticsearch.xcontent.XContentType;
+import org.elasticsearch.xpack.application.connector.action.ConnectorUpdateActionResponse;
 import org.elasticsearch.xpack.application.connector.syncjob.ConnectorSyncJob;
 import org.elasticsearch.xpack.application.connector.syncjob.ConnectorSyncJobConstants;
 
@@ -32,14 +32,14 @@ import java.util.Objects;
 import static org.elasticsearch.action.ValidateActions.addValidationError;
 import static org.elasticsearch.xcontent.ConstructingObjectParser.constructorArg;
 
-public class UpdateConnectorSyncJobErrorAction extends ActionType<AcknowledgedResponse> {
+public class UpdateConnectorSyncJobErrorAction extends ActionType<ConnectorUpdateActionResponse> {
 
     public static final UpdateConnectorSyncJobErrorAction INSTANCE = new UpdateConnectorSyncJobErrorAction();
     public static final String NAME = "cluster:admin/xpack/connector/sync_job/update_error";
     public static final String ERROR_EMPTY_MESSAGE = "[error] of the connector sync job cannot be null or empty";
 
     private UpdateConnectorSyncJobErrorAction() {
-        super(NAME, AcknowledgedResponse::readFrom);
+        super(NAME, ConnectorUpdateActionResponse::new);
     }
 
     public static class Request extends ActionRequest implements ToXContentObject {

x-pack/plugin/ent-search/src/main/java/org/elasticsearch/xpack/application/connector/syncjob/action/UpdateConnectorSyncJobIngestionStatsAction.java

@@ -11,7 +11,6 @@ import org.elasticsearch.ElasticsearchParseException;
 import org.elasticsearch.action.ActionRequest;
 import org.elasticsearch.action.ActionRequestValidationException;
 import org.elasticsearch.action.ActionType;
-import org.elasticsearch.action.support.master.AcknowledgedResponse;
 import org.elasticsearch.common.Strings;
 import org.elasticsearch.common.bytes.BytesReference;
 import org.elasticsearch.common.io.stream.StreamInput;
@@ -25,6 +24,7 @@ import org.elasticsearch.xcontent.XContentBuilder;
 import org.elasticsearch.xcontent.XContentParser;
 import org.elasticsearch.xcontent.XContentParserConfiguration;
 import org.elasticsearch.xcontent.XContentType;
+import org.elasticsearch.xpack.application.connector.action.ConnectorUpdateActionResponse;
 import org.elasticsearch.xpack.application.connector.syncjob.ConnectorSyncJob;
 
 import java.io.IOException;
@@ -36,13 +36,13 @@ import static org.elasticsearch.xcontent.ConstructingObjectParser.constructorArg
 import static org.elasticsearch.xcontent.ConstructingObjectParser.optionalConstructorArg;
 import static org.elasticsearch.xpack.application.connector.syncjob.ConnectorSyncJobConstants.EMPTY_CONNECTOR_SYNC_JOB_ID_ERROR_MESSAGE;
 
-public class UpdateConnectorSyncJobIngestionStatsAction extends ActionType<AcknowledgedResponse> {
+public class UpdateConnectorSyncJobIngestionStatsAction extends ActionType<ConnectorUpdateActionResponse> {
 
     public static final UpdateConnectorSyncJobIngestionStatsAction INSTANCE = new UpdateConnectorSyncJobIngestionStatsAction();
     public static final String NAME = "cluster:admin/xpack/connector/sync_job/update_stats";
 
     public UpdateConnectorSyncJobIngestionStatsAction() {
-        super(NAME, AcknowledgedResponse::readFrom);
+        super(NAME, ConnectorUpdateActionResponse::new);
     }
 
     public static class Request extends ActionRequest implements ToXContentObject {