elasticsearch-api 7.8.1 → 7.9.0.pre

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

@@ -26,7 +26,7 @@ module Elasticsearch
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body Define analyzer/tokenizer parameters and the text on which the analysis should be performed
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/indices-analyze.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/indices-analyze.html
         #
         def analyze(arguments = {})
           headers = arguments.delete(:headers) || {}
@@ -35,12 +35,17 @@ module Elasticsearch
 
           _index = arguments.delete(:index)
 
-          method = Elasticsearch::API::HTTP_GET
-          path   = if _index
-                     "#{Utils.__listify(_index)}/_analyze"
+          method = if arguments[:body]
+                     Elasticsearch::API::HTTP_POST
                    else
-                     "_analyze"
-      end
+                     Elasticsearch::API::HTTP_GET
+                   end
+
+          path = if _index
+                   "#{Utils.__listify(_index)}/_analyze"
+                 else
+                   "_analyze"
+                 end
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
           body = arguments[:body]
@@ -53,7 +58,7 @@ module Elasticsearch
         ParamsRegistry.register(:analyze, [
           :index
         ].freeze)
-end
       end
+    end
   end
 end

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

@@ -29,11 +29,12 @@ module Elasticsearch
         # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
         # @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 [List] :index A comma-separated list of index name to limit the operation
         # @option arguments [Boolean] :request Clear request cache
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/indices-clearcache.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/indices-clearcache.html
         #
         def clear_cache(arguments = {})
           headers = arguments.delete(:headers) || {}
@@ -47,7 +48,7 @@ module Elasticsearch
                      "#{Utils.__listify(_index)}/_cache/clear"
                    else
                      "_cache/clear"
-      end
+                   end
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
           body = nil
@@ -67,7 +68,7 @@ module Elasticsearch
           :index,
           :request
         ].freeze)
-end
       end
+    end
   end
 end

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

@@ -29,7 +29,7 @@ module Elasticsearch
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body The configuration for the target index (`settings` and `aliases`)
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/indices-clone-index.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/indices-clone-index.html
         #
         def clone(arguments = {})
           raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
@@ -59,7 +59,7 @@ module Elasticsearch
           :master_timeout,
           :wait_for_active_shards
         ].freeze)
-end
       end
+    end
   end
 end

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

@@ -28,10 +28,11 @@ module Elasticsearch
         # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
         # @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 [String] :wait_for_active_shards Sets the number of active shards to wait for before the operation returns.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/indices-open-close.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/indices-open-close.html
         #
         def close(arguments = {})
           raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
@@ -61,7 +62,7 @@ module Elasticsearch
           :expand_wildcards,
           :wait_for_active_shards
         ].freeze)
-end
       end
+    end
   end
 end

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

@@ -29,7 +29,7 @@ module Elasticsearch
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body The configuration for the index (`settings` and `mappings`)
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/indices-create-index.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/indices-create-index.html
         #
         def create(arguments = {})
           raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
@@ -57,7 +57,7 @@ module Elasticsearch
           :timeout,
           :master_timeout
         ].freeze)
-end
       end
+    end
   end
 end

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

@@ -20,19 +20,14 @@ module Elasticsearch
     module Indices
       module Actions
         # Creates or updates a data stream
-        # This functionality is Experimental and may be changed or removed
-        # completely in a future release. Elastic will take a best effort approach
-        # to fix any issues, but experimental features are not subject to the
-        # support SLA of official GA features.
         #
         # @option arguments [String] :name The name of the data stream
         # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body The data stream definition (*Required*)
+        # @option arguments [Hash] :body The data stream definition
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/data-streams.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/data-streams.html
         #
         def create_data_stream(arguments = {})
-          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
           raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
 
           headers = arguments.delete(:headers) || {}
@@ -48,7 +43,7 @@ module Elasticsearch
           body = arguments[:body]
           perform_request(method, path, params, body, headers).body
         end
-end
       end
+    end
   end
 end

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

@@ -0,0 +1,62 @@
+# 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 [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 [Boolean] :forbid_closed_indices If set to false stats will also collected from closed indices if explicitly specified or if expand_wildcards expands to closed indices
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/data-streams.html
+        #
+        def data_streams_stats(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
+          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 = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+
+          body = nil
+          perform_request(method, path, params, body, headers).body
+        end
+
+        # Register this action with its valid params when the module is loaded.
+        #
+        # @since 6.2.0
+        ParamsRegistry.register(:data_streams_stats, [
+          :expand_wildcards,
+          :forbid_closed_indices
+        ].freeze)
+      end
+    end
+  end
+end

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

@@ -28,9 +28,10 @@ module Elasticsearch
         # @option arguments [Boolean] :allow_no_indices Ignore if a wildcard expression resolves to no concrete indices (default: false)
         # @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/7.8/indices-delete-index.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/indices-delete-index.html
         #
         def delete(arguments = {})
           raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
@@ -63,7 +64,7 @@ module Elasticsearch
           :allow_no_indices,
           :expand_wildcards
         ].freeze)
