elasticsearch-api 6.8.0 → 7.10.0

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

@@ -1,7 +1,23 @@
+# 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
-
       # Run a single query, or a set of queries, and return statistics on their performance
       #
       # @example Return statistics for a single query
@@ -45,9 +61,9 @@ module Elasticsearch
       # @option arguments [Boolean] :verbose Specify whether to return verbose statistics about each iteration
       #                                      (default: false)
       #
-      # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-benchmark.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/search-benchmark.html
       #
-      def benchmark(arguments={})
+      def benchmark(arguments = {})
         method = HTTP_PUT
         path   = "_bench"
         params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
@@ -58,8 +74,8 @@ module Elasticsearch
 
       # Register this action with its valid params when the module is loaded.
       #
-      # @since 6.2.0
-      ParamsRegistry.register(:benchmark, [ :verbose ].freeze)
+      # @since 6.1.1
+      ParamsRegistry.register(:benchmark, [:verbose].freeze)
     end
   end
 end

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

@@ -1,104 +1,89 @@
+# 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
-
-      # Perform multiple index, delete or update operations in a single request.
-      #
-      # Supports various different formats of the payload: Array of Strings, Header/Data pairs,
-      # or the conveniency "combined" format where data is passed along with the header
-      # in a single item in a custom `:data` key.
-      #
-      # @note The body argument is required and cannot be empty.
-      #
-      # @example Perform three operations in a single request, passing actions and data as an array of hashes
-      #
-      #     client.bulk body: [
-      #       { index: { _index: 'myindex', _type: 'mytype', _id: 1 } },
-      #       { title: 'foo' },
-      #
-      #       { index: { _index: 'myindex', _type: 'mytype', _id: 2 } },
-      #       { title: 'foo' },
-      #
-      #       { delete: { _index: 'myindex', _type: 'mytype', _id: 3  } }
-      #     ]
-      # @example Perform three operations in a single request, passing data in the `:data` option
-      #
-      #     client.bulk body: [
-      #       { index:  { _index: 'myindex', _type: 'mytype', _id: 1, data: { title: 'foo' } } },
-      #       { update: { _index: 'myindex', _type: 'mytype', _id: 2, data: { doc: { title: 'foo' } } } },
-      #       { delete: { _index: 'myindex', _type: 'mytype', _id: 3  } }
-      #     ]
-      #
-      # @example Perform a script-based bulk update, passing scripts in the `:data` option
-      #
-      #     client.bulk body: [
-      #       { update: { _index: 'myindex', _type: 'mytype', _id: 1,
-      #                  data: {
-      #                   script: "ctx._source.counter += value",
-      #                   lang: 'js',
-      #                   params: { value: 1 }, upsert: { counter: 0 } }
-      #                 }},
-      #       { update: { _index: 'myindex', _type: 'mytype', _id: 2,
-      #                  data: {
-      #                   script: "ctx._source.counter += value",
-      #                   lang: 'js',
-      #                   params: { value: 42 }, upsert: { counter: 0 } }
-      #                  }}
-      #
-      #     ]
+      # Allows to perform multiple index/update/delete operations in a single request.
       #
       # @option arguments [String] :index Default index for items which don't provide one
       # @option arguments [String] :type Default document type for items which don't provide one
-      # @option arguments [Hash] :body The operation definition and data (action-data pairs), separated by newlines (*Required*) Note that this cannot be empty.
       # @option arguments [String] :wait_for_active_shards Sets the number of shard copies that must be active before proceeding with the bulk operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)
-      # @option arguments [String] :refresh If `true` then refresh the effected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes. (options: true, false, wait_for)
+      # @option arguments [String] :refresh If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes. (options: true, false, wait_for)
       # @option arguments [String] :routing Specific routing value
       # @option arguments [Time] :timeout Explicit operation timeout
-      # @option arguments [String] :type Default document type for items which don't provide one
-      # @option arguments [List] :fields Default comma-separated list of fields to return in the response for updates, can be overridden on each sub-request
       # @option arguments [List] :_source True or false to return the _source field or not, or default list of fields to return, can be overridden on each sub-request
       # @option arguments [List] :_source_excludes Default list of fields to exclude from the returned _source field, can be overridden on each sub-request
       # @option arguments [List] :_source_includes Default list of fields to extract and return from the _source field, can be overridden on each sub-request
       # @option arguments [String] :pipeline The pipeline id to preprocess incoming documents with
+      # @option arguments [Boolean] :require_alias Sets require_alias for all incoming documents. Defaults to unset (false)
+      # @option arguments [Hash] :headers Custom HTTP headers
+      # @option arguments [String|Array] :body The operation definition and data (action-data pairs), separated by newlines. Array of Strings, Header/Data pairs,
+      # or the conveniency "combined" format can be passed, refer to Elasticsearch::API::Utils.__bulkify documentation.
       #
-      # @return [Hash] Deserialized Elasticsearch response
-      #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-bulk.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/docs-bulk.html
       #
-      def bulk(arguments={})
+      def bulk(arguments = {})
+        raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+
+        headers = arguments.delete(:headers) || {}
+
         arguments = arguments.clone
 
