elasticsearch-api 7.4.0 → 7.5.0.pre.pre

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

@@ -5,68 +5,76 @@
 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,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
       # @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] :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 https://www.elastic.co/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.5/search-template.html
+      #
+      def search_template(arguments = {})
+        raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+
+        arguments = arguments.clone
+
+        _index = arguments.delete(:index)
+
+        _type = arguments.delete(:type)
+
+        method = Elasticsearch::API::HTTP_GET
+        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]
 
+        body = arguments[:body]
         perform_request(method, path, params, body).body
       end
 
       # Register this action with its valid params when the module is loaded.
       #
-      # @since 6.1.1
+      # @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,
-          :ccs_minimize_roundtrips ].freeze)
+        :ignore_unavailable,
+        :ignore_throttled,
+        :allow_no_indices,
+        :expand_wildcards,
+        :preference,
+        :routing,
+        :scroll,
+        :search_type,
+        :explain,
+        :profile,
+        :typed_keys,
+        :rest_total_hits_as_int
+      ].freeze)
+    end
     end
-  end
 end

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

@@ -0,0 +1,44 @@
+# Licensed to Elasticsearch B.V under one or more agreements.
+# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
+# See the LICENSE file in the project root for more information
+
+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] :body TODO: Description
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/modules-snapshots.html
+        #
+        def cleanup_repository(arguments = {})
+          raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]
+
+          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 = arguments[:body]
+          perform_request(method, path, params, body).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/create.rb

@@ -6,50 +6,43 @@ 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'
+        # Creates a snapshot in a repository.
         #
-        # @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 }
-        #
-        # @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 Whether the request should block and wait until
-        #                                                  the operation has completed
+        # @option arguments [Boolean] :wait_for_completion Should this request wait until the operation has completed before returning
+
+        # @option arguments [Hash] :body The snapshot definition
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html#_snapshot
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/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]
+
+          arguments = arguments.clone
 
-          method = HTTP_PUT
-          path   = Utils.__pathify( '_snapshot', Utils.__escape(repository), Utils.__escape(snapshot) )
+          _repository = arguments.delete(:repository)
 
+          _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]
 
+          body = arguments[:body]
           perform_request(method, path, params, body).body
         end
 
         # Register this action with its valid params when the module is loaded.
         #
-        # @since 6.1.1
+        # @since 6.2.0
         ParamsRegistry.register(:create, [
-            :master_timeout,
-            :wait_for_completion ].freeze)
+          :master_timeout,
+          :wait_for_completion
+        ].freeze)
+end
       end
-    end
   end
 end

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

@@ -6,47 +6,42 @@ module Elasticsearch
   module API
     module Snapshot
       module Actions
-
-        # Create a repository for storing snapshots
-        #
-        # @example Create a repository at `/tmp/backup`
+        # Creates a repository.
         #
-        #     client.snapshot.create_repository repository: 'my-backups',
-        #                                       body: {
-        #                                         type: 'fs',
-        #                                         settings: { location: '/tmp/backup', compress: true  }
-        #                                       }
-        #
-        # @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] :body The repository definition (*Required*)
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html#_repositories
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/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) )
+          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]
 
+          body = arguments[:body]
           perform_request(method, path, params, body).body
         end
 
         # Register this action with its valid params when the module is loaded.
         #
-        # @since 6.1.1
+        # @since 6.2.0
         ParamsRegistry.register(:create_repository, [
-            :master_timeout,
-            :timeout,
-            :verify ].freeze)
+          :master_timeout,
+          :timeout,
+          :verify
+        ].freeze)
+end
       end
-    end
   end
 end

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

@@ -6,34 +6,30 @@ 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
-        #
-        #     client.snapshot.delete repository: 'my-backups', snapshot: 'snapshot-1'
+        # Deletes a snapshot.
         #
-        # @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 [Number,List] :ignore The list of HTTP errors to ignore
+
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/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]
+
+          arguments = arguments.clone
 
