elasticsearch-api 6.8.0 → 7.10.0

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

@@ -1,30 +1,31 @@
+# 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 Actions
-
-      # Configure the search definition witha template in Mustache and parameters
-      #
-      # @example Insert the start and end values for the `range` query
-      #
-      #     client.search_template index: 'myindex',
-      #                            body: {
-      #                              template: {
-      #                                query: {
-      #                                  range: {
-      #                                    date: { gte: "{{start}}", lte: "{{end}}" }
-      #                                  }
-      #                                }
-      #                              },
-      #                              params: { start: "2014-02-01", end: "2014-03-01" }
-      #                            }
+      # Allows to use the Mustache language to pre-render a search definition.
       #
       # @option arguments [List] :index A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
       # @option arguments [List] :type A comma-separated list of document types to search; leave empty to perform the operation on all types
-      # @option arguments [Hash] :body The search definition template and its params (*Required*)
       # @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, 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
@@ -32,35 +33,61 @@ module Elasticsearch
       # @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
-      # @option arguments [Boolean] :rest_total_hits_as_int This parameter is ignored in this version. It is used in the next major version to control whether the rest response should render the total.hits as an object or a number
+      # @option arguments [Boolean] :rest_total_hits_as_int Indicates whether hits.total should be rendered as an integer or an object in the rest search response
+      # @option arguments [Boolean] :ccs_minimize_roundtrips Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution
+      # @option arguments [Hash] :headers Custom HTTP headers
+      # @option arguments [Hash] :body The search definition template and its params (*Required*)
+      #
+      # *Deprecation notice*:
+      # Specifying types in urls has been deprecated
+      # Deprecated since version 7.0.0
       #
-      # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-template.html
       #
-      def search_template(arguments={})
-        method = HTTP_GET
-        path   = Utils.__pathify( Utils.__listify(arguments[:index]), Utils.__listify(arguments[:type]), '_search/template' )
+      # @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]
+
+        headers = arguments.delete(:headers) || {}
+
+        arguments = arguments.clone
+
+        _index = arguments.delete(:index)
+
+        _type = arguments.delete(:type)
+
+        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
         params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-        body   = arguments[:body]
 
-        perform_request(method, path, params, body).body
+        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(:search_template, [
-          :ignore_unavailable,
-          :ignore_throttled,
-          :allow_no_indices,
-          :expand_wildcards,
-          :preference,
-          :routing,
-          :scroll,
-          :search_type,
-          :explain,
-          :profile,
-          :typed_keys,
-          :rest_total_hits_as_int ].freeze)
+        :ignore_unavailable,
+        :ignore_throttled,
+        :allow_no_indices,
+        :expand_wildcards,
+        :preference,
+        :routing,
+        :scroll,
+        :search_type,
+        :explain,
+        :profile,
+        :typed_keys,
+        :rest_total_hits_as_int,
+        :ccs_minimize_roundtrips
+      ].freeze)
     end
   end
 end

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

@@ -0,0 +1,58 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module Elasticsearch
+  module API
+    module Snapshot
+      module Actions
+        # Removes stale data from repository.
+        #
+        # @option arguments [String] :repository A repository name
+        # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
+        # @option arguments [Time] :timeout Explicit operation timeout
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @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]
+
+          headers = arguments.delete(:headers) || {}
+
+          arguments = arguments.clone
+
+          _repository = arguments.delete(:repository)
+
+          method = Elasticsearch::API::HTTP_POST
+          path   = "_snapshot/#{Utils.__listify(_repository)}/_cleanup"
+          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(:cleanup_repository, [
+          :master_timeout,
+          :timeout
+        ].freeze)
+      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

@@ -1,49 +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 Snapshot
       module Actions