-        type      = arguments.delete(:type)
+        _index = arguments.delete(:index)
 
-        method = HTTP_POST
-        path   = Utils.__pathify Utils.__escape(arguments[:index]), Utils.__escape(type), '_bulk'
+        _type = arguments.delete(:type)
 
+        method = Elasticsearch::API::HTTP_POST
+        path   = if _index && _type
+                   "#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/_bulk"
+                 elsif _index
+                   "#{Utils.__listify(_index)}/_bulk"
+                 else
+                   "_bulk"
+                 end
         params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-        body   = arguments[:body]
 
+        body = arguments[:body]
         if body.is_a? Array
-          payload = Utils.__bulkify(body)
+          payload = Elasticsearch::API::Utils.__bulkify(body)
         else
           payload = body
         end
 
-        perform_request(method, path, params, payload, {"Content-Type" => "application/x-ndjson"}).body
+        headers.merge!("Content-Type" => "application/x-ndjson")
+        perform_request(method, path, params, payload, headers).body
       end
 
       # Register this action with its valid params when the module is loaded.
       #
       # @since 6.2.0
       ParamsRegistry.register(:bulk, [
-          :wait_for_active_shards,
-          :refresh,
-          :routing,
-          :timeout,
-          :type,
-          :fields,
-          :_source,
-          :_source_excludes,
-          :_source_includes,
-          :pipeline ].freeze)
+        :wait_for_active_shards,
+        :refresh,
+        :routing,
+        :timeout,
+        :type,
+        :_source,
+        :_source_excludes,
+        :_source_includes,
+        :pipeline,
+        :require_alias
+      ].freeze)
     end
   end
 end

data/lib/elasticsearch/api/actions/cat/aliases.rb

@@ -1,70 +1,70 @@
+# 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 Cat
       module Actions
-
-        # Returns information about aliases, including associated routing values and filters.
-        #
-        # @example Display all aliases in the cluster
-        #
-        #     puts client.cat.aliases
-        #
-        # @example Display indices for the 'year-2013' alias
-        #
-        #     puts client.cat.aliases name: 'year-2013'
-        #
-        # @example Display header names in the output
-        #
-        #     puts client.cat.aliases v: true
-        #
-        # @example Return only the 'alias' and 'index' columns
-        #
-        #     puts client.cat.aliases h: ['alias', 'index']
-        #
-        # @example Return only the 'alias' and 'index' columns, using short names
-        #
-        #     puts client.cat.aliases h: 'a,i'
-        #
-        # @example Return the output sorted by the alias name
-        #
-        #     puts client.cat.aliases s: 'alias'
-        #
-        # @example Return the information as Ruby objects
-        #
-        #     client.cat.aliases format: 'json'
+        # Shows information about currently configured aliases to indices including filter and routing infos.
         #
         # @option arguments [List] :name A comma-separated list of alias names to return
         # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
         # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
-        # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
         # @option arguments [List] :h Comma-separated list of column names to display
         # @option arguments [Boolean] :help Return help information
         # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
         # @option arguments [Boolean] :v Verbose mode. Display column headers
+        # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
+        # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cat-aliases.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/cat-alias.html
         #