-end
       end
+    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.8/indices-aliases.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/indices-aliases.html
         #
         def delete_alias(arguments = {})
           raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
@@ -44,7 +44,7 @@ module Elasticsearch
           method = Elasticsearch::API::HTTP_DELETE
           path   = if _index && _name
                      "#{Utils.__listify(_index)}/_aliases/#{Utils.__listify(_name)}"
-  end
+                   end
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
           body = nil
@@ -58,7 +58,7 @@ module Elasticsearch
           :timeout,
           :master_timeout
         ].freeze)
-end
       end
+    end
   end
 end

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

@@ -20,15 +20,11 @@ module Elasticsearch
     module Indices
       module Actions
         # Deletes a data stream.
-        # This functionality is Experimental and may be changed or removed
-        # completely in a future release. Elastic will take a best effort approach
-        # to fix any issues, but experimental features are not subject to the
-        # support SLA of official GA features.
         #
-        # @option arguments [String] :name The name of the data stream
+        # @option arguments [List] :name A comma-separated list of data streams to delete; use `*` to delete all data streams
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/data-streams.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/data-streams.html
         #
         def delete_data_stream(arguments = {})
           raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
@@ -46,7 +42,7 @@ module Elasticsearch
           body = nil
           perform_request(method, path, params, body, headers).body
         end
-end
       end
+    end
   end
 end

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

@@ -20,17 +20,13 @@ module Elasticsearch
     module Indices
       module Actions
         # Deletes an index template.
-        # This functionality is Experimental and may be changed or removed
-        # completely in a future release. Elastic will take a best effort approach
-        # to fix any issues, but experimental features are not subject to the
-        # support SLA of official GA features.
         #
         # @option arguments [String] :name The name of the template
         # @option arguments [Time] :timeout Explicit operation timeout
         # @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.8/indices-templates.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/indices-templates.html
         #
         def delete_index_template(arguments = {})
           raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
@@ -56,7 +52,7 @@ module Elasticsearch
           :timeout,
           :master_timeout
         ].freeze)
-end
       end
+    end
   end
 end

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

@@ -26,7 +26,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.8/indices-templates.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/indices-templates.html
         #
         def delete_template(arguments = {})
           raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
@@ -56,7 +56,7 @@ module Elasticsearch
           :timeout,
           :master_timeout
         ].freeze)
-end
       end
+    end
   end
 end

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

@@ -27,11 +27,12 @@ module Elasticsearch
         # @option arguments [Boolean] :allow_no_indices Ignore if a wildcard expression resolves to no concrete indices (default: false)
         # @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] :flat_settings Return settings in flat format (default: false)
         # @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.8/indices-exists.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/indices-exists.html
         #
         def exists(arguments = {})
           raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
@@ -65,7 +66,7 @@ module Elasticsearch
           :flat_settings,
           :include_defaults
         ].freeze)
-end
       end
+    end
   end
 end

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

@@ -27,10 +27,11 @@ module Elasticsearch
         # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
         # @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 [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.8/indices-aliases.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/indices-aliases.html
         #
         def exists_alias(arguments = {})
           raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
@@ -48,7 +49,7 @@ module Elasticsearch
                      "#{Utils.__listify(_index)}/_alias/#{Utils.__listify(_name)}"
                    else
                      "_alias/#{Utils.__listify(_name)}"
-  end
+                   end
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
           body = nil
@@ -68,7 +69,7 @@ module Elasticsearch
           :expand_wildcards,
           :local
         ].freeze)
-end
       end
+    end
   end
 end

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

@@ -20,10 +20,6 @@ module Elasticsearch
     module Indices
       module Actions
         # Returns information about whether a particular index template exists.
-        # This functionality is Experimental and may be changed or removed
-        # completely in a future release. Elastic will take a best effort approach
-        # to fix any issues, but experimental features are not subject to the
-        # support SLA of official GA features.
         #
         # @option arguments [String] :name The name of the template
         # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false)
@@ -31,7 +27,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.8/indices-templates.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/indices-templates.html
         #
         def exists_index_template(arguments = {})
           raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
@@ -59,7 +55,7 @@ module Elasticsearch
           :master_timeout,
           :local
         ].freeze)
-end
       end
+    end
   end
 end

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

@@ -27,7 +27,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.8/indices-templates.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/indices-templates.html
         #
         def exists_template(arguments = {})
           raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
@@ -58,7 +58,7 @@ module Elasticsearch
           :master_timeout,
           :local
         ].freeze)
-end
       end
+    end
   end
 end