-          method = HTTP_DELETE
-          path   = Utils.__pathify( '_snapshot', Utils.__escape(repository), Utils.__listify(snapshot) )
+          _repository = arguments.delete(:repository)
 
+          _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 }
           else
@@ -43,9 +39,11 @@ module Elasticsearch
 
         # Register this action with its valid params when the module is loaded.
         #
-        # @since 6.1.1
-        ParamsRegistry.register(:delete, [ :master_timeout ].freeze)
+        # @since 6.2.0
+        ParamsRegistry.register(:delete, [
+          :master_timeout
+        ].freeze)
+end
       end
-    end
   end
 end

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

@@ -6,30 +6,27 @@ module Elasticsearch
   module API
     module Snapshot
       module Actions
-
-        # Delete a specific repository or repositories
-        #
-        # @example Delete the `my-backups` repository
-        #
-        #     client.snapshot.delete_repository repository: 'my-backups'
+        # Deletes a repository.
         #
-        # @option arguments [List] :repository A comma-separated list of repository names (*Required*)
+        # @option arguments [List] :repository A comma-separated list of repository names
         # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
         # @option arguments [Time] :timeout Explicit operation timeout
-        # @option arguments [Number,List] :ignore The list of HTTP errors to ignore
+
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/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) )
+          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 }
           else
@@ -39,11 +36,12 @@ module Elasticsearch
 
         # Register this action with its valid params when the module is loaded.
         #
-        # @since 6.1.1
+        # @since 6.2.0
         ParamsRegistry.register(:delete_repository, [
-            :master_timeout,
-            :timeout ].freeze)
+          :master_timeout,
+          :timeout
+        ].freeze)
+end
       end
-    end
   end
 end

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

@@ -6,42 +6,32 @@ module Elasticsearch
   module API
     module Snapshot
       module Actions
-
-        # Return information about specific (or all) snapshots
-        #
-        # @example Return information about the `snapshot-2` snapshot
-        #
-        #     client.snapshot.get repository: 'my-backup', snapshot: 'snapshot-2'
-        #
-        # @example Return information about multiple snapshots
-        #
-        #     client.snapshot.get repository: 'my-backup', snapshot: ['snapshot-2', 'snapshot-3']
-        #
-        # @example Return information about all snapshots in the repository
+        # Returns information about a snapshot.
         #
-        #     client.snapshot.get repository: 'my-backup', snapshot: '_all'
-        #
-        # @option arguments [String] :repository A repository name (*Required*)
-        # @option arguments [List] :snapshot A comma-separated list of snapshot names (*Required*)
-        # @option arguments [Boolean] :ignore_unavailable Whether to ignore unavailable snapshots, defaults to
-        #   false which means a SnapshotMissingException is thrown
+        # @option arguments [String] :repository A repository name
+        # @option arguments [List] :snapshot A comma-separated list of snapshot names
         # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
+        # @option arguments [Boolean] :ignore_unavailable Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown
         # @option arguments [Boolean] :verbose Whether to show verbose snapshot info or only show the basic info found in the repository index blob
+
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/modules-snapshots.html
         #
-        def get(arguments={})
+        def get(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]
+
+          arguments = arguments.clone
 
-          method = HTTP_GET
-          path   = Utils.__pathify( '_snapshot', Utils.__escape(repository), Utils.__listify(snapshot) )
+          _repository = arguments.delete(:repository)
 
+          _snapshot = arguments.delete(:snapshot)
+
+          method = Elasticsearch::API::HTTP_GET
+          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 }
           else
@@ -51,12 +41,13 @@ module Elasticsearch
 
         # Register this action with its valid params when the module is loaded.
         #
-        # @since 6.1.1
+        # @since 6.2.0
         ParamsRegistry.register(:get, [
-            :ignore_unavailable,
-            :master_timeout,
-            :verbose ].freeze)
+          :master_timeout,
+          :ignore_unavailable,
+          :verbose
+        ].freeze)
+end
       end
-    end
   end
 end