Connector SyncJob API spec

specification/_doc_ids/table.csv

@@ -78,6 +78,11 @@ cluster-stats,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/c
 cluster-update-settings,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-update-settings.html
 cluster,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster.html
 common-options,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/common-options.html
+connector-sync-job-cancel,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cancel-connector-sync-job-api.html
+connector-sync-job-delete,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-connector-sync-job-api.html
+connector-sync-job-get,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-connector-sync-job-api.html
+connector-sync-job-post,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/create-connector-sync-job-api.html
+connector-sync-job-list,https://www.elastic.co/guide/en/elasticsearch/reference/{list}/list-connector-sync-jobs-api.html
 connector-checkin,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/check-in-connector-api.html
 connector-delete,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-connector-api.html
 connector-get,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-connector-api.html

specification/_json_spec/connector.sync_job_cancel.json

@@ -0,0 +1,27 @@
+{
+  "connector.sync_job_cancel": {
+    "documentation": {
+      "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cancel-connector-sync-job-api.html",
+      "description": "Cancels a connector sync job."
+    },
+    "stability": "experimental",
+    "visibility": "public",
+    "headers": {
+      "accept": ["application/json"]
+    },
+    "url": {
+      "paths": [
+        {
+          "path": "/_connector/_sync_job/{connector_sync_job_id}/_cancel",
+          "methods": ["PUT"],
+          "parts": {
+            "connector_sync_job_id": {
+              "type": "string",
+              "description": "The unique identifier of the connector sync job to be canceled"
+            }
+          }
+        }
+      ]
+    }
+  }
+}

specification/_json_spec/connector.sync_job_delete.json

@@ -0,0 +1,27 @@
+{
+  "connector.sync_job_delete": {
+    "documentation": {
+      "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-connector-sync-job-api.html",
+      "description": "Deletes a connector sync job."
+    },
+    "stability": "experimental",
+    "visibility": "public",
+    "headers": {
+      "accept": ["application/json"]
+    },
+    "url": {
+      "paths": [
+        {
+          "path": "/_connector/_sync_job/{connector_sync_job_id}",
+          "methods": ["DELETE"],
+          "parts": {
+            "connector_sync_job_id": {
+              "type": "string",
+              "description": "The unique identifier of the connector sync job to be deleted."
+            }
+          }
+        }
+      ]
+    }
+  }
+}

specification/_json_spec/connector.sync_job_get.json

@@ -0,0 +1,27 @@
+{
+  "connector.sync_job_get": {
+    "documentation": {
+      "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-connector-sync-job-api.html",
+      "description": "Returns the details about a connector sync job."
+    },
+    "stability": "experimental",
+    "visibility": "public",
+    "headers": {
+      "accept": ["application/json"]
+    },
+    "url": {
+      "paths": [
+        {
+          "path": "/_connector/_sync_job/{connector_sync_job_id}",
+          "methods": ["GET"],
+          "parts": {
+            "connector_sync_job_id": {
+              "type": "string",
+              "description": "The unique identifier of the connector sync job to be returned."
+            }
+          }
+        }
+      ]
+    }
+  }
+}

specification/_json_spec/connector.sync_job_list.json

@@ -0,0 +1,45 @@
+{
+  "connector.sync_job_list": {
+    "documentation": {
+      "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/list-connector-sync-jobs-api.html",
+      "description": "Lists all connector sync jobs."
+    },
+    "stability": "experimental",
+    "visibility": "public",
+    "headers": {
+      "accept": ["application/json"]
+    },
+    "url": {
+      "paths": [
+        {
+          "path": "/_connector/_sync_job",
+          "methods": ["GET"]
+        }
+      ]
+    },
+    "params": {
+      "from": {
+        "type": "int",
+        "default": 0,
+        "description": "Starting offset (default: 0)"
+      },
+      "size": {
+        "type": "int",
+        "default": 100,
+        "description": "specifies a max number of results to get (default: 100)"
+      },
+      "status": {
+        "type": "string",
+        "description": "Sync job status, which sync jobs are fetched for"
+      },
+      "connector_id": {
+        "type": "string",
+        "description": "Id of the connector to fetch the sync jobs for"
+      },
+      "job_type": {
+        "type": "list",
+        "description": "A comma-separated list of job types"
+      }
+    }
+  }
+}

specification/_json_spec/connector.sync_job_post.json

@@ -0,0 +1,26 @@
+{
+  "connector.sync_job_post": {
+    "documentation": {
+      "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/create-connector-sync-job-api.html",
+      "description": "Creates a connector sync job."
+    },
+    "stability": "experimental",
+    "visibility": "public",
+    "headers": {
+      "accept": ["application/json"],
+      "content_type": ["application/json"]
+    },
+    "url": {
+      "paths": [
+        {
+          "path": "/_connector/_sync_job",
+          "methods": ["POST"]
+        }
+      ]
+    },
+    "body": {
+      "description": "The connector sync job data.",
+      "required": true
+    }
+  }
+}

specification/connector/_types/SyncJob.ts

@@ -0,0 +1,71 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. 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.
+ */
+import { Id } from '@_types/common'
+import { long } from '@_types/Numeric'
+import { DateTime } from '@_types/Time'
+import { Dictionary } from '@spec_utils/Dictionary'
+import { UserDefinedValue } from '@spec_utils/UserDefinedValue'
+import {
+  ConnectorConfiguration,
+  FilteringConfig,
+  IngestPipelineParams,
+  SyncStatus
+} from './Connector'
+
+interface SyncJobConnectorReference {
+  configuration: ConnectorConfiguration
+  filtering: FilteringConfig
+  id: Id
+  index_name: string
+  language?: string
+  pipeline?: IngestPipelineParams
+  service_type: string
+}
+
+export enum SyncJobType {
+  full,
+  incremental,
+  access_control
+}
+
+export enum SyncJobTriggerMethod {
+  on_demand,
+  scheduled
+}
+
+export interface ConnectorSyncJob {
+  cancelation_requested_at?: DateTime
+  canceled_at?: DateTime
+  completed_at?: DateTime
+  connector: SyncJobConnectorReference
+  created_at: DateTime
+  deleted_document_count: long
+  error?: string
+  id: Id
+  indexed_document_count: long
+  indexed_document_volume: long
+  job_type: SyncJobType
+  last_seen?: DateTime
+  metadata: Dictionary<string, UserDefinedValue>
+  started_at?: DateTime
+  status: SyncStatus
+  total_document_count: long
+  trigger_method: SyncJobTriggerMethod
+  worker_hostname?: string
+}

specification/connector/sync_job_cancel/SyncJobCancelRequest.ts

@@ -0,0 +1,36 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. 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.
+ */
+import { RequestBase } from '@_types/Base'
+import { Id } from '@_types/common'
+
+/**
+ * Cancels a connector sync job.
+ * @rest_spec_name connector.sync_job_cancel
+ * @availability stack since=8.12.0 stability=experimental
+ * @availability serverless stability=experimental visibility=public
+ * @doc_id connector-sync-job-cancel
+ */
+export interface Request extends RequestBase {
+  path_parts: {
+    /**
+     * The unique identifier of the connector sync job
+     */
+    connector_sync_job_id: Id
+  }
+}