elasticsearch-api 7.17.7 → 8.0.0.pre1

data/lib/elasticsearch/api/actions/indices/create_data_stream.rb

@@ -0,0 +1,51 @@
+# 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.
+
+module Elasticsearch
+  module API
+    module Indices
+      module Actions
+        # Creates a data stream
+        #
+        # @option arguments [String] :name The name of the data stream
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html
+        #
+        def create_data_stream(arguments = {})
+          raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
+
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          arguments = arguments.clone
+
+          _name = arguments.delete(:name)
+
+          method = Elasticsearch::API::HTTP_PUT
+          path   = "_data_stream/#{Utils.__listify(_name)}"
+          params = {}
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/indices/data_streams_stats.rb

@@ -0,0 +1,53 @@
+# 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.
+
+module Elasticsearch
+  module API
+    module Indices
+      module Actions
+        # Provides statistics on operations happening in a data stream.
+        #
+        # @option arguments [List] :name A comma-separated list of data stream names; use `_all` or empty string to perform the operation on all data streams
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html
+        #
+        def data_streams_stats(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          arguments = arguments.clone
+
+          _name = arguments.delete(:name)
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = if _name
+                     "_data_stream/#{Utils.__listify(_name)}/_stats"
+                   else
+                     "_data_stream/_stats"
+                   end
+          params = {}
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/indices/delete.rb

@@ -29,39 +29,35 @@ module Elasticsearch
         # @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open, closed, or hidden indices (options: open, closed, hidden, none, all)
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/indices-delete-index.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-delete-index.html
         #
         def delete(arguments = {})
           raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
 
           headers = arguments.delete(:headers) || {}
 
+          body = nil
+
           arguments = arguments.clone
 
           _index = arguments.delete(:index)
 
           method = Elasticsearch::API::HTTP_DELETE
           path   = "#{Utils.__listify(_index)}"
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+          params = Utils.process_params(arguments)
 
-          body = nil
           if Array(arguments[:ignore]).include?(404)
-            Utils.__rescue_from_not_found { perform_request(method, path, params, body, headers).body }
+            Utils.__rescue_from_not_found {
+              Elasticsearch::API::Response.new(
+                perform_request(method, path, params, body, headers)
+              )
+            }
           else
-            perform_request(method, path, params, body, headers).body
+            Elasticsearch::API::Response.new(
+              perform_request(method, path, params, body, headers)
+            )
           end
         end
-
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.2.0
-        ParamsRegistry.register(:delete, [
-          :timeout,
-          :master_timeout,
-          :ignore_unavailable,
-          :allow_no_indices,
-          :expand_wildcards
-        ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/indices/delete_alias.rb

@@ -27,7 +27,7 @@ module Elasticsearch
         # @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/7.17/indices-aliases.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html
         #
         def delete_alias(arguments = {})
           raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
@@ -35,6 +35,8 @@ module Elasticsearch
 
           headers = arguments.delete(:headers) || {}
 
+          body = nil
+
           arguments = arguments.clone
 
           _index = arguments.delete(:index)
@@ -45,19 +47,12 @@ module Elasticsearch
           path   = if _index && _name
                      "#{Utils.__listify(_index)}/_aliases/#{Utils.__listify(_name)}"
                    end
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+          params = Utils.process_params(arguments)
 
-          body = nil
-          perform_request(method, path, params, body, headers).body
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
         end
-
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.2.0
-        ParamsRegistry.register(:delete_alias, [
-          :timeout,
-          :master_timeout
-        ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/indices/delete_data_stream.rb

@@ -0,0 +1,52 @@
+# 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.
+
+module Elasticsearch
+  module API
+    module Indices
+      module Actions
+        # Deletes a data stream.
+        #
+        # @option arguments [List] :name A comma-separated list of data streams to delete; use `*` to delete 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 [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html
+        #
+        def delete_data_stream(arguments = {})
+          raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
+
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          arguments = arguments.clone
+
+          _name = arguments.delete(:name)
+
+          method = Elasticsearch::API::HTTP_DELETE
+          path   = "_data_stream/#{Utils.__listify(_name)}"
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/indices/delete_index_template.rb

@@ -26,36 +26,27 @@ module Elasticsearch
         # @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/7.17/indices-templates.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html
         #
         def delete_index_template(arguments = {})
           raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
 
           headers = arguments.delete(:headers) || {}
 
+          body = nil
+
           arguments = arguments.clone
 
           _name = arguments.delete(:name)
 
           method = Elasticsearch::API::HTTP_DELETE
           path   = "_index_template/#{Utils.__listify(_name)}"
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+          params = Utils.process_params(arguments)
 
-          body = nil
-          if Array(arguments[:ignore]).include?(404)
-            Utils.__rescue_from_not_found { perform_request(method, path, params, body, headers).body }
-          else
-            perform_request(method, path, params, body, headers).body
-          end
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
         end
-
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.2.0
-        ParamsRegistry.register(:delete_index_template, [
-          :timeout,
-          :master_timeout
-        ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/indices/delete_template.rb

@@ -26,36 +26,35 @@ module Elasticsearch
         # @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/7.17/indices-templates.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html
         #
         def delete_template(arguments = {})
           raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
 
           headers = arguments.delete(:headers) || {}
 
+          body = nil
+
           arguments = arguments.clone
 
           _name = arguments.delete(:name)
 
           method = Elasticsearch::API::HTTP_DELETE
           path   = "_template/#{Utils.__listify(_name)}"
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+          params = Utils.process_params(arguments)
 
-          body = nil
           if Array(arguments[:ignore]).include?(404)
-            Utils.__rescue_from_not_found { perform_request(method, path, params, body, headers).body }
+            Utils.__rescue_from_not_found {
+              Elasticsearch::API::Response.new(
+                perform_request(method, path, params, body, headers)
+              )
+            }
           else
-            perform_request(method, path, params, body, headers).body
+            Elasticsearch::API::Response.new(
+              perform_request(method, path, params, body, headers)
+            )
           end
         end
-
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.2.0
-        ParamsRegistry.register(:delete_template, [
-          :timeout,
-          :master_timeout
-        ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/indices/disk_usage.rb

@@ -33,35 +33,27 @@ module Elasticsearch
         # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/indices-disk-usage.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-disk-usage.html
         #
         def disk_usage(arguments = {})
           raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
 
           headers = arguments.delete(:headers) || {}
 
+          body = nil
+
           arguments = arguments.clone
 
           _index = arguments.delete(:index)
 
           method = Elasticsearch::API::HTTP_POST
           path   = "#{Utils.__listify(_index)}/_disk_usage"
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+          params = Utils.process_params(arguments)
 
-          body = nil
-          perform_request(method, path, params, body, headers).body
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
         end
-
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.2.0
-        ParamsRegistry.register(:disk_usage, [
-          :run_expensive_tasks,
-          :flush,
-          :ignore_unavailable,
-          :allow_no_indices,
-          :expand_wildcards
-        ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/indices/exists.rb

@@ -30,22 +30,22 @@ module Elasticsearch
         # @option arguments [Boolean] :include_defaults Whether to return all default setting for each of the indices.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/indices-exists.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-exists.html
         #
         def exists(arguments = {})
           raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
 
           headers = arguments.delete(:headers) || {}
 
+          body = nil
+
           arguments = arguments.clone
 
           _index = arguments.delete(:index)
 
           method = Elasticsearch::API::HTTP_HEAD
           path   = "#{Utils.__listify(_index)}"
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-
-          body = nil
+          params = Utils.process_params(arguments)
 
           Utils.__rescue_from_not_found do
             perform_request(method, path, params, body, headers).status == 200 ? true : false
@@ -53,18 +53,6 @@ module Elasticsearch
         end
 
         alias_method :exists?, :exists
-
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.2.0
-        ParamsRegistry.register(:exists, [
-          :local,
-          :ignore_unavailable,
-          :allow_no_indices,
-          :expand_wildcards,
-          :flat_settings,
-          :include_defaults
-        ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/indices/exists_alias.rb

@@ -29,13 +29,15 @@ module Elasticsearch
         # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/indices-aliases.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html
         #
         def exists_alias(arguments = {})
           raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
 
           headers = arguments.delete(:headers) || {}
 
+          body = nil
+
           arguments = arguments.clone
 
           _name = arguments.delete(:name)
@@ -48,9 +50,7 @@ module Elasticsearch
                    else
                      "_alias/#{Utils.__listify(_name)}"
                    end
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-
-          body = nil
+          params = Utils.process_params(arguments)
 
           Utils.__rescue_from_not_found do
             perform_request(method, path, params, body, headers).status == 200 ? true : false
@@ -58,16 +58,6 @@ module Elasticsearch
         end
 
         alias_method :exists_alias?, :exists_alias
-
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.2.0
-        ParamsRegistry.register(:exists_alias, [
-          :ignore_unavailable,
-          :allow_no_indices,
-          :expand_wildcards,
-          :local
-        ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/indices/exists_index_template.rb

@@ -27,38 +27,29 @@ module Elasticsearch
         # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/indices-templates.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html
         #
         def exists_index_template(arguments = {})
           raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
 
           headers = arguments.delete(:headers) || {}
 
+          body = nil
+
           arguments = arguments.clone
 
           _name = arguments.delete(:name)
 
           method = Elasticsearch::API::HTTP_HEAD
           path   = "_index_template/#{Utils.__listify(_name)}"
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-
-          body = nil
+          params = Utils.process_params(arguments)
 
-          Utils.__rescue_from_not_found do
-            perform_request(method, path, params, body, headers).status == 200 ? true : false
-          end
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
         end
 
         alias_method :exists_index_template?, :exists_index_template
-
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.2.0
-        ParamsRegistry.register(:exists_index_template, [
-          :flat_settings,
-          :master_timeout,
-          :local
-        ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/indices/exists_template.rb

@@ -27,22 +27,22 @@ module Elasticsearch
         # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/indices-templates.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html
         #
         def exists_template(arguments = {})
           raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
 
           headers = arguments.delete(:headers) || {}
 
+          body = nil
+
           arguments = arguments.clone
 
           _name = arguments.delete(:name)
 
           method = Elasticsearch::API::HTTP_HEAD
           path   = "_template/#{Utils.__listify(_name)}"
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-
-          body = nil
+          params = Utils.process_params(arguments)
 
           Utils.__rescue_from_not_found do
             perform_request(method, path, params, body, headers).status == 200 ? true : false
@@ -50,15 +50,6 @@ module Elasticsearch
         end
 
         alias_method :exists_template?, :exists_template
-
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.2.0
-        ParamsRegistry.register(:exists_template, [
-          :flat_settings,
-          :master_timeout,
-          :local
-        ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/indices/exists_type.rb

@@ -29,7 +29,7 @@ module Elasticsearch
         # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/indices-types-exists.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-types-exists.html
         #
         def exists_type(arguments = {})
           raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
@@ -37,6 +37,8 @@ module Elasticsearch
 
           headers = arguments.delete(:headers) || {}
 
+          body = nil
+
           arguments = arguments.clone
 
           _index = arguments.delete(:index)
@@ -45,9 +47,7 @@ module Elasticsearch
 
           method = Elasticsearch::API::HTTP_HEAD
           path   = "#{Utils.__listify(_index)}/_mapping/#{Utils.__listify(_type)}"
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-
-          body = nil
+          params = Utils.process_params(arguments)
 
           Utils.__rescue_from_not_found do
             perform_request(method, path, params, body, headers).status == 200 ? true : false
@@ -55,16 +55,6 @@ module Elasticsearch
         end
 
         alias_method :exists_type?, :exists_type
-
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.2.0
-        ParamsRegistry.register(:exists_type, [
-          :ignore_unavailable,
-          :allow_no_indices,
-          :expand_wildcards,
-          :local
-        ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/indices/field_usage_stats.rb

@@ -32,34 +32,27 @@ module Elasticsearch
         # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/field-usage-stats.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/field-usage-stats.html
         #
         def field_usage_stats(arguments = {})
           raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
 
           headers = arguments.delete(:headers) || {}
 
+          body = nil
+
           arguments = arguments.clone
 
           _index = arguments.delete(:index)
 
           method = Elasticsearch::API::HTTP_GET
           path   = "#{Utils.__listify(_index)}/_field_usage_stats"
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+          params = Utils.process_params(arguments)
 
-          body = nil
-          perform_request(method, path, params, body, headers).body
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
         end
-
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.2.0
-        ParamsRegistry.register(:field_usage_stats, [
-          :fields,
-          :ignore_unavailable,
-          :allow_no_indices,
-          :expand_wildcards
-        ].freeze)
       end
     end
   end