Skip to content

Commit 816e140

Browse files
picandocodigopicandocodigo
committed
[API] Adds new experimental connector APIs
* last_sync * update_configuration * update_error
1 parent 5c0f4bf commit 816e140

File tree

6 files changed

+315
-0
lines changed

6 files changed

+315
-0
lines changed

‎elasticsearch-api/lib/elasticsearch/api/actions/connector/last_sync.rb

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
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 Connector
24+
module Actions
25+
# Updates the stats of last sync in the connector document.
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_id The unique identifier of the connector to be updated.
32+
# @option arguments [Hash] :headers Custom HTTP headers
33+
# @option arguments [Hash] :body Object with stats related to the last connector sync run. (*Required*)
34+
#
35+
# @see https://www.elastic.co/guide/en/enterprise-search/current/connectors.html
36+
#
37+
def last_sync(arguments = {})
38+
request_opts = { endpoint: arguments[:endpoint] || "connector.last_sync" }
39+
40+
defined_params = [:connector_id].inject({}) do |set_variables, variable|
41+
set_variables[variable] = arguments[variable] if arguments.key?(variable)
42+
set_variables
43+
end
44+
request_opts[:defined_params] = defined_params unless defined_params.empty?
45+
46+
raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
47+
raise ArgumentError, "Required argument 'connector_id' missing" unless arguments[:connector_id]
48+
49+
arguments = arguments.clone
50+
headers = arguments.delete(:headers) || {}
51+
52+
body = arguments.delete(:body)
53+
54+
_connector_id = arguments.delete(:connector_id)
55+
56+
method = Elasticsearch::API::HTTP_PUT
57+
path = "_connector/#{Utils.__listify(_connector_id)}/_last_sync"
58+
params = {}
59+
60+
Elasticsearch::API::Response.new(
61+
perform_request(method, path, params, body, headers, request_opts)
62+
)
63+
end
64+
end
65+
end
66+
end
67+
end

‎elasticsearch-api/lib/elasticsearch/api/actions/connector/update_configuration.rb

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
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 Connector
24+
module Actions
25+
# Updates the connector configuration.
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_id The unique identifier of the connector to be updated.
32+
# @option arguments [Hash] :headers Custom HTTP headers
33+
# @option arguments [Hash] :body Mapping between field names to configuration. (*Required*)
34+
#
35+
# @see https://www.elastic.co/guide/en/enterprise-search/current/connectors.html
36+
#
37+
def update_configuration(arguments = {})
38+
request_opts = { endpoint: arguments[:endpoint] || "connector.update_configuration" }
39+
40+
defined_params = [:connector_id].inject({}) do |set_variables, variable|
41+
set_variables[variable] = arguments[variable] if arguments.key?(variable)
42+
set_variables
43+
end
44+
request_opts[:defined_params] = defined_params unless defined_params.empty?
45+
46+
raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
47+
raise ArgumentError, "Required argument 'connector_id' missing" unless arguments[:connector_id]
48+
49+
arguments = arguments.clone
50+
headers = arguments.delete(:headers) || {}
51+
52+
body = arguments.delete(:body)
53+
54+
_connector_id = arguments.delete(:connector_id)
55+
56+
method = Elasticsearch::API::HTTP_PUT
57+
path = "_connector/#{Utils.__listify(_connector_id)}/_configuration"
58+
params = {}
59+
60+
Elasticsearch::API::Response.new(
61+
perform_request(method, path, params, body, headers, request_opts)
62+
)
63+
end
64+
end
65+
end
66+
end
67+
end

‎elasticsearch-api/lib/elasticsearch/api/actions/connector/update_error.rb

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
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 Connector
24+
module Actions
25+
# Updates the error field in the connector document.
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_id The unique identifier of the connector to be updated.
32+
# @option arguments [Hash] :headers Custom HTTP headers
33+
# @option arguments [Hash] :body An object containing the connector's error. (*Required*)
34+
#
35+
# @see https://www.elastic.co/guide/en/enterprise-search/current/connectors.html
36+
#
37+
def update_error(arguments = {})
38+
request_opts = { endpoint: arguments[:endpoint] || "connector.update_error" }
39+
40+
defined_params = [:connector_id].inject({}) do |set_variables, variable|
41+
set_variables[variable] = arguments[variable] if arguments.key?(variable)
42+
set_variables
43+
end
44+
request_opts[:defined_params] = defined_params unless defined_params.empty?
45+
46+
raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
47+
raise ArgumentError, "Required argument 'connector_id' missing" unless arguments[:connector_id]
48+
49+
arguments = arguments.clone
50+
headers = arguments.delete(:headers) || {}
51+
52+
body = arguments.delete(:body)
53+
54+
_connector_id = arguments.delete(:connector_id)
55+
56+
method = Elasticsearch::API::HTTP_PUT
57+
path = "_connector/#{Utils.__listify(_connector_id)}/_error"
58+
params = {}
59+
60+
Elasticsearch::API::Response.new(
61+
perform_request(method, path, params, body, headers, request_opts)
62+
)
63+
end
64+
end
65+
end
66+
end
67+
end

‎elasticsearch-api/spec/elasticsearch/api/actions/connector/last_sync_spec.rb

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#last_sync' do
21+
let(:expected_args) do
22+
[
23+
'PUT',
24+
'_connector/foo/_last_sync',
25+
{},
26+
{},
27+
{},
28+
{
29+
:defined_params=>{ connector_id: 'foo' },
30+
endpoint: 'connector.last_sync'
31+
}
32+
]
33+
end
34+
35+
it 'performs the request' do
36+
expect(client_double.connector.last_sync(connector_id: 'foo', body: {})).to be_a Elasticsearch::API::Response
37+
end
38+
end

‎elasticsearch-api/spec/elasticsearch/api/actions/connector/update_configuration_spec.rb

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#update_configuration' do
21+
let(:expected_args) do
22+
[
23+
'PUT',
24+
'_connector/foo/_configuration',
25+
{},
26+
{},
27+
{},
28+
{
29+
:defined_params=>{ connector_id: 'foo' },
30+
endpoint: 'connector.update_configuration'
31+
}
32+
]
33+
end
34+
35+
it 'performs the request' do
36+
expect(client_double.connector.update_configuration(body: {}, connector_id: 'foo')).to be_a Elasticsearch::API::Response
37+
end
38+
end

‎elasticsearch-api/spec/elasticsearch/api/actions/connector/update_error_spec.rb

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#update_error' do
21+
let(:expected_args) do
22+
[
23+
'PUT',
24+
'_connector/foo/_error',
25+
{},
26+
{},
27+
{},
28+
{
29+
:defined_params=>{ connector_id: 'foo' },
30+
endpoint: 'connector.update_error'
31+
}
32+
]
33+
end
34+
35+
it 'performs the request' do
36+
expect(client_double.connector.update_error(body: {}, connector_id: 'foo')).to be_a Elasticsearch::API::Response
37+
end
38+
end

0 commit comments

Comments
 (0)