[API] Adds indices data lifecycle APIs

- indices.delete_data_lifecycle
- indices.get_data_lifecycle
- indices.put_data_lifecycle

Author: picandocodigo

elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_data_lifecycle.rb

@@ -0,0 +1,58 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
+# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
+#
+module Elasticsearch
+  module API
+    module Indices
+      module Actions
+        # Deletes the data lifecycle of the selected data streams.
+        #
+        # @option arguments [List] :name A comma-separated list of data streams of which the data lifecycle will be deleted; use `*` to get all data streams
+        # @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all)
+        # @option arguments [Time] :timeout Explicit timestamp for the document
+        # @option arguments [Time] :master_timeout Specify timeout for connection to master
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/dlm-delete-lifecycle.html
+        #
+        def delete_data_lifecycle(arguments = {})
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          _name = arguments.delete(:name)
+
+          method = Elasticsearch::API::HTTP_DELETE
+          path   = if _name
+                     "_data_stream/#{Utils.__listify(_name)}/_lifecycle"
+                   else
+                     "_data_stream/_lifecycle"
+                   end
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

elasticsearch-api/lib/elasticsearch/api/actions/indices/get_data_lifecycle.rb

@@ -0,0 +1,57 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
+# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
+#
+module Elasticsearch
+  module API
+    module Indices
+      module Actions
+        # Returns the data lifecycle of the selected data streams.
+        #
+        # @option arguments [List] :name A comma-separated list of data streams to get; use `*` to get all data streams
+        # @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all)
+        # @option arguments [Boolean] :include_defaults Return all relevant default configurations for the data stream (default: false)
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/dlm-get-lifecycle.html
+        #
+        def get_data_lifecycle(arguments = {})
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          _name = arguments.delete(:name)
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = if _name
+                     "_data_stream/#{Utils.__listify(_name)}/_lifecycle"
+                   else
+                     "_data_stream/_lifecycle"
+                   end
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

elasticsearch-api/lib/elasticsearch/api/actions/indices/put_data_lifecycle.rb

@@ -0,0 +1,59 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
+# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
+#
+module Elasticsearch
+  module API
+    module Indices
+      module Actions
+        # Updates the data lifecycle of the selected data streams.
+        #
+        # @option arguments [List] :name A comma-separated list of data streams whose lifecycle will be updated; use `*` to set the lifecycle to all data streams
+        # @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all)
+        # @option arguments [Time] :timeout Explicit timestamp for the document
+        # @option arguments [Time] :master_timeout Specify timeout for connection to master
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body The data lifecycle configuration that consist of the data retention
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/dlm-put-lifecycle.html
+        #
+        def put_data_lifecycle(arguments = {})
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body = arguments.delete(:body)
+
+          _name = arguments.delete(:name)
+
+          method = Elasticsearch::API::HTTP_PUT
+          path   = if _name
+                     "_data_stream/#{Utils.__listify(_name)}/_lifecycle"
+                   else
+                     "_data_stream/_lifecycle"
+                   end
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

elasticsearch-api/spec/elasticsearch/api/actions/indices/delete_data_lifecycle_spec.rb

@@ -0,0 +1,44 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+require 'spec_helper'
+
+describe 'client.indices#delete_data_lifecycle' do
+  let(:expected_args) do
+    [
+      'DELETE',
+      url,
+      {},
+      nil,
+      {}
+    ]
+  end
+
+  let(:url) { '_data_stream/_lifecycle'}
+
+  it 'performs the request' do
+    expect(client_double.indices.delete_data_lifecycle).to be_a Elasticsearch::API::Response
+  end
+
+  context 'when name is specified' do
+    let(:url) { '_data_stream/foo/_lifecycle'}
+
+    it 'performs the request' do
+      expect(client_double.indices.delete_data_lifecycle(name: 'foo')).to be_a Elasticsearch::API::Response
+    end
+  end
+end

elasticsearch-api/spec/elasticsearch/api/actions/indices/get_data_lifecycle_spec.rb

@@ -0,0 +1,44 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+require 'spec_helper'
+
+describe 'client.indices#get_data_lifecycle' do
+  let(:expected_args) do
+    [
+      'GET',
+      url,
+      {},
+      nil,
+      {}
+    ]
+  end
+
+  let(:url) { '_data_stream/_lifecycle'}
+
+  it 'performs the request' do
+    expect(client_double.indices.get_data_lifecycle).to be_a Elasticsearch::API::Response
+  end
+
+  context 'when name is specified' do
+    let(:url) { '_data_stream/foo/_lifecycle'}
+
+    it 'performs the request' do
+      expect(client_double.indices.get_data_lifecycle(name: 'foo')).to be_a Elasticsearch::API::Response
+    end
+  end
+end

elasticsearch-api/spec/elasticsearch/api/actions/indices/put_data_lifecycle_spec.rb

@@ -0,0 +1,44 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+require 'spec_helper'
+
+describe 'client.indices#put_data_lifecycle' do
+  let(:expected_args) do
+    [
+      'PUT',
+      url,
+      {},
+      nil,
+      {}
+    ]
+  end
+
+  let(:url) { '_data_stream/_lifecycle'}
+
+  it 'performs the request' do
+    expect(client_double.indices.put_data_lifecycle).to be_a Elasticsearch::API::Response
+  end
+
+  context 'when name is specified' do
+    let(:url) { '_data_stream/foo/_lifecycle'}
+
+    it 'performs the request' do
+      expect(client_double.indices.put_data_lifecycle(name: 'foo')).to be_a Elasticsearch::API::Response
+    end
+  end
+end