elasticsearch-api 7.8.1 → 7.10.1

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

@@ -25,8 +25,7 @@ module Elasticsearch
       # @option arguments [String] :analyzer The analyzer to use for the query string
       # @option arguments [Boolean] :analyze_wildcard Specify whether wildcard and prefix queries should be analyzed (default: false)
       # @option arguments [Boolean] :ccs_minimize_roundtrips Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution
-      # @option arguments [String] :default_operator The default operator for query string query (AND or OR)
-      #   (options: AND,OR)
+      # @option arguments [String] :default_operator The default operator for query string query (AND or OR) (options: AND, OR)
       # @option arguments [String] :df The field to use as default where no field prefix is given in the query string
       # @option arguments [Boolean] :explain Specify whether to return detailed information about score computation as part of a hit
       # @option arguments [List] :stored_fields A comma-separated list of stored fields to return as part of a hit
@@ -35,15 +34,13 @@ module Elasticsearch
       # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
       # @option arguments [Boolean] :ignore_throttled Whether specified concrete, expanded or aliased indices should be ignored when throttled
       # @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 [Boolean] :lenient Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
       # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random)
       # @option arguments [String] :q Query in the Lucene query string syntax
       # @option arguments [List] :routing A comma-separated list of specific routing values
       # @option arguments [Time] :scroll Specify how long a consistent view of the index should be maintained for scrolled search
-      # @option arguments [String] :search_type Search operation type
-      #   (options: query_then_fetch,dfs_query_then_fetch)
+      # @option arguments [String] :search_type Search operation type (options: query_then_fetch, dfs_query_then_fetch)
       # @option arguments [Number] :size Number of hits to return (default: 10)
       # @option arguments [List] :sort A comma-separated list of <field>:<direction> pairs
       # @option arguments [List] :_source True or false to return the _source field or not, or a list of fields to return
@@ -52,8 +49,7 @@ module Elasticsearch
       # @option arguments [Number] :terminate_after The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.
       # @option arguments [List] :stats Specific 'tag' of the request for logging and statistical purposes
       # @option arguments [String] :suggest_field Specify which field to use for suggestions
-      # @option arguments [String] :suggest_mode Specify suggest mode
-      #   (options: missing,popular,always)
+      # @option arguments [String] :suggest_mode Specify suggest mode (options: missing, popular, always)
       # @option arguments [Number] :suggest_size How many suggestions to return in response
       # @option arguments [String] :suggest_text The source text for which the suggestions should be returned
       # @option arguments [Time] :timeout Explicit operation timeout
@@ -76,7 +72,7 @@ module Elasticsearch
       # Deprecated since version 7.0.0
       #
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/search-search.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/search-search.html
       #
       def search(arguments = {})
         headers = arguments.delete(:headers) || {}
@@ -88,14 +84,19 @@ module Elasticsearch
 
         _type = arguments.delete(:type)
 
-        method = Elasticsearch::API::HTTP_GET
-        path   = if _index && _type
-                   "#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/_search"
-                 elsif _index
-                   "#{Utils.__listify(_index)}/_search"
+        method = if arguments[:body]
+                   Elasticsearch::API::HTTP_POST
                  else
-                   "_search"
-    end
+                   Elasticsearch::API::HTTP_GET
+                 end
+
+        path = if _index && _type
+                 "#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/_search"
+               elsif _index
+                 "#{Utils.__listify(_index)}/_search"
+               else
+                 "_search"
+               end
         params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
         body = arguments[:body]
@@ -150,5 +151,5 @@ module Elasticsearch
         :rest_total_hits_as_int
       ].freeze)
     end
-    end
+  end
 end

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

@@ -26,11 +26,10 @@ module Elasticsearch
       # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
       # @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 [Hash] :headers Custom HTTP headers
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/search-shards.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/search-shards.html
       #
       def search_shards(arguments = {})
         headers = arguments.delete(:headers) || {}
@@ -44,7 +43,7 @@ module Elasticsearch
                    "#{Utils.__listify(_index)}/_search_shards"
                  else
                    "_search_shards"
-    end
+                 end
         params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
         body = nil
@@ -63,5 +62,5 @@ module Elasticsearch
         :expand_wildcards
       ].freeze)
     end
-    end
+  end
 end

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

@@ -25,13 +25,11 @@ module Elasticsearch
       # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
       # @option arguments [Boolean] :ignore_throttled Whether specified concrete, expanded or aliased indices should be ignored when throttled
       # @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] :preference Specify the node or shard the operation should be performed on (default: random)
       # @option arguments [List] :routing A comma-separated list of specific routing values
       # @option arguments [Time] :scroll Specify how long a consistent view of the index should be maintained for scrolled search