-
-        # Create a new snapshot in the repository
-        #
-        # @example Create a snapshot of the whole cluster in the `my-backups` repository
-        #
-        #     client.snapshot.create repository: 'my-backups', snapshot: 'snapshot-1'
-        #
-        # @example Create a snapshot for specific indices in the `my-backups` repository
-        #
-        #     client.snapshot.create repository: 'my-backups',
-        #                            snapshot: 'snapshot-2',
-        #                            body: { indices: 'foo,bar', ignore_unavailable: true }
+        # Creates a snapshot in a repository.
         #
-        # @option arguments [String] :repository A repository name (*Required*)
-        # @option arguments [String] :snapshot A snapshot name (*Required*)
-        # @option arguments [Hash] :body The snapshot definition
+        # @option arguments [String] :repository A repository name
+        # @option arguments [String] :snapshot A snapshot name
         # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
         # @option arguments [Boolean] :wait_for_completion Should this request wait until the operation has completed before returning
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body The snapshot definition
         #
-        # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/modules-snapshots.html
         #
-        def create(arguments={})
+        def create(arguments = {})
           raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]
-          raise ArgumentError, "Required argument 'snapshot' missing"   unless arguments[:snapshot]
-          repository = arguments.delete(:repository)
-          snapshot   = arguments.delete(:snapshot)
+          raise ArgumentError, "Required argument 'snapshot' missing" unless arguments[:snapshot]
+
+          headers = arguments.delete(:headers) || {}
+
+          arguments = arguments.clone
+
+          _repository = arguments.delete(:repository)
 
-          method = HTTP_PUT
-          path   = Utils.__pathify( '_snapshot', Utils.__escape(repository), Utils.__escape(snapshot) )
+          _snapshot = arguments.delete(:snapshot)
 
+          method = Elasticsearch::API::HTTP_PUT
+          path   = "_snapshot/#{Utils.__listify(_repository)}/#{Utils.__listify(_snapshot)}"
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-          body   = arguments[:body]
 
-          perform_request(method, path, params, body).body
+          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(:create, [
-            :master_timeout,
-            :wait_for_completion ].freeze)
+          :master_timeout,
+          :wait_for_completion
+        ].freeze)
       end
     end
   end

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

@@ -1,47 +1,61 @@
+# 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
-
-        # Create a repository for storing snapshots
-        #
-        # @example Create a repository at `/tmp/backup`
-        #
-        #     client.snapshot.create_repository repository: 'my-backups',
-        #                                       body: {
-        #                                         type: 'fs',
-        #                                         settings: { location: '/tmp/backup', compress: true  }
-        #                                       }
+        # Creates a repository.
         #
-        # @option arguments [String] :repository A repository name (*Required*)
-        # @option arguments [Hash] :body The repository definition (*Required*)
+        # @option arguments [String] :repository A repository name
         # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
         # @option arguments [Time] :timeout Explicit operation timeout
         # @option arguments [Boolean] :verify Whether to verify the repository after creation
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body The repository definition (*Required*)
         #
-        # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/modules-snapshots.html
         #
-        def create_repository(arguments={})
+        def create_repository(arguments = {})
+          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
           raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]
-          raise ArgumentError, "Required argument 'body' missing"       unless arguments[:body]
-          repository = arguments.delete(:repository)
 
-          method = HTTP_PUT
-          path   = Utils.__pathify( '_snapshot', Utils.__escape(repository) )
+          headers = arguments.delete(:headers) || {}
+
+          arguments = arguments.clone
+
+          _repository = arguments.delete(:repository)
 
+          method = Elasticsearch::API::HTTP_PUT
+          path   = "_snapshot/#{Utils.__listify(_repository)}"
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-          body   = arguments[:body]
 
-          perform_request(method, path, params, body).body
+          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(:create_repository, [
-            :master_timeout,
-            :timeout,
-            :verify ].freeze)
+          :master_timeout,
+          :timeout,
+          :verify
+        ].freeze)
       end
     end
   end

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

@@ -1,38 +1,54 @@
+# 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
-
-        # Delete a snapshot from the repository
-        #
-        # @note Will also abort a currently running snapshot.
-        #
-        # @example Delete the `snapshot-1` snapshot
+        # Deletes a snapshot.
         #
