elasticsearch-api 6.8.3 → 7.0.0.pre

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

@@ -1,69 +0,0 @@
-# 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 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

@@ -1,28 +0,0 @@
-# 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 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

@@ -1,48 +0,0 @@
-# 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 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

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

@@ -1,67 +0,0 @@
-# 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 Indices
-      module Actions
-
-        # Return information about one or more indices
-        #
-        # @example Get information about all indices
-        #
-        #     client.indices.status
-        #
-        # @example Get information about a specific index
-        #
-        #     client.indices.status index: 'foo'
-        #
-        # @example Get information about shard recovery for a specific index
-        #
-        #     client.indices.status index: 'foo', recovery: true
-        #
-        # @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)
-        # @option arguments [Boolean] :recovery Return information about shard recovery (progress, size, etc)
-        # @option arguments [Boolean] :snapshot Return information about snapshots (when shared gateway is used)
-        #
-        # @see http://elasticsearch.org/guide/reference/api/admin-indices-status/
-        #
-        def status(arguments={})
-          method = HTTP_GET
-          path   = Utils.__pathify Utils.__listify(arguments[:index]), '_status'
-
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-          body   = nil
-
-          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
-
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.2.0
-        ParamsRegistry.register(:status, [
-            :ignore_indices,
-            :ignore_unavailable,
-            :allow_no_indices,
-            :expand_wildcards,
-            :recovery,
-            :snapshot ].freeze)
-      end
-    end
-  end
-end

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

@@ -1,31 +0,0 @@
-# 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 Actions
-
-      # Return a list of running benchmarks
-      #
-      # @example
-      #
-      #     client.list_benchmarks
-      #
-      # @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 [String] :type The name of the document type
-      #
-      # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-benchmark.html
-      #
-      def list_benchmarks(arguments={})
-        method = HTTP_GET
-        path   = "_bench"
-        params = {}
-        body   = nil
-
-        perform_request(method, path, params, body).body
-      end
-    end
-  end
-end

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