-      # @option arguments [String] :search_type Search operation type
-      #   (options: query_then_fetch,query_and_fetch,dfs_query_then_fetch,dfs_query_and_fetch)
+      # @option arguments [String] :search_type Search operation type (options: query_then_fetch, query_and_fetch, dfs_query_then_fetch, dfs_query_and_fetch)
       # @option arguments [Boolean] :explain Specify whether to return detailed information about score computation as part of a hit
       # @option arguments [Boolean] :profile Specify whether to profile the query execution
       # @option arguments [Boolean] :typed_keys Specify whether aggregation and suggester names should be prefixed by their respective types in the response
@@ -45,7 +43,7 @@ module Elasticsearch
       # Deprecated since version 7.0.0
       #
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/search-template.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/search-template.html
       #
       def search_template(arguments = {})
         raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -58,14 +56,14 @@ module Elasticsearch
 
         _type = arguments.delete(:type)
 
-        method = Elasticsearch::API::HTTP_GET
+        method = Elasticsearch::API::HTTP_POST
         path   = if _index && _type
                    "#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/_search/template"
                  elsif _index
                    "#{Utils.__listify(_index)}/_search/template"
                  else
                    "_search/template"
-  end
+                 end
         params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
         body = arguments[:body]
@@ -91,5 +89,5 @@ module Elasticsearch
         :ccs_minimize_roundtrips
       ].freeze)
     end
-    end
+  end
 end

data/lib/elasticsearch/api/actions/snapshot/cleanup_repository.rb

@@ -26,7 +26,7 @@ module Elasticsearch
         # @option arguments [Time] :timeout Explicit operation timeout
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/clean-up-snapshot-repo-api.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/clean-up-snapshot-repo-api.html
         #
         def cleanup_repository(arguments = {})
           raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]
@@ -52,7 +52,7 @@ module Elasticsearch
           :master_timeout,
           :timeout
         ].freeze)
-end
       end
+    end
   end
 end

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

@@ -0,0 +1,66 @@
+# 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 Snapshot
+      module Actions
+        # Clones indices from one snapshot into another snapshot in the same repository.
+        #
+        # @option arguments [String] :repository A repository name
+        # @option arguments [String] :snapshot The name of the snapshot to clone from
+        # @option arguments [String] :target_snapshot The name of the cloned snapshot to create
+        # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body The snapshot clone definition (*Required*)
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/modules-snapshots.html
+        #
+        def clone(arguments = {})
+          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+          raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]
+          raise ArgumentError, "Required argument 'snapshot' missing" unless arguments[:snapshot]
+          raise ArgumentError, "Required argument 'target_snapshot' missing" unless arguments[:target_snapshot]
+
+          headers = arguments.delete(:headers) || {}
+
+          arguments = arguments.clone
+
+          _repository = arguments.delete(:repository)
+
+          _snapshot = arguments.delete(:snapshot)
+
+          _target_snapshot = arguments.delete(:target_snapshot)
+
+          method = Elasticsearch::API::HTTP_PUT
+          path   = "_snapshot/#{Utils.__listify(_repository)}/#{Utils.__listify(_snapshot)}/_clone/#{Utils.__listify(_target_snapshot)}"
+          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+
+          body = arguments[:body]
+          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(:clone, [
+          :master_timeout
+        ].freeze)
+      end
+    end
+  end
+end

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

@@ -28,7 +28,7 @@ module Elasticsearch
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body The snapshot definition
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/modules-snapshots.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/modules-snapshots.html
         #
         def create(arguments = {})
           raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]
@@ -57,7 +57,7 @@ module Elasticsearch
           :master_timeout,
           :wait_for_completion
         ].freeze)
-end
       end
+    end
   end
 end

data/lib/elasticsearch/api/actions/snapshot/create_repository.rb

@@ -28,7 +28,7 @@ module Elasticsearch
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body The repository definition (*Required*)
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/modules-snapshots.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/modules-snapshots.html
         #
         def create_repository(arguments = {})
           raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -56,7 +56,7 @@ module Elasticsearch
           :timeout,
           :verify
         ].freeze)
-end
       end
+    end
   end
 end

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

@@ -26,7 +26,7 @@ module Elasticsearch
         # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/modules-snapshots.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/modules-snapshots.html
         #
         def delete(arguments = {})
           raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]