-        def aliases(arguments={})
-          name = arguments.delete(:name)
-          method = HTTP_GET
-          path   = Utils.__pathify '_cat/aliases', Utils.__listify(name)
+        def aliases(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
+          arguments = arguments.clone
+
+          _name = arguments.delete(:name)
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = if _name
+                     "_cat/aliases/#{Utils.__listify(_name)}"
+                   else
+                     "_cat/aliases"
+                   end
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
           params[:h] = Utils.__listify(params[:h]) if params[:h]
-          body   = nil
-          perform_request(method, path, params, body).body
+
+          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(:aliases, [
-            :format,
-            :local,
-            :master_timeout,
-            :h,
-            :help,
-            :s,
-            :v ].freeze)
+          :format,
+          :local,
+          :h,
+          :help,
+          :s,
+          :v,
+          :expand_wildcards
+        ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/cat/allocation.rb

@@ -1,33 +1,25 @@
+# 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 Cat
       module Actions
-
-        # Return shard allocation information
-        #
-        # @example Display allocation for all nodes in the cluster
-        #
-        #     puts client.cat.allocation
-        #
-        # @example Display allocation for node with name 'node-1'
-        #
-        #     puts client.cat.allocation node_id: 'node-1'
-        #
-        # @example Display header names in the output
-        #
-        #     puts client.cat.allocation v: true
-        #
-        # @example Display only specific columns in the output (see the `help` parameter)
-        #
-        #     puts client.cat.allocation h: ['node', 'shards', 'disk.percent']
-        #
-        # @example Display only specific columns in the output, using the short names
-        #
-        #     puts client.cat.allocation h: 'n,s,dp'
-        #
-        # @example Return the information as Ruby objects
-        #
-        #     client.cat.allocation format: 'json'
+        # Provides a snapshot of how many shards are allocated to each data node and how much disk space they are using.
         #
         # @option arguments [List] :node_id A comma-separated list of node IDs or names to limit the returned information
         # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
@@ -38,31 +30,43 @@ module Elasticsearch
         # @option arguments [Boolean] :help Return help information
         # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
         # @option arguments [Boolean] :v Verbose mode. Display column headers
+        # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cat-allocation.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/cat-allocation.html
         #
-        def allocation(arguments={})
-          node_id = arguments.delete(:node_id)
-          method = HTTP_GET
-          path   = Utils.__pathify '_cat/allocation', Utils.__listify(node_id)
+        def allocation(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
+          arguments = arguments.clone
+
+          _node_id = arguments.delete(:node_id)
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = if _node_id
+                     "_cat/allocation/#{Utils.__listify(_node_id)}"
+                   else
+                     "_cat/allocation"
+                   end
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
           params[:h] = Utils.__listify(params[:h]) if params[:h]
-          body   = nil
-          perform_request(method, path, params, body).body
+
+          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(:allocation, [
-            :format,
-            :bytes,
-            :local,
-            :master_timeout,
-            :h,
-            :help,
-            :s,
-            :v ].freeze)
+          :format,
+          :bytes,
+          :local,
+          :master_timeout,
+          :h,
+          :help,
+          :s,
+          :v
+        ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/cat/count.rb

@@ -1,67 +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 Cat
       module Actions
-
-        # Return document counts for the entire cluster or specific indices
-        #
-        # @example Display number of documents in the cluster
-        #
-        #     puts client.cat.count
-        #
-        # @example Display number of documents in an index
-        #
-        #     puts client.cat.count index: 'index-a'
-        #
-        # @example Display number of documents in a list of indices
-        #
-        #     puts client.cat.count index: ['index-a', 'index-b']
-        #
-        # @example Display header names in the output
-        #
-        #     puts client.cat.count v: true
-        #
-        # @example Return the information as Ruby objects
-        #
-        #     client.cat.count format: 'json'
+        # Provides quick access to the document count of the entire cluster, or individual indices.
         #
         # @option arguments [List] :index A comma-separated list of index names to limit the returned information
         # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
-        # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
-        # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
         # @option arguments [List] :h Comma-separated list of column names to display
         # @option arguments [Boolean] :help Return help information
         # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
         # @option arguments [Boolean] :v Verbose mode. Display column headers
+        # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cat-count.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/cat-count.html
         #
-        def count(arguments={})
-          index = arguments.delete(:index)
+        def count(arguments = {})
+          headers = arguments.delete(:headers) || {}
 
-          method = HTTP_GET
+          arguments = arguments.clone
 
-          path   = Utils.__pathify '_cat/count', Utils.__listify(index)
+          _index = arguments.delete(:index)
 
+          method = Elasticsearch::API::HTTP_GET
+          path   = if _index
+                     "_cat/count/#{Utils.__listify(_index)}"
+                   else
+                     "_cat/count"
+                   end
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
           params[:h] = Utils.__listify(params[:h]) if params[:h]
 
-          body   = nil
-
-          perform_request(method, path, params, body).body
+          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(:count, [
-            :format,
-            :local,
-            :master_timeout,
-            :h,
-            :help,
-            :s,
-            :v ].freeze)
+          :format,
+          :h,
+          :help,
+          :s,
+          :v
+        ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/cat/fielddata.rb

@@ -1,55 +1,68 @@
+# 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 Cat
       module Actions
-
-        # Return information about field data usage across the cluster
-        #
-        # @example Return the total size of field data
-        #
-        #     client.cat.fielddata
-        #
-        # @example Return both the total size and size for specific fields
-        #
-        #     client.cat.fielddata fields: 'title,body'
+        # Shows how much heap memory is currently being used by fielddata on every data node in the cluster.
         #
         # @option arguments [List] :fields A comma-separated list of fields to return the fielddata size
         # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
         # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb)
-        # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
-        # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
         # @option arguments [List] :h Comma-separated list of column names to display
         # @option arguments [Boolean] :help Return help information
         # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
         # @option arguments [Boolean] :v Verbose mode. Display column headers
-        # @option arguments [List] :fields A comma-separated list of fields to return in the output
+        # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cat-fielddata.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/cat-fielddata.html
         #
-        def fielddata(arguments={})
-          fields = arguments.delete(:fields)
+        def fielddata(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
+          arguments = arguments.clone
+
+          _fields = arguments.delete(:fields)
 
-          method = HTTP_GET
-          path   = Utils.__pathify "_cat/fielddata", Utils.__listify(fields)
+          method = Elasticsearch::API::HTTP_GET
+          path   = if _fields
+                     "_cat/fielddata/#{Utils.__listify(_fields)}"
+                   else
+                     "_cat/fielddata"
+                   end
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-          body   = nil
 
-          perform_request(method, path, params, body).body
+          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(:fielddata, [
-            :format,
-            :bytes,
-            :local,
-            :master_timeout,
-            :h,
-            :help,
-            :s,
-            :v,
-            :fields ].freeze)
+          :format,
+          :bytes,
+          :h,
+          :help,
+          :s,
+          :v,
+          :fields
+        ].freeze)
       end
     end
   end