@@ -1,134 +0,0 @@
-# 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 Actions
-
-      # Return documents similar to the specified one.
-      #
-      # Performs a `more_like_this` query with the specified document as the input.
-      #
-      # @example Search for similar documents using the `title` property of document `myindex/mytype/1`
-      #
-      #     # First, let's setup a synonym-aware analyzer ("quick" <=> "fast")
-      #     client.indices.create index: 'myindex', body: {
-      #       settings: {
-      #         analysis: {
-      #           filter: {
-      #             synonyms: {
-      #               type: 'synonym',
-      #               synonyms: [ "quick,fast" ]
-      #             }
-      #           },
-      #           analyzer: {
-      #             title_synonym: {
-      #               type: 'custom',
-      #               tokenizer: 'whitespace',
-      #               filter: ['lowercase', 'stop', 'snowball', 'synonyms']
-      #             }
-      #           }
-      #         }
-      #       },
-      #       mappings: {
-      #         mytype: {
-      #           properties: {
-      #             title: {
-      #               type: 'string',
-      #               analyzer: 'title_synonym'
-      #             }
-      #           }
-      #         }
-      #       }
-      #     }
-      #
-      #     # Index three documents
-      #     client.index index: 'myindex', type: 'mytype', id: 1, body: { title: 'Quick Brown Fox'   }
-      #     client.index index: 'myindex', type: 'mytype', id: 2, body: { title: 'Slow Black Dog'    }
-      #     client.index index: 'myindex', type: 'mytype', id: 3, body: { title: 'Fast White Rabbit' }
-      #     client.indices.refresh index: 'myindex'
-      #
-      #     client.mlt index: 'myindex', type: 'mytype', id: 1, mlt_fields: 'title', min_doc_freq: 1, min_term_freq: 1
-      #     # => { ... {"title"=>"Fast White Rabbit"}}]}}
-      #
-      # @option arguments [String] :id The document ID (*Required*)
-      # @option arguments [String] :index The name of the index (*Required*)
-      # @option arguments [String] :type The type of the document (use `_all` to fetch
-      #                                  the first document matching the ID across all types) (*Required*)
-      # @option arguments [Hash] :body A specific search request definition
-      # @option arguments [Number] :boost_terms The boost factor
-      # @option arguments [Number] :max_doc_freq The word occurrence frequency as count: words with higher occurrence
-      #                                          in the corpus will be ignored
-      # @option arguments [Number] :max_query_terms The maximum query terms to be included in the generated query
-      # @option arguments [Number] :max_word_len The minimum length of the word: longer words will be ignored
-      # @option arguments [Number] :min_doc_freq The word occurrence frequency as count: words with lower occurrence
-      #                                          in the corpus will be ignored
-      # @option arguments [Number] :min_term_freq The term frequency as percent: terms with lower occurence
-      #                                           in the source document will be ignored
-      # @option arguments [Number] :min_word_len The minimum length of the word: shorter words will be ignored
-      # @option arguments [List] :mlt_fields Specific fields to perform the query against
-      # @option arguments [Number] :percent_terms_to_match How many terms have to match in order to consider
-      #                                                    the document a match (default: 0.3)
-      # @option arguments [String] :routing Specific routing value
-      # @option arguments [Number] :search_from The offset from which to return results
-      # @option arguments [List] :search_indices A comma-separated list of indices to perform the query against
-      #                                          (default: the index containing the document)
-      # @option arguments [String] :search_query_hint The search query hint
-      # @option arguments [String] :search_scroll A scroll search request definition
-      # @option arguments [Number] :search_size The number of documents to return (default: 10)
-      # @option arguments [String] :search_source A specific search request definition (instead of using the request body)
-      # @option arguments [String] :search_type Specific search type (eg. `dfs_then_fetch`, `count`, etc)
-      # @option arguments [List] :search_types A comma-separated list of types to perform the query against
-      #                                        (default: the same type as the document)
-      # @option arguments [List] :stop_words A list of stop words to be ignored
-      #
-      # @see http://elasticsearch.org/guide/reference/api/more-like-this/
-      #
-      def mlt(arguments={})
-        raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
-        raise ArgumentError, "Required argument 'type' missing"  unless arguments[:type]
-        raise ArgumentError, "Required argument 'id' missing"    unless arguments[:id]
-        method = HTTP_GET
-        path   = Utils.__pathify Utils.__escape(arguments[:index]),
-                                 Utils.__escape(arguments[:type]),
-                                 Utils.__escape(arguments[:id]),
-                                 '_mlt'
-
-        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-
-        [:mlt_fields, :search_indices, :search_types, :stop_words].each do |name|
-          params[name] = Utils.__listify(params[name]) if params[name]
-        end
-
-        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(:mlt, [
-          :boost_terms,
-          :max_doc_freq,
-          :max_query_terms,
-          :max_word_len,
-          :min_doc_freq,
-          :min_term_freq,
-          :min_word_len,
-          :mlt_fields,
-          :percent_terms_to_match,
-          :routing,
-          :search_from,
-          :search_indices,
-          :search_query_hint,
-          :search_scroll,
-          :search_size,
-          :search_source,
-          :search_type,
-          :search_types,
-          :stop_words ].freeze)
-    end
-  end
-end

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

@@ -1,66 +0,0 @@
-# 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 Actions
-
-      # Perform multiple percolate operations in a single request, similar to the {#msearch} API
-      #
-      # Pass the percolate definitions as header-body pairs in the `:body` argument, as an Array of Hashes.
-      #
-      # @example Perform two different percolations in a single request
-      #
-      #     client.mpercolate \
-      #         body: [
-      #           { percolate: { index: "my-index", type: "my-type" } },
-      #           { doc: { message: "foo bar" } },
-      #           { percolate: { index: "my-other-index", type: "my-other-type", id: "1" } },
-      #           { }
-      #         ]
-      #
-      # @option arguments [String] :index The index of the document being count percolated to use as default
-      # @option arguments [String] :type The type of the document being percolated to use as default.
-      # @option arguments [Array<Hash>]  The percolate request definitions (header & body pairs) (*Required*)
-      # @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)
-      #
-      # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-percolate.html
-      #
-      def mpercolate(arguments={})
-        raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
-        method = HTTP_GET
-        path   = "_mpercolate"
-
-        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-        body   = arguments[:body]
-
-        case
-        when body.is_a?(Array)
-          payload = body.map { |d| d.is_a?(String) ? d : Elasticsearch::API.serializer.dump(d) }
-          payload << "" unless payload.empty?
-          payload = payload.join("\n")
-        else
-          payload = body
-        end
-
-        perform_request(method, path, params, payload).body
-      end
-
-      # Register this action with its valid params when the module is loaded.
-      #
-      # @since 6.2.0
-      ParamsRegistry.register(:mpercolate, [
-          :ignore_unavailable,
-          :allow_no_indices,
-          :expand_wildcards,
-          :percolate_format ].freeze)
-    end
-  end
-end