Skip to content

Commit 6c5dcbc

Browse files
committed
[API] Adds new experimental API connector_sync_job.get
1 parent 816e140 commit 6c5dcbc

File tree

2 files changed

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

2 files changed

+104
-0
lines changed
Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
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+
# Returns the details about a connector sync job.
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 [String] :connector_sync_job_id The unique identifier of the connector sync job to be returned.
32+
# @option arguments [Hash] :headers Custom HTTP headers
33+
#
34+
# @see https://www.elastic.co/guide/en/enterprise-search/current/connectors.html
35+
#
36+
def get(arguments = {})
37+
request_opts = { endpoint: arguments[:endpoint] || "connector_sync_job.get" }
38+
39+
defined_params = [:connector_sync_job_id].inject({}) do |set_variables, variable|
40+
set_variables[variable] = arguments[variable] if arguments.key?(variable)
41+
set_variables
42+
end
43+
request_opts[:defined_params] = defined_params unless defined_params.empty?
44+
45+
raise ArgumentError,
46+
"Required argument 'connector_sync_job_id' missing" unless arguments[:connector_sync_job_id]
47+
48+
arguments = arguments.clone
49+
headers = arguments.delete(:headers) || {}
50+
51+
body = nil
52+
53+
_connector_sync_job_id = arguments.delete(:connector_sync_job_id)
54+
55+
method = Elasticsearch::API::HTTP_GET
56+
path = "_connector/_sync_job/#{Utils.__listify(_connector_sync_job_id)}"
57+
params = {}
58+
59+
Elasticsearch::API::Response.new(
60+
perform_request(method, path, params, body, headers, request_opts)
61+
)
62+
end
63+
end
64+
end
65+
end
66+
end
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
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#get' do
21+
let(:expected_args) do
22+
[
23+
'GET',
24+
'_connector/_sync_job/foo',
25+
{},
26+
nil,
27+
{},
28+
{
29+
defined_params: {connector_sync_job_id: "foo"},
30+
endpoint: 'connector_sync_job.get'
31+
}
32+
]
33+
end
34+
35+
it 'performs the request' do
36+
expect(client_double.connector_sync_job.get(connector_sync_job_id: 'foo')).to be_a Elasticsearch::API::Response
37+
end
38+
end

0 commit comments

Comments
 (0)