Skip to content

Commit 2e75c02

Browse files
committed
[API] Adds experimental connector_sync_job.list endpoint
1 parent d819465 commit 2e75c02

File tree

2 files changed

+93
-0
lines changed
  • elasticsearch-api
    • lib/elasticsearch/api/actions/connector_sync_job
    • spec/elasticsearch/api/actions/connector_sync_job

2 files changed

+93
-0
lines changed
Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# Licensed to Elasticsearch B.V. under one or more contributor
2+
# license agreements. See the NOTICE file distributed with
3+
# this work for additional information regarding copyright
4+
# ownership. Elasticsearch B.V. licenses this file to you under
5+
# the Apache License, Version 2.0 (the "License"); you may
6+
# not use this file except in compliance with the License.
7+
# You may obtain a copy of the License at
8+
#
9+
# http://www.apache.org/licenses/LICENSE-2.0
10+
#
11+
# Unless required by applicable law or agreed to in writing,
12+
# software distributed under the License is distributed on an
13+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14+
# KIND, either express or implied. See the License for the
15+
# specific language governing permissions and limitations
16+
# under the License.
17+
#
18+
# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
19+
# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
20+
#
21+
module Elasticsearch
22+
module API
23+
module ConnectorSyncJob
24+
module Actions
25+
# Lists all connector sync jobs.
26+
# This functionality is Experimental and may be changed or removed
27+
# completely in a future release. Elastic will take a best effort approach
28+
# to fix any issues, but experimental features are not subject to the
29+
# support SLA of official GA features.
30+
#
31+
# @option arguments [Integer] :from Starting offset (default: 0)
32+
# @option arguments [Integer] :size specifies a max number of results to get (default: 100)
33+
# @option arguments [String] :status Sync job status, which sync jobs are fetched for
34+
# @option arguments [String] :connector_id Id of the connector to fetch the sync jobs for
35+
# @option arguments [Hash] :headers Custom HTTP headers
36+
#
37+
# @see https://www.elastic.co/guide/en/enterprise-search/current/connectors.html
38+
#
39+
def list(arguments = {})
40+
request_opts = { endpoint: arguments[:endpoint] || "connector_sync_job.list" }
41+
42+
arguments = arguments.clone
43+
headers = arguments.delete(:headers) || {}
44+
45+
body = nil
46+
47+
method = Elasticsearch::API::HTTP_GET
48+
path = "_connector/_sync_job"
49+
params = Utils.process_params(arguments)
50+
51+
Elasticsearch::API::Response.new(
52+
perform_request(method, path, params, body, headers, request_opts)
53+
)
54+
end
55+
end
56+
end
57+
end
58+
end
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Licensed to Elasticsearch B.V. under one or more contributor
2+
# license agreements. See the NOTICE file distributed with
3+
# this work for additional information regarding copyright
4+
# ownership. Elasticsearch B.V. licenses this file to you under
5+
# the Apache License, Version 2.0 (the "License"); you may
6+
# not use this file except in compliance with the License.
7+
# You may obtain a copy of the License at
8+
#
9+
# http://www.apache.org/licenses/LICENSE-2.0
10+
#
11+
# Unless required by applicable law or agreed to in writing,
12+
# software distributed under the License is distributed on an
13+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14+
# KIND, either express or implied. See the License for the
15+
# specific language governing permissions and limitations
16+
# under the License.
17+
18+
require 'spec_helper'
19+
20+
describe 'client.connector_sync_job#list' do
21+
let(:expected_args) do
22+
[
23+
'GET',
24+
'_connector/_sync_job',
25+
{},
26+
nil,
27+
{},
28+
{ endpoint: 'connector_sync_job.list' }
29+
]
30+
end
31+
32+
it 'performs the request' do
33+
expect(client_double.connector_sync_job.list).to be_a Elasticsearch::API::Response
34+
end
35+
end

0 commit comments

Comments
 (0)