Skip to content

Commit 3e7c321

Browse files
picandocodigopicandocodigo
committed
[API] Adds indices data stream options endpoints
1 parent 59e3768 commit 3e7c321

File tree

6 files changed

+298
-0
lines changed

6 files changed

+298
-0
lines changed

‎elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_data_stream_options.rb

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
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 Indices
24+
module Actions
25+
# Deletes the data stream options of the selected data streams.
26+
#
27+
# @option arguments [List] :name A comma-separated list of data streams of which the data stream options will be deleted; use `*` to get all data streams
28+
# @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all)
29+
# @option arguments [Time] :timeout Explicit timestamp for the document
30+
# @option arguments [Time] :master_timeout Specify timeout for connection to master
31+
# @option arguments [Hash] :headers Custom HTTP headers
32+
#
33+
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.18/index.html
34+
#
35+
def delete_data_stream_options(arguments = {})
36+
request_opts = { endpoint: arguments[:endpoint] || 'indices.delete_data_stream_options' }
37+
38+
defined_params = [:name].each_with_object({}) do |variable, set_variables|
39+
set_variables[variable] = arguments[variable] if arguments.key?(variable)
40+
end
41+
request_opts[:defined_params] = defined_params unless defined_params.empty?
42+
43+
raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
44+
45+
arguments = arguments.clone
46+
headers = arguments.delete(:headers) || {}
47+
48+
body = nil
49+
50+
_name = arguments.delete(:name)
51+
52+
method = Elasticsearch::API::HTTP_DELETE
53+
path = "_data_stream/#{Utils.__listify(_name)}/_options"
54+
params = Utils.process_params(arguments)
55+
56+
Elasticsearch::API::Response.new(
57+
perform_request(method, path, params, body, headers, request_opts)
58+
)
59+
end
60+
end
61+
end
62+
end
63+
end

‎elasticsearch-api/lib/elasticsearch/api/actions/indices/get_data_stream_options.rb

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
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 Indices
24+
module Actions
25+
# Returns the data stream options of the selected data streams.
26+
#
27+
# @option arguments [List] :name A comma-separated list of data streams to get; use `*` to get all data streams
28+
# @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all)
29+
# @option arguments [Time] :master_timeout Specify timeout for connection to master
30+
# @option arguments [Hash] :headers Custom HTTP headers
31+
#
32+
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.18/index.html
33+
#
34+
def get_data_stream_options(arguments = {})
35+
request_opts = { endpoint: arguments[:endpoint] || 'indices.get_data_stream_options' }
36+
37+
defined_params = [:name].each_with_object({}) do |variable, set_variables|
38+
set_variables[variable] = arguments[variable] if arguments.key?(variable)
39+
end
40+
request_opts[:defined_params] = defined_params unless defined_params.empty?
41+
42+
raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
43+
44+
arguments = arguments.clone
45+
headers = arguments.delete(:headers) || {}
46+
47+
body = nil
48+
49+
_name = arguments.delete(:name)
50+
51+
method = Elasticsearch::API::HTTP_GET
52+
path = "_data_stream/#{Utils.__listify(_name)}/_options"
53+
params = Utils.process_params(arguments)
54+
55+
Elasticsearch::API::Response.new(
56+
perform_request(method, path, params, body, headers, request_opts)
57+
)
58+
end
59+
end
60+
end
61+
end
62+
end

‎elasticsearch-api/lib/elasticsearch/api/actions/indices/put_data_stream_options.rb

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
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 Indices
24+
module Actions
25+
# Updates the data stream options of the selected data streams.
26+
#
27+
# @option arguments [List] :name A comma-separated list of data streams whose options will be updated; use `*` to set the options to all data streams
28+
# @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all)
29+
# @option arguments [Time] :timeout Explicit timestamp for the document
30+
# @option arguments [Time] :master_timeout Specify timeout for connection to master
31+
# @option arguments [Hash] :headers Custom HTTP headers
32+
# @option arguments [Hash] :body The data stream options configuration that consist of the failure store configuration
33+
#
34+
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.18/index.html
35+
#
36+
def put_data_stream_options(arguments = {})
37+
request_opts = { endpoint: arguments[:endpoint] || 'indices.put_data_stream_options' }
38+
39+
defined_params = [:name].each_with_object({}) do |variable, set_variables|
40+
set_variables[variable] = arguments[variable] if arguments.key?(variable)
41+
end
42+
request_opts[:defined_params] = defined_params unless defined_params.empty?
43+
44+
raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
45+
46+
arguments = arguments.clone
47+
headers = arguments.delete(:headers) || {}
48+
49+
body = arguments.delete(:body)
50+
51+
_name = arguments.delete(:name)
52+
53+
method = Elasticsearch::API::HTTP_PUT
54+
path = "_data_stream/#{Utils.__listify(_name)}/_options"
55+
params = Utils.process_params(arguments)
56+
57+
Elasticsearch::API::Response.new(
58+
perform_request(method, path, params, body, headers, request_opts)
59+
)
60+
end
61+
end
62+
end
63+
end
64+
end

‎elasticsearch-api/spec/elasticsearch/api/actions/indices/delete_data_stream_options_spec.rb

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
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.indices.delete_data_stream_options' do
21+
let(:expected_args) do
22+
[
23+
'DELETE',
24+
'_data_stream/foo/_options',
25+
{},
26+
nil,
27+
{},
28+
{ endpoint: 'indices.delete_data_stream_options', defined_params: { name: 'foo' } }
29+
]
30+
end
31+
32+
let(:index) { 'foo' }
33+
34+
it 'performs the request' do
35+
expect(client_double.indices.delete_data_stream_options(name: 'foo')).to be_a Elasticsearch::API::Response
36+
end
37+
end

‎elasticsearch-api/spec/elasticsearch/api/actions/indices/get_data_stream_options_spec.rb

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
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.indices.get_data_stream_options' do
21+
let(:expected_args) do
22+
[
23+
'GET',
24+
'_data_stream/foo/_options',
25+
{},
26+
nil,
27+
{},
28+
{ endpoint: 'indices.get_data_stream_options', defined_params: { name: 'foo' } }
29+
]
30+
end
31+
32+
let(:index) { 'foo' }
33+
34+
it 'performs the request' do
35+
expect(client_double.indices.get_data_stream_options(name: 'foo')).to be_a Elasticsearch::API::Response
36+
end
37+
end

‎elasticsearch-api/spec/elasticsearch/api/actions/indices/put_data_stream_options_spec.rb

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.cluster#put_data_stream_options' do
21+
let(:expected_args) do
22+
[
23+
'PUT',
24+
'_data_stream/foo/_options',
25+
{},
26+
nil,
27+
{},
28+
{ endpoint: 'indices.put_data_stream_options', defined_params: { name: 'foo' } }
29+
]
30+
end
31+
32+
it 'performs the request' do
33+
expect(client_double.indices.put_data_stream_options(name: 'foo')).to be_a Elasticsearch::API::Response
34+
end
35+
end

0 commit comments

Comments
 (0)