Skip to content

Commit 7bd0ff6

Browse files
committed
[API] Adds new namespace DataStreams
1 parent 8450b61 commit 7bd0ff6

File tree

8 files changed

+313
-1
lines changed

8 files changed

+313
-1
lines changed

elasticsearch-api/lib/elasticsearch/api.rb

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,8 @@ def self.included(base)
8989
Elasticsearch::API::Simulate,
9090
Elasticsearch::API::Connector,
9191
Elasticsearch::API::ConnectorSyncJob,
92-
Elasticsearch::API::ConnectorSecret
92+
Elasticsearch::API::ConnectorSecret,
93+
Elasticsearch::API::DataStreams
9394
end
9495

9596
# The serializer class
Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
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 DataStreams
24+
module Actions
25+
# Deletes the global retention configuration that applies to all data streams managed by the data stream lifecycle.
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 [Boolean] :dry_run Determines whether the global retention provided should be applied or only the impact should be determined.
32+
# @option arguments [Time] :master_timeout Specify timeout for connection to master.
33+
# @option arguments [Hash] :headers Custom HTTP headers
34+
#
35+
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams-delete-global-retention.html
36+
#
37+
def delete_global_retention(arguments = {})
38+
request_opts = { endpoint: arguments[:endpoint] || 'data_streams.delete_global_retention' }
39+
40+
arguments = arguments.clone
41+
headers = arguments.delete(:headers) || {}
42+
43+
body = nil
44+
45+
method = Elasticsearch::API::HTTP_DELETE
46+
path = '_data_stream/_global_retention'
47+
params = Utils.process_params(arguments)
48+
49+
Elasticsearch::API::Response.new(
50+
perform_request(method, path, params, body, headers, request_opts)
51+
)
52+
end
53+
end
54+
end
55+
end
56+
end
Lines changed: 55 additions & 0 deletions
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 DataStreams
24+
module Actions
25+
# Returns global retention configuration that applies to all data streams managed by the data stream lifecycle.
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 [Boolean] :local Return the global retention retrieved from the node that received the request.
32+
# @option arguments [Hash] :headers Custom HTTP headers
33+
#
34+
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams-get-global-retention.html
35+
#
36+
def get_global_retention(arguments = {})
37+
request_opts = { endpoint: arguments[:endpoint] || 'data_streams.get_global_retention' }
38+
39+
arguments = arguments.clone
40+
headers = arguments.delete(:headers) || {}
41+
42+
body = nil
43+
44+
method = Elasticsearch::API::HTTP_GET
45+
path = '_data_stream/_global_retention'
46+
params = Utils.process_params(arguments)
47+
48+
Elasticsearch::API::Response.new(
49+
perform_request(method, path, params, body, headers, request_opts)
50+
)
51+
end
52+
end
53+
end
54+
end
55+
end
Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
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 DataStreams
24+
module Actions
25+
# Updates the global retention configuration that applies to all data streams managed by the data stream lifecycle.
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 [Boolean] :dry_run Determines whether the global retention provided should be applied or only the impact should be determined.
32+
# @option arguments [Time] :master_timeout Specify timeout for connection to master
33+
# @option arguments [Hash] :headers Custom HTTP headers
34+
# @option arguments [Hash] :body The global retention configuration including optional values for default and max retention. (*Required*)
35+
#
36+
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams-put-global-retention.html
37+
#
38+
def put_global_retention(arguments = {})
39+
request_opts = { endpoint: arguments[:endpoint] || 'data_streams.put_global_retention' }
40+
41+
raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
42+
43+
arguments = arguments.clone
44+
headers = arguments.delete(:headers) || {}
45+
46+
body = arguments.delete(:body)
47+
48+
method = Elasticsearch::API::HTTP_PUT
49+
path = '_data_stream/_global_retention'
50+
params = Utils.process_params(arguments)
51+
52+
Elasticsearch::API::Response.new(
53+
perform_request(method, path, params, body, headers, request_opts)
54+
)
55+
end
56+
end
57+
end
58+
end
59+
end
Lines changed: 36 additions & 0 deletions
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 DataStreams
21+
module Actions; end
22+
23+
# Client for the "data_streams" namespace (includes the {DataStreams::Actions} methods)
24+
#
25+
class DataStreamsClient
26+
include Common::Client, Common::Client::Base, DataStreams::Actions
27+
end
28+
29+
# Proxy method for {DataStreamsClient}, available in the receiving object
30+
#
31+
def data_streams
32+
@data_streams ||= DataStreamsClient.new(self)
33+
end
34+
end
35+
end
36+
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#data_streams.delete_global_retention' do
21+
let(:expected_args) do
22+
[
23+
'DELETE',
24+
'_data_stream/_global_retention',
25+
{},
26+
nil,
27+
{},
28+
{ endpoint: 'data_streams.delete_global_retention' }
29+
]
30+
end
31+
32+
it 'performs the request' do
33+
expect(client_double.data_streams.delete_global_retention).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#data_streams.get_global_retention' do
21+
let(:expected_args) do
22+
[
23+
'GET',
24+
'_data_stream/_global_retention',
25+
{},
26+
nil,
27+
{},
28+
{ endpoint: 'data_streams.get_global_retention' }
29+
]
30+
end
31+
32+
it 'performs the request' do
33+
expect(client_double.data_streams.get_global_retention).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#data_streams.put_global_retention' do
21+
let(:expected_args) do
22+
[
23+
'PUT',
24+
'_data_stream/_global_retention',
25+
{},
26+
{},
27+
{},
28+
{ endpoint: 'data_streams.put_global_retention' }
29+
]
30+
end
31+
32+
it 'performs the request' do
33+
expect(client_double.data_streams.put_global_retention(body: {})).to be_a Elasticsearch::API::Response
34+
end
35+
end

0 commit comments

Comments
 (0)