@@ -58,7 +58,7 @@ module Elasticsearch
         ParamsRegistry.register(:delete, [
           :master_timeout
         ].freeze)
-end
       end
+    end
   end
 end

data/lib/elasticsearch/api/actions/snapshot/delete_repository.rb

@@ -26,7 +26,7 @@ module Elasticsearch
         # @option arguments [Time] :timeout Explicit operation timeout
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/modules-snapshots.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/modules-snapshots.html
         #
         def delete_repository(arguments = {})
           raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]
@@ -56,7 +56,7 @@ module Elasticsearch
           :master_timeout,
           :timeout
         ].freeze)
-end
       end
+    end
   end
 end

data/lib/elasticsearch/api/actions/snapshot/get.rb

@@ -28,7 +28,7 @@ module Elasticsearch
         # @option arguments [Boolean] :verbose Whether to show verbose snapshot info or only show the basic info found in the repository index blob
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/modules-snapshots.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/modules-snapshots.html
         #
         def get(arguments = {})
           raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]
@@ -62,7 +62,7 @@ module Elasticsearch
           :ignore_unavailable,
           :verbose
         ].freeze)
-end
       end
+    end
   end
 end

data/lib/elasticsearch/api/actions/snapshot/get_repository.rb

@@ -26,7 +26,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/modules-snapshots.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/modules-snapshots.html
         #
         def get_repository(arguments = {})
           headers = arguments.delete(:headers) || {}
@@ -40,7 +40,7 @@ module Elasticsearch
                      "_snapshot/#{Utils.__listify(_repository)}"
                    else
                      "_snapshot"
-      end
+                   end
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
           body = nil
@@ -58,7 +58,7 @@ module Elasticsearch
           :master_timeout,
           :local
         ].freeze)
-end
       end
+    end
   end
 end

data/lib/elasticsearch/api/actions/snapshot/restore.rb

@@ -28,7 +28,7 @@ module Elasticsearch
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body Details of what to restore
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/modules-snapshots.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/modules-snapshots.html
         #
         def restore(arguments = {})
           raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]
@@ -57,7 +57,7 @@ module Elasticsearch
           :master_timeout,
           :wait_for_completion
         ].freeze)
-end
       end
+    end
   end
 end

data/lib/elasticsearch/api/actions/snapshot/status.rb

@@ -27,7 +27,7 @@ module Elasticsearch
         # @option arguments [Boolean] :ignore_unavailable Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/modules-snapshots.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/modules-snapshots.html
         #
         def status(arguments = {})
           headers = arguments.delete(:headers) || {}
@@ -45,7 +45,7 @@ module Elasticsearch
                      "_snapshot/#{Utils.__listify(_repository)}/_status"
                    else
                      "_snapshot/_status"
-      end
+                   end
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
           body = nil
@@ -63,7 +63,7 @@ module Elasticsearch
           :master_timeout,
           :ignore_unavailable
         ].freeze)
-end
       end
+    end
   end
 end

data/lib/elasticsearch/api/actions/snapshot/verify_repository.rb

@@ -26,7 +26,7 @@ module Elasticsearch
         # @option arguments [Time] :timeout Explicit operation timeout
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/modules-snapshots.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/modules-snapshots.html
         #
         def verify_repository(arguments = {})
           raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]
@@ -52,7 +52,7 @@ module Elasticsearch
           :master_timeout,
           :timeout
         ].freeze)
-end
       end
+    end
   end
 end

data/lib/elasticsearch/api/actions/tasks/cancel.rb

@@ -20,6 +20,10 @@ module Elasticsearch
     module Tasks
       module Actions
         # Cancels a task, if it can be cancelled through an API.
+        # 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] :task_id Cancel the task with specified task id (node_id:task_number)
         # @option arguments [List] :nodes A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes
@@ -28,7 +32,7 @@ module Elasticsearch
         # @option arguments [Boolean] :wait_for_completion Should the request block until the cancellation of the task and its descendant tasks is completed. Defaults to false
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/tasks.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/tasks.html
         #
         def cancel(arguments = {})
           headers = arguments.delete(:headers) || {}
@@ -42,7 +46,7 @@ module Elasticsearch
                      "_tasks/#{Utils.__listify(_task_id)}/_cancel"
                    else
                      "_tasks/_cancel"
-      end
+                   end
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
           body = nil
@@ -58,7 +62,7 @@ module Elasticsearch
           :parent_task_id,
           :wait_for_completion
         ].freeze)
-end
       end
+    end
   end
 end