-        #     client.snapshot.delete repository: 'my-backups', snapshot: 'snapshot-1'
-        #
-        # @option arguments [String] :repository A repository name (*Required*)
-        # @option arguments [String] :snapshot A snapshot name (*Required*)
+        # @option arguments [String] :repository A repository name
+        # @option arguments [String] :snapshot A snapshot name
         # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
+        # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/modules-snapshots.html
         #
-        def delete(arguments={})
+        def delete(arguments = {})
           raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]
-          raise ArgumentError, "Required argument 'snapshot' missing"   unless arguments[:snapshot]
-          repository = arguments.delete(:repository)
-          snapshot   = arguments.delete(:snapshot)
+          raise ArgumentError, "Required argument 'snapshot' missing" unless arguments[:snapshot]
+
+          headers = arguments.delete(:headers) || {}
+
+          arguments = arguments.clone
+
+          _repository = arguments.delete(:repository)
 
-          method = HTTP_DELETE
-          path   = Utils.__pathify( '_snapshot', Utils.__escape(repository), Utils.__listify(snapshot) )
+          _snapshot = arguments.delete(:snapshot)
 
+          method = Elasticsearch::API::HTTP_DELETE
+          path   = "_snapshot/#{Utils.__listify(_repository)}/#{Utils.__listify(_snapshot)}"
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-          body   = nil
 
+          body = nil
           if Array(arguments[:ignore]).include?(404)
-            Utils.__rescue_from_not_found { perform_request(method, path, params, body).body }
+            Utils.__rescue_from_not_found { perform_request(method, path, params, body, headers).body }
           else
-            perform_request(method, path, params, body).body
+            perform_request(method, path, params, body, headers).body
           end
         end
 
@@ -40,7 +56,8 @@ module Elasticsearch
         #
         # @since 6.2.0
         ParamsRegistry.register(:delete, [
-            :master_timeout ].freeze)
+          :master_timeout
+        ].freeze)
       end
     end
   end

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

@@ -1,34 +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 Snapshot
       module Actions
-
-        # Delete a specific repository or repositories
-        #
-        # @example Delete the `my-backups` repository
+        # Deletes a repository.
         #
-        #     client.snapshot.delete_repository repository: 'my-backups'
-        #
-        # @option arguments [List] :repository A comma-separated list of repository names (*Required*)
+        # @option arguments [List] :repository Name of the snapshot repository to unregister. Wildcard (`*`) patterns are supported.
         # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
         # @option arguments [Time] :timeout Explicit operation timeout
+        # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/modules-snapshots.html
         #
-        def delete_repository(arguments={})
+        def delete_repository(arguments = {})
           raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]
-          repository = arguments.delete(:repository)
 
-          method = HTTP_DELETE
-          path   = Utils.__pathify( '_snapshot', Utils.__listify(repository) )
+          headers = arguments.delete(:headers) || {}
+
+          arguments = arguments.clone
+
+          _repository = arguments.delete(:repository)
 
+          method = Elasticsearch::API::HTTP_DELETE
+          path   = "_snapshot/#{Utils.__listify(_repository)}"
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-          body   = nil
 
+          body = nil
           if Array(arguments[:ignore]).include?(404)
-            Utils.__rescue_from_not_found { perform_request(method, path, params, body).body }
+            Utils.__rescue_from_not_found { perform_request(method, path, params, body, headers).body }
           else
-            perform_request(method, path, params, body).body
+            perform_request(method, path, params, body, headers).body
           end
         end
 
@@ -36,8 +53,9 @@ module Elasticsearch
         #
         # @since 6.2.0
         ParamsRegistry.register(:delete_repository, [
-            :master_timeout,
-            :timeout ].freeze)
+          :master_timeout,
+          :timeout
+        ].freeze)
       end
     end
   end