elasticsearch-api 6.3.0 → 6.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4041f561fb1eeba572e39978c8126a61f6d5f672eb927e02967c07afa795e82a
-  data.tar.gz: 1f6da8dd8630042207f6e69ffb55be11648a33013c5835055f59f28887fa590a
+  metadata.gz: 19da5f199e6925708551fbd62950e92b9f771871565b1c0a1c25be84e6a3fa5b
+  data.tar.gz: 30de598a45c430f98d5b953cf1b64242af3f51f103e97b8f4990819ac22f4535
 SHA512:
-  metadata.gz: 228212c3a32733b759dbd6dc0f006ea6cfd923d068dbb189d3c59c67c8916081ec78a2d8869d668bf75f75e1bed5fd364bd6d722bf56c2b8ce97db3c9ecb4c7a
-  data.tar.gz: f39a27ae8e93cda46cc3b6780e2a5967fb13197d809187fec0c031a4e0f63a908887764208e57a3e8daee894d7cfdbb184b1b5cd4157419bc96373cf4606ae0d
+  metadata.gz: 9dcbc29d2eecabd9af6ab0dd998065e6345f920f1fee6036af092474ffc898bc2acdd79b4bb2961284da0b02b72ea62c96bd5924761fcf22d87a27c73596f3c8
+  data.tar.gz: df636763d7c09ef2b6e68d5568445d22d9f53a1cc0e6d8b3590a7982236433b0feff98988b834ab3d7d267e6103ad8d8c943bd60024c44539acaf7abb03dea08

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

@@ -0,0 +1,21 @@
+module Elasticsearch
+  module API
+    module Actions
+
+      # Retrieve an indexed template from Elasticsearch
+      #
+      # @option arguments [String] :id Template ID
+      #
+      # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-template.html
+      #
+      def delete_template(arguments={})
+        method = HTTP_DELETE
+        path   = "_search/template/#{arguments[:id]}"
+        params = {}
+        body   = nil
+
+        perform_request(method, path, params, body).body
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+module Elasticsearch
+  module API
+    module Actions
+
+      # Returns statistical information about a field without executing a search.
+      #
+      # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
+      # @option arguments [List] :fields A comma-separated list of fields for to get field statistics for (min value, max value, and more)
+      # @option arguments [String] :level Defines if field stats should be returned on a per index level or on a cluster wide level (options: indices, cluster)
+      # @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, none, all)
+      #
+      # @see http://www.elastic.co/guide/en/elasticsearch/reference/master/search-field-stats.html
+      #
+      def field_stats(arguments={})
+        method = 'GET'
+        path   = Utils.__pathify Utils.__escape(arguments[:index]), "_field_stats"
+        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(:field_stats, [
+          :fields,
+          :level,
+          :ignore_unavailable,
+          :allow_no_indices,
+          :expand_wildcards ].freeze)
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+module Elasticsearch
+  module API
+    module Actions
+
+      # Retrieve an indexed script from Elasticsearch
+      #
+      # @option arguments [String] :id Template ID (*Required*)
+      # @option arguments [Hash] :body The document
+      #
+      # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-template.html
+      #
+      def get_template(arguments={})
+        raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
+        method = HTTP_GET
+        path   = "_scripts/#{arguments[:id]}"
+        params = {}
+        body   = arguments[:body]
+
+        if Array(arguments[:ignore]).include?(404)
+          Utils.__rescue_from_not_found { perform_request(method, path, params, body).body }
+        else
+          perform_request(method, path, params, body).body
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+module Elasticsearch
+  module API
+    module Indices
+      module Actions
+
+        # Delete all documents and mapping for a specific document type.
+        #
+        # @option arguments [List] :index A comma-separated list of index names; use `_all` for all indices (*Required*)
+        # @option arguments [String] :type The name of the document type to delete (*Required*)
+        #
+        # @see http://www.elasticsearch.org/guide/reference/api/admin-indices-delete-mapping/
+        #
+        def delete_mapping(arguments={})
+          raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
+          raise ArgumentError, "Required argument 'type' missing"  unless arguments[:type]
+          method = HTTP_DELETE
+          path   = Utils.__pathify Utils.__listify(arguments[:index]), Utils.__escape(arguments[:type])
+          params = {}
+          body   = nil
+
+          perform_request(method, path, params, body).body
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+module Elasticsearch
+  module API
+    module Indices
+      module Actions
+
+        # Delete one or more warmers for a list of indices.
+        #
+        # @example Delete a warmer named _mywarmer_ for index named _myindex_
+        #
+        #     client.indices.delete_warmer index: 'myindex', name: 'mywarmer'
+        #
+        # @option arguments [List] :index A comma-separated list of index names to register warmer for; use `_all`
+        #                                 or empty string to perform the operation on all indices (*Required*)
+        # @option arguments [String] :name The name of the warmer (supports wildcards); leave empty to delete all warmers
+        # @option arguments [List] :type A comma-separated list of document types to register warmer for; use `_all`
+        #                                or empty string to perform the operation on all types
+        #
+        # @see http://www.elasticsearch.org/guide/reference/api/admin-indices-warmers/
+        #
+        def delete_warmer(arguments={})
+          raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
+          method = HTTP_DELETE
+          path   = Utils.__pathify Utils.__listify(arguments[:index]), '_warmer', Utils.__listify(arguments[:name])
+          params = {}
+          body = nil
+
+          perform_request(method, path, params, body).body
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+module Elasticsearch
+  module API
+    module Indices
+      module Actions
+
+        # Get a list of all aliases, or aliases for a specific index.
+        #
+        # @example Get a list of all aliases
+        #
+        #     client.indices.get_aliases
+        #
+        # @option arguments [List] :index A comma-separated list of index names to filter aliases
+        # @option arguments [List] :name A comma-separated list of alias names to filter
+        # @option arguments [Time] :timeout Explicit timestamp for the document
+        # @option arguments [Boolean] :local Return local information,
+        #                                    do not retrieve the state from master node (default: false)
+        #
+        # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-aliases.html
+        #
+        def get_aliases(arguments={})
+          method = HTTP_GET
+          path   = Utils.__pathify Utils.__listify(arguments[:index]), '_aliases', Utils.__listify(arguments[:name])
+
+          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+          body   = nil
+
+          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(:get_aliases, [ :timeout, :local ].freeze)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,62 @@
+module Elasticsearch
+  module API
+    module Indices
+      module Actions
+
+        # Get one or more warmers for an index.
+        #
+        # @example Get all warmers
+        #
+        #     client.indices.get_warmer index: '_all'
+        #
+        # @example Get all warmers matching a wildcard expression
+        #
+        #     client.indices.get_warmer index: '_all', name: 'ba*'
+        #
+        # @example Get all warmers for a single index
+        #
+        #     client.indices.get_warmer index: 'foo'
+        #
+        # @example Get a specific warmer
+        #
+        #     client.indices.get_warmer index: 'foo', name: 'bar'
+        #
+        # @option arguments [List] :index A comma-separated list of index names to restrict the operation;
+        #                                 use `_all` to perform the operation on all indices (*Required*)
+        # @option arguments [String] :name The name of the warmer (supports wildcards); leave empty to get all warmers
+        # @option arguments [List] :type A comma-separated list of document types to restrict the operation;
+        #                                leave empty to perform the operation on all types
+        # @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)
+        # @option arguments [String] :ignore_indices When performed on multiple indices, allows to ignore
+        #                                            `missing` ones (options: none, missing) @until 1.0
+        # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when
+        #                                                 unavailable (missing, closed, etc)
+        #
+        # @see http://www.elasticsearch.org/guide/reference/api/admin-indices-warmers/
+        #
+        def get_warmer(arguments={})
+          method = HTTP_GET
+          path   = Utils.__pathify( Utils.__listify(arguments[:index]), '_warmer', Utils.__escape(arguments[:name]) )
+          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+          body   = nil
+
+          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(:get_warmer, [
+            :ignore_indices,
+            :ignore_unavailable,
+            :allow_no_indices,
+            :expand_wildcards,
+            :local ].freeze)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,77 @@
+module Elasticsearch
+  module API
+    module Indices
+      module Actions
+
+        # Perform an index optimization.
+        #
+        # The "optimize" operation merges the index segments, increasing search performance.
+        # It corresponds to a Lucene "merge" operation.
+        #
+        # @deprecated The "optimize" action has been deprecated in favor of forcemerge [https://github.com/elastic/elasticsearch/pull/13778]
+        #
+        # @example Fully optimize an index (merge to one segment)
+        #
+        #     client.indices.optimize index: 'foo', max_num_segments: 1, wait_for_merge: false
+        #
+        # @note The optimize operation is handled automatically by Elasticsearch, you don't need to perform it manually.
+        #       The operation is expensive in terms of resources (I/O, CPU, memory) and can take a long time to
+        #       finish, potentially reducing operability of your cluster; schedule the manual optimization accordingly.
+        #
+        # @option arguments [List] :index A comma-separated list of index names; use `_all`
+        #                                 or empty string to perform the operation on all indices
+        # @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)
+        # @option arguments [Boolean] :flush Specify whether the index should be flushed after performing the operation
+        #                                    (default: true)
+        # @option arguments [Boolean] :force Force a merge operation to run, even when the index has a single segment
+        #                                    (default: true)
+        # @option arguments [String] :ignore_indices When performed on multiple indices, allows to ignore
+        #                                            `missing` ones (options: none, missing) @until 1.0
+        # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when
+        #                                                 unavailable (missing, closed, etc)
+        # @option arguments [Number] :max_num_segments The number of segments the index should be merged into
+        #                                              (default: dynamic)
+        # @option arguments [Time] :master_timeout Specify timeout for connection to master
+        # @option arguments [Boolean] :only_expunge_deletes Specify whether the operation should only expunge
+        #                                                   deleted documents
+        # @option arguments [Boolean] :refresh Specify whether the index should be refreshed after performing the operation
+        #                                      (default: true)
+        # @option arguments [Boolean] :wait_for_merge Specify whether the request should block until the merge process
+        #                                             is finished (default: true)
+        #
+        # @see http://www.elasticsearch.org/guide/reference/api/admin-indices-optimize/
+        #
+        def optimize(arguments={})
+          method = HTTP_POST
+          path   = Utils.__pathify Utils.__listify(arguments[:index]), '_optimize'
+
+          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+          body = nil
+
+          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(:optimize, [
+            :ignore_indices,
+            :ignore_unavailable,
+            :allow_no_indices,
+            :expand_wildcards,
+            :flush,
+            :force,
+            :master_timeout,
+            :max_num_segments,
+            :only_expunge_deletes,
+            :operation_threading,
+            :refresh,
+            :wait_for_merge ].freeze)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,65 @@
+module Elasticsearch
+  module API
+    module Indices
+      module Actions
+
+        # Create or update an index warmer.
+        #
+        # An index warmer will run before an index is refreshed, ie. available for search.
+        # It allows you to register "heavy" queries with popular filters, facets or sorts,
+        # increasing performance when the index is searched for the first time.
+        #
+        # @example Register a warmer which will populate the caches for `published` filter and sorting on `created_at`
+        #
+        #     client.indices.put_warmer index: 'myindex',
+        #                               name: 'main',
+        #                               body: {
+        #                                 query: { filtered: { filter: { term: { published: true } } } },
+        #                                 sort:  [ "created_at" ]
+        #                               }
+        #
+        # @option arguments [List] :index A comma-separated list of index names to register the warmer for; use `_all`
+        #                                 or empty string to perform the operation on all indices (*Required*)
+        # @option arguments [String] :name The name of the warmer (*Required*)
+        # @option arguments [List] :type A comma-separated list of document types to register the warmer for;
+        #                                leave empty to perform the operation on all types
+        # @option arguments [Hash] :body The search request definition for the warmer
+        #                                (query, filters, facets, sorting, etc) (*Required*)
+        # @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)
+        # @option arguments [String] :ignore_indices When performed on multiple indices, allows to ignore
+        #                                            `missing` ones (options: none, missing) @until 1.0
+        # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when
+        #                                                 unavailable (missing, closed, etc)
+        #
+        # @see http://www.elasticsearch.org/guide/reference/api/admin-indices-warmers/
+        #
+        def put_warmer(arguments={})
+          raise ArgumentError, "Required argument 'name' missing"  unless arguments[:name]
+          raise ArgumentError, "Required argument 'body' missing"  unless arguments[:body]
+          method = HTTP_PUT
+          path   = Utils.__pathify( Utils.__listify(arguments[:index]),
+                                    Utils.__listify(arguments[:type]),
+                                    '_warmer',
+                                    Utils.__listify(arguments[:name]) )
+          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(:put_warmer, [
+            :ignore_indices,
+            :ignore_unavailable,
+            :allow_no_indices,
+            :expand_wildcards ].freeze)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+module Elasticsearch
+  module API
+    module Indices
+      module Actions
+
+        # "Seal" and index or indices for faster recovery
+        #
+        # @option arguments [List] :index A comma-separated list of index names;
+        #                                 use `_all` or empty string for all indices
+        #
+        # @see http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-seal.html
+        #
+        def seal(arguments={})
+          method = 'POST'
+          path   = Utils.__pathify Utils.__listify(arguments[:index]), '_seal'
+          params = {}
+          body   = nil
+
+          perform_request(method, path, params, body).body
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+module Elasticsearch
+  module API
+    module Indices
+      module Actions
+
+        # When using the shared storage gateway, manually trigger the snapshot operation.
+        #
+        # @deprecated The shared gateway has been deprecated [https://github.com/elasticsearch/elasticsearch/issues/2458]
+        #
+        # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string
+        #                                to perform the operation on all indices
+        # @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)
+        # @option arguments [String] :ignore_indices When performed on multiple indices, allows to ignore
+        #                                            `missing` ones (options: none, missing) @until 1.0
+        # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when
+        #                                                 unavailable (missing, closed, etc)
+        #
+        # @see http://www.elasticsearch.org/guide/reference/api/admin-indices-gateway-snapshot/
+        #
+        def snapshot_index(arguments={})
+          method = HTTP_POST
+          path   = Utils.__pathify Utils.__listify(arguments[:index]), '_gateway/snapshot'
+          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+          body   = nil
+
+          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(:snapshot_index, [
+            :ignore_indices,
+            :ignore_unavailable,
+            :allow_no_indices,
+            :expand_wildcards ].freeze)
+      end
+    end
+  end
+end