elasticsearch-api 7.8.0 → 7.10.0

data/lib/elasticsearch/api/actions/get_script.rb

@@ -24,7 +24,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/modules-scripting.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/modules-scripting.html
       #
       def get_script(arguments = {})
         raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
@@ -50,5 +50,5 @@ module Elasticsearch
         :master_timeout
       ].freeze)
     end
-    end
+  end
 end

data/lib/elasticsearch/api/actions/get_script_context.rb

@@ -19,10 +19,14 @@ module Elasticsearch
   module API
     module Actions
       # Returns all script contexts.
+      # 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 [Hash] :headers Custom HTTP headers
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/painless/7.8/painless-contexts.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/painless/7.10/painless-contexts.html
       #
       def get_script_context(arguments = {})
         headers = arguments.delete(:headers) || {}
@@ -37,5 +41,5 @@ module Elasticsearch
         perform_request(method, path, params, body, headers).body
       end
     end
-    end
+  end
 end

data/lib/elasticsearch/api/actions/get_script_languages.rb

@@ -19,10 +19,14 @@ module Elasticsearch
   module API
     module Actions
       # Returns available script types, languages and contexts
+      # 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 [Hash] :headers Custom HTTP headers
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/modules-scripting.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/modules-scripting.html
       #
       def get_script_languages(arguments = {})
         headers = arguments.delete(:headers) || {}
@@ -37,5 +41,5 @@ module Elasticsearch
         perform_request(method, path, params, body, headers).body
       end
     end
-    end
+  end
 end

data/lib/elasticsearch/api/actions/get_source.rb

@@ -22,7 +22,7 @@ module Elasticsearch
       #
       # @option arguments [String] :id The document ID
       # @option arguments [String] :index The name of the index
-      # @option arguments [String] :type The type of the document; deprecated and optional starting with 7.0   *Deprecated*
+      # @option arguments [String] :type The type of the document; deprecated and optional starting with 7.0 *Deprecated*
       # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random)
       # @option arguments [Boolean] :realtime Specify whether to perform the operation in realtime or search mode
       # @option arguments [Boolean] :refresh Refresh the shard containing the document before performing the operation
@@ -31,9 +31,7 @@ module Elasticsearch
       # @option arguments [List] :_source_excludes A list of fields to exclude from the returned _source field
       # @option arguments [List] :_source_includes A list of fields to extract and return from the _source field
       # @option arguments [Number] :version Explicit version number for concurrency control
-      # @option arguments [String] :version_type Specific version type
-      #   (options: internal,external,external_gte,force)
-
+      # @option arguments [String] :version_type Specific version type (options: internal, external, external_gte, force)
       # @option arguments [Hash] :headers Custom HTTP headers
       #
       # *Deprecation notice*:
@@ -41,7 +39,7 @@ module Elasticsearch
       # Deprecated since version 7.0.0
       #
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/docs-get.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/docs-get.html
       #
       def get_source(arguments = {})
         raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
@@ -62,7 +60,7 @@ module Elasticsearch
                    "#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/#{Utils.__listify(_id)}/_source"
                  else
                    "#{Utils.__listify(_index)}/_source/#{Utils.__listify(_id)}"
-  end
+                 end
         params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
         body = nil
@@ -84,5 +82,5 @@ module Elasticsearch
         :version_type
       ].freeze)
     end
-    end
+  end
 end

data/lib/elasticsearch/api/actions/index.rb

@@ -22,23 +22,18 @@ module Elasticsearch
       #
       # @option arguments [String] :id Document ID
       # @option arguments [String] :index The name of the index
-      # @option arguments [String] :type The type of the document   *Deprecated*
+      # @option arguments [String] :type The type of the document *Deprecated*
       # @option arguments [String] :wait_for_active_shards Sets the number of shard copies that must be active before proceeding with the index operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)
-      # @option arguments [String] :op_type Explicit operation type. Defaults to `index` for requests with an explicit document ID, and to `create`for requests without an explicit document ID
-      #   (options: index,create)
-
-      # @option arguments [String] :refresh If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes.
-      #   (options: true,false,wait_for)
-
+      # @option arguments [String] :op_type Explicit operation type. Defaults to `index` for requests with an explicit document ID, and to `create`for requests without an explicit document ID (options: index, create)
+      # @option arguments [String] :refresh If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes. (options: true, false, wait_for)
       # @option arguments [String] :routing Specific routing value
       # @option arguments [Time] :timeout Explicit operation timeout
       # @option arguments [Number] :version Explicit version number for concurrency control
-      # @option arguments [String] :version_type Specific version type
-      #   (options: internal,external,external_gte)
-
+      # @option arguments [String] :version_type Specific version type (options: internal, external, external_gte)
       # @option arguments [Number] :if_seq_no only perform the index operation if the last operation that has changed the document has the specified sequence number
       # @option arguments [Number] :if_primary_term only perform the index operation if the last operation that has changed the document has the specified primary term
       # @option arguments [String] :pipeline The pipeline id to preprocess incoming documents with
+      # @option arguments [Boolean] :require_alias When true, requires destination to be an alias. Default is false
       # @option arguments [Hash] :headers Custom HTTP headers
       # @option arguments [Hash] :body The document (*Required*)
       #
@@ -47,7 +42,7 @@ module Elasticsearch
       # Deprecated since version 7.0.0
       #
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/docs-index_.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/docs-index_.html
       #
       def index(arguments = {})
         raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -72,7 +67,7 @@ module Elasticsearch
                    "#{Utils.__listify(_index)}/#{Utils.__listify(_type)}"
                  else
                    "#{Utils.__listify(_index)}/_doc"
-  end
+                 end
         params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
         body = arguments[:body]
@@ -92,8 +87,9 @@ module Elasticsearch
         :version_type,
         :if_seq_no,
         :if_primary_term,
-        :pipeline
+        :pipeline,
+        :require_alias
       ].freeze)
     end
-    end
+  end
 end

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

@@ -0,0 +1,68 @@
+# 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
+        # Adds a block to an index.
+        #
+        # @option arguments [List] :index A comma separated list of indices to add a block to
+        # @option arguments [String] :block The block to add (one of read, write, read_only or metadata)
+        # @option arguments [Time] :timeout Explicit operation timeout
+        # @option arguments [Time] :master_timeout Specify timeout for connection to master
+        # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
+        # @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 [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/index-modules-blocks.html
+        #
+        def add_block(arguments = {})
+          raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
+          raise ArgumentError, "Required argument 'block' missing" unless arguments[:block]
+
+          headers = arguments.delete(:headers) || {}
+
+          arguments = arguments.clone
+
+          _index = arguments.delete(:index)
+
+          _block = arguments.delete(:block)
+
+          method = Elasticsearch::API::HTTP_PUT
+          path   = "#{Utils.__listify(_index)}/_block/#{Utils.__listify(_block)}"
+          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(:add_block, [
+          :timeout,
+          :master_timeout,
+          :ignore_unavailable,
+          :allow_no_indices,
+          :expand_wildcards
+        ].freeze)
+      end
+    end
+  end
+end

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

@@ -22,11 +22,10 @@ module Elasticsearch
         # Performs the analysis process on a text and return the tokens breakdown of the text.
         #
         # @option arguments [String] :index The name of the index to scope the operation
-        # @option arguments [String] :index The name of the index to scope the operation
         # @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.10/indices-analyze.html
         #
         def analyze(arguments = {})
           headers = arguments.delete(:headers) || {}
@@ -35,12 +34,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 +57,7 @@ module Elasticsearch
         ParamsRegistry.register(:analyze, [
           :index
         ].freeze)
-end
       end
+    end
   end
 end

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

@@ -27,14 +27,11 @@ module Elasticsearch
         # @option arguments [Boolean] :query Clear query caches
         # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
         # @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 [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] :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.10/indices-clearcache.html
         #
         def clear_cache(arguments = {})
           headers = arguments.delete(:headers) || {}
@@ -48,7 +45,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
@@ -68,7 +65,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.10/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

@@ -26,13 +26,11 @@ module Elasticsearch
         # @option arguments [Time] :master_timeout Specify timeout for connection to master
         # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
         # @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] :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.10/indices-open-close.html
         #
         def close(arguments = {})
           raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
@@ -62,7 +60,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.10/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/delete.rb

@@ -26,12 +26,10 @@ module Elasticsearch
         # @option arguments [Time] :master_timeout Specify timeout for connection to master
         # @option arguments [Boolean] :ignore_unavailable Ignore unavailable indexes (default: false)
         # @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 [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.10/indices-delete-index.html
         #
         def delete(arguments = {})
           raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
@@ -64,7 +62,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.10/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_index_template.rb

@@ -20,13 +20,17 @@ 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.10/indices-templates.html
         #
         def delete_index_template(arguments = {})
           raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
@@ -52,7 +56,7 @@ module Elasticsearch
           :timeout,
           :master_timeout
         ].freeze)
-end
       end
+    end
   end
 end