Skip to content

Commit ea76729

Browse files
committed
[API] Adds query_rule get and delete endpoints
1 parent d13dfe3 commit ea76729

File tree

4 files changed

+206
-0
lines changed

4 files changed

+206
-0
lines changed
Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
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 QueryRule
24+
module Actions
25+
# Deletes an individual query rule within a ruleset.
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] :ruleset_id The unique identifier of the query ruleset this rule exists in
32+
# @option arguments [String] :rule_id The unique identifier of the rule to delete.
33+
# @option arguments [Hash] :headers Custom HTTP headers
34+
#
35+
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-query-rule.html
36+
#
37+
def delete(arguments = {})
38+
request_opts = { endpoint: arguments[:endpoint] || 'query_rule.delete' }
39+
40+
defined_params = %i[ruleset_id rule_id].each_with_object({}) do |variable, set_variables|
41+
set_variables[variable] = arguments[variable] if arguments.key?(variable)
42+
end
43+
request_opts[:defined_params] = defined_params unless defined_params.empty?
44+
45+
raise ArgumentError, "Required argument 'ruleset_id' missing" unless arguments[:ruleset_id]
46+
raise ArgumentError, "Required argument 'rule_id' missing" unless arguments[:rule_id]
47+
48+
arguments = arguments.clone
49+
headers = arguments.delete(:headers) || {}
50+
51+
body = nil
52+
53+
_ruleset_id = arguments.delete(:ruleset_id)
54+
55+
_rule_id = arguments.delete(:rule_id)
56+
57+
method = Elasticsearch::API::HTTP_DELETE
58+
path = "_query_rules/#{Utils.__listify(_ruleset_id)}/_rule/#{Utils.__listify(_rule_id)}"
59+
params = {}
60+
61+
Elasticsearch::API::Response.new(
62+
perform_request(method, path, params, body, headers, request_opts)
63+
)
64+
end
65+
end
66+
end
67+
end
68+
end
Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
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 QueryRule
24+
module Actions
25+
# Returns the details about an individual query rule within a ruleset.
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] :ruleset_id The unique identifier of the query ruleset the rule exists within
32+
# @option arguments [String] :rule_id The unique identifier of the rule to be retrieved.
33+
# @option arguments [Hash] :headers Custom HTTP headers
34+
#
35+
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/get-query-rule.html
36+
#
37+
def get(arguments = {})
38+
request_opts = { endpoint: arguments[:endpoint] || 'query_rule.get' }
39+
40+
defined_params = %i[ruleset_id rule_id].each_with_object({}) do |variable, set_variables|
41+
set_variables[variable] = arguments[variable] if arguments.key?(variable)
42+
end
43+
request_opts[:defined_params] = defined_params unless defined_params.empty?
44+
45+
raise ArgumentError, "Required argument 'ruleset_id' missing" unless arguments[:ruleset_id]
46+
raise ArgumentError, "Required argument 'rule_id' missing" unless arguments[:rule_id]
47+
48+
arguments = arguments.clone
49+
headers = arguments.delete(:headers) || {}
50+
51+
body = nil
52+
53+
_ruleset_id = arguments.delete(:ruleset_id)
54+
55+
_rule_id = arguments.delete(:rule_id)
56+
57+
method = Elasticsearch::API::HTTP_GET
58+
path = "_query_rules/#{Utils.__listify(_ruleset_id)}/_rule/#{Utils.__listify(_rule_id)}"
59+
params = {}
60+
61+
Elasticsearch::API::Response.new(
62+
perform_request(method, path, params, body, headers, request_opts)
63+
)
64+
end
65+
end
66+
end
67+
end
68+
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.query_rule#delete' do
21+
let(:expected_args) do
22+
[
23+
'DELETE',
24+
'_query_rules/foo/_rule/bar',
25+
{},
26+
nil,
27+
{},
28+
{ defined_params: { rule_id: 'bar', ruleset_id: 'foo' }, endpoint: 'query_rule.delete' }
29+
]
30+
end
31+
32+
it 'performs the request' do
33+
expect(client_double.query_rule.delete(ruleset_id: 'foo', rule_id: 'bar')).to be_a Elasticsearch::API::Response
34+
end
35+
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.query_rule#get' do
21+
let(:expected_args) do
22+
[
23+
'GET',
24+
'_query_rules/foo/_rule/bar',
25+
{},
26+
nil,
27+
{},
28+
{ defined_params: { rule_id: 'bar', ruleset_id: 'foo' }, endpoint: 'query_rule.get' }
29+
]
30+
end
31+
32+
it 'performs the request' do
33+
expect(client_double.query_rule.get(ruleset_id: 'foo', rule_id: 'bar')).to be_a Elasticsearch::API::Response
34+
end
35+
end

0 commit comments

Comments
 (0)