Skip to content

Commit 93466fe

Browse files
committed
[API] Adds search_application namespace and APIs
1 parent 9ad82a1 commit 93466fe

File tree

10 files changed

+403
-1
lines changed

10 files changed

+403
-1
lines changed

elasticsearch-api/lib/elasticsearch/api.rb

+2-1
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,8 @@ def self.included(base)
8181
Elasticsearch::API::Watcher,
8282
Elasticsearch::API::XPack,
8383
Elasticsearch::API::BehavioralAnalytics,
84-
Elasticsearch::API::DLM
84+
Elasticsearch::API::DLM,
85+
Elasticsearch::API::SearchApplication
8586
end
8687

8788
# The serializer class
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
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 SearchApplication
24+
module Actions
25+
# Deletes a search application.
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] :name The name of the search application
32+
# @option arguments [Hash] :headers Custom HTTP headers
33+
#
34+
# @see http://todo.com/tbd
35+
#
36+
def delete(arguments = {})
37+
raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
38+
39+
arguments = arguments.clone
40+
headers = arguments.delete(:headers) || {}
41+
42+
body = nil
43+
44+
_name = arguments.delete(:name)
45+
46+
method = Elasticsearch::API::HTTP_DELETE
47+
path = "_application/search_application/#{Utils.__listify(_name)}"
48+
params = {}
49+
50+
Elasticsearch::API::Response.new(
51+
perform_request(method, path, params, body, headers)
52+
)
53+
end
54+
end
55+
end
56+
end
57+
end
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
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 SearchApplication
24+
module Actions
25+
# Returns the details about a search application.
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] :name The name of the search application
32+
# @option arguments [Hash] :headers Custom HTTP headers
33+
#
34+
# @see http://todo.com/tbd
35+
#
36+
def get(arguments = {})
37+
raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
38+
39+
arguments = arguments.clone
40+
headers = arguments.delete(:headers) || {}
41+
42+
body = nil
43+
44+
_name = arguments.delete(:name)
45+
46+
method = Elasticsearch::API::HTTP_GET
47+
path = "_application/search_application/#{Utils.__listify(_name)}"
48+
params = {}
49+
50+
Elasticsearch::API::Response.new(
51+
perform_request(method, path, params, body, headers)
52+
)
53+
end
54+
end
55+
end
56+
end
57+
end
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
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 SearchApplication
24+
module Actions
25+
# Returns the existing search applications.
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] :q Query in the Lucene query string syntax
32+
# @option arguments [Integer] :from Starting offset (default: 0)
33+
# @option arguments [Integer] :size specifies a max number of results to get
34+
# @option arguments [Hash] :headers Custom HTTP headers
35+
#
36+
# @see http://todo.com/tbd
37+
#
38+
def list(arguments = {})
39+
arguments = arguments.clone
40+
headers = arguments.delete(:headers) || {}
41+
42+
body = nil
43+
44+
method = Elasticsearch::API::HTTP_GET
45+
path = "_application/search_application"
46+
params = Utils.process_params(arguments)
47+
48+
Elasticsearch::API::Response.new(
49+
perform_request(method, path, params, body, headers)
50+
)
51+
end
52+
end
53+
end
54+
end
55+
end
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
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 SearchApplication
24+
module Actions
25+
# Creates or updates a search application.
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] :name The name of the search application to be created or updated
32+
# @option arguments [Boolean] :create If true, requires that a search application with the specified resource_id does not already exist. (default: false)
33+
# @option arguments [Hash] :headers Custom HTTP headers
34+
# @option arguments [Hash] :body The search application configuration, including `indices` (*Required*)
35+
#
36+
# @see http://todo.com/tbd
37+
#
38+
def put(arguments = {})
39+
raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
40+
raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
41+
42+
arguments = arguments.clone
43+
headers = arguments.delete(:headers) || {}
44+
45+
body = arguments.delete(:body)
46+
47+
_name = arguments.delete(:name)
48+
49+
method = Elasticsearch::API::HTTP_PUT
50+
path = "_application/search_application/#{Utils.__listify(_name)}"
51+
params = Utils.process_params(arguments)
52+
53+
Elasticsearch::API::Response.new(
54+
perform_request(method, path, params, body, headers)
55+
)
56+
end
57+
end
58+
end
59+
end
60+
end
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
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+
module Elasticsearch
19+
module API
20+
module SearchApplication
21+
module Actions; end
22+
23+
# Client for the "searchable_snapshots" namespace (includes the {SearchableSnapshots::Actions} methods)
24+
#
25+
class SearchApplicationClient
26+
include Common::Client, Common::Client::Base, SearchApplication::Actions
27+
end
28+
29+
# Proxy method for {SearchApplicationClient}, available in the receiving object
30+
#
31+
def search_application
32+
@search_application ||= SearchApplicationClient.new(self)
33+
end
34+
end
35+
end
36+
end
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
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.search_application#delete' do
21+
let(:expected_args) do
22+
[
23+
'DELETE',
24+
'_application/search_application/foo',
25+
{},
26+
nil,
27+
{}
28+
]
29+
end
30+
31+
it 'performs the request' do
32+
expect(client_double.search_application.delete(name: 'foo')).to be_a Elasticsearch::API::Response
33+
end
34+
end
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
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.search_application#get' do
21+
let(:expected_args) do
22+
[
23+
'GET',
24+
'_application/search_application/foo',
25+
{},
26+
nil,
27+
{}
28+
]
29+
end
30+
31+
it 'performs the request' do
32+
expect(client_double.search_application.get(name: 'foo')).to be_a Elasticsearch::API::Response
33+
end
34+
end
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
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.search_application#list' do
21+
let(:expected_args) do
22+
[
23+
'GET',
24+
'_application/search_application',
25+
{},
26+
nil,
27+
{}
28+
]
29+
end
30+
31+
it 'performs the request' do
32+
expect(client_double.search_application.list).to be_a Elasticsearch::API::Response
33+
end
34+
end

0 commit comments

Comments
 (0)