Skip to content

Commit 9cc2864

Browse files
committed
[API] Adds indices data stream settings endpoints
1 parent 868877a commit 9cc2864

File tree

4 files changed

+198
-0
lines changed

4 files changed

+198
-0
lines changed
Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
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+
# Gets a data stream's settings
26+
#
27+
# @option arguments [String] :name Comma-separated list of data streams or data stream patterns
28+
# @option arguments [Time] :master_timeout Period to wait for a connection to the master node
29+
# @option arguments [Hash] :headers Custom HTTP headers
30+
#
31+
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.18/data-streams.html
32+
#
33+
def get_data_stream_settings(arguments = {})
34+
request_opts = { endpoint: arguments[:endpoint] || 'indices.get_data_stream_settings' }
35+
36+
defined_params = [:name].each_with_object({}) do |variable, set_variables|
37+
set_variables[variable] = arguments[variable] if arguments.key?(variable)
38+
end
39+
request_opts[:defined_params] = defined_params unless defined_params.empty?
40+
41+
raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
42+
43+
arguments = arguments.clone
44+
headers = arguments.delete(:headers) || {}
45+
46+
body = nil
47+
48+
_name = arguments.delete(:name)
49+
50+
method = Elasticsearch::API::HTTP_GET
51+
path = "_data_stream/#{Utils.__listify(_name)}/_settings"
52+
params = Utils.process_params(arguments)
53+
54+
Elasticsearch::API::Response.new(
55+
perform_request(method, path, params, body, headers, request_opts)
56+
)
57+
end
58+
end
59+
end
60+
end
61+
end
Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
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 a data stream's settings
26+
#
27+
# @option arguments [String] :name Comma-separated list of data streams or data stream patterns
28+
# @option arguments [Boolean] :dry_run Whether this request should only be a dry run rather than actually applying settings
29+
# @option arguments [Time] :timeout Period to wait for a response
30+
# @option arguments [Time] :master_timeout Period to wait for a connection to the master node
31+
# @option arguments [Hash] :headers Custom HTTP headers
32+
# @option arguments [Hash] :body The data stream settings to be updated (*Required*)
33+
#
34+
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.18/data-streams.html
35+
#
36+
def put_data_stream_settings(arguments = {})
37+
request_opts = { endpoint: arguments[:endpoint] || 'indices.put_data_stream_settings' }
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 'body' missing" unless arguments[:body]
45+
raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
46+
47+
arguments = arguments.clone
48+
headers = arguments.delete(:headers) || {}
49+
50+
body = arguments.delete(:body)
51+
52+
_name = arguments.delete(:name)
53+
54+
method = Elasticsearch::API::HTTP_PUT
55+
path = "_data_stream/#{Utils.__listify(_name)}/_settings"
56+
params = Utils.process_params(arguments)
57+
58+
Elasticsearch::API::Response.new(
59+
perform_request(method, path, params, body, headers, request_opts)
60+
)
61+
end
62+
end
63+
end
64+
end
65+
end
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_settings' do
21+
let(:expected_args) do
22+
[
23+
'GET',
24+
'_data_stream/foo/_settings',
25+
{},
26+
nil,
27+
{},
28+
{ endpoint: 'indices.get_data_stream_settings', 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_settings(name: 'foo')).to be_a Elasticsearch::API::Response
36+
end
37+
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.indices#put_data_stream_settings' do
21+
let(:expected_args) do
22+
[
23+
'PUT',
24+
'_data_stream/foo/_settings',
25+
{},
26+
{},
27+
{},
28+
{ endpoint: 'indices.put_data_stream_settings', defined_params: { name: 'foo' } }
29+
]
30+
end
31+
32+
it 'performs the request' do
33+
expect(client_double.indices.put_data_stream_settings(name: 'foo', body: {})).to be_a Elasticsearch::API::Response
34+
end
35+
end

0 commit comments

Comments
 (0)