elasticsearch-api 6.8.0 → 7.10.0

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

@@ -1,8 +1,24 @@
+# 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 Indices
       module Actions
-
         # In order to keep indices available and queryable for a longer period but at the same time reduce their
         #   hardware requirements they can be transitioned into a frozen state. Once an index is frozen, all of its
         #   transient shard memory (aside from mappings and analyzers) is moved to persistent storage.
@@ -17,12 +33,13 @@ module Elasticsearch
           raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
 
           valid_params = [
-              :timeout,
-              :master_timeout,
-              :ignore_unavailable,
-              :allow_no_indices,
-              :expand_wildcards,
-              :wait_for_active_shards]
+            :timeout,
+            :master_timeout,
+            :ignore_unavailable,
+            :allow_no_indices,
+            :expand_wildcards,
+            :wait_for_active_shards
+          ]
 
           arguments = arguments.clone
           index = arguments.delete(:index)

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

@@ -1,53 +1,55 @@
+# 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 Indices
       module Actions
-
-        # Perform multiple operation on index aliases in a single request.
-        #
-        # Pass the `actions` (add, remove) in the `body` argument.
-        #
-        # @example Add multiple indices to a single alias
-        #
-        #     client.indices.update_aliases body: {
-        #       actions: [
-        #         { add: { index: 'logs-2013-06', alias: 'year-2013' } },
-        #         { add: { index: 'logs-2013-05', alias: 'year-2013' } }
-        #       ]
-        #     }
-        #
-        # @example Swap an alias (atomic operation)
-        #
-        #     client.indices.update_aliases body: {
-        #       actions: [
-        #         { remove: { index: 'logs-2013-06', alias: 'current-month' } },
-        #         { add:    { index: 'logs-2013-07', alias: 'current-month' } }
-        #       ]
-        #     }
+        # Updates index aliases.
         #
-        # @option arguments [Hash] :body The definition of `actions` to perform (*Required*)
         # @option arguments [Time] :timeout Request timeout
         # @option arguments [Time] :master_timeout Specify timeout for connection to master
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body The definition of `actions` to perform (*Required*)
         #
-        # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-aliases.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/indices-aliases.html
         #
-        def update_aliases(arguments={})
+        def update_aliases(arguments = {})
           raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
-          method = HTTP_POST
-          path   = "_aliases"
 
+          headers = arguments.delete(:headers) || {}
+
+          arguments = arguments.clone
+
+          method = Elasticsearch::API::HTTP_POST
+          path   = "_aliases"
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-          body   = arguments[:body]
 
-          perform_request(method, path, params, body).body
+          body = arguments[:body]
+          perform_request(method, path, params, body, headers).body
         end
 
         # Register this action with its valid params when the module is loaded.
         #
         # @since 6.2.0
         ParamsRegistry.register(:update_aliases, [
-            :timeout,
-            :master_timeout ].freeze)
+          :timeout,
+          :master_timeout
+        ].freeze)
       end
     end
   end

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

@@ -1,37 +1,65 @@
+# 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 Indices
       module Actions
-
-        # Upgrade the index or indices to the latest Lucene format.
+        # The _upgrade API is no longer useful and will be removed.
         #
         # @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, none, all)
+        # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
         # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
         # @option arguments [Boolean] :wait_for_completion Specify whether the request should block until the all segments are upgraded (default: false)
         # @option arguments [Boolean] :only_ancient_segments If true, only ancient (an older Lucene major release) segments will be upgraded
+        # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-upgrade.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/indices-upgrade.html
         #
-        def upgrade(arguments={})
-          method = HTTP_POST
-          path   = "_upgrade"
+        def upgrade(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
+          arguments = arguments.clone
+
+          _index = arguments.delete(:index)
+
+          method = Elasticsearch::API::HTTP_POST
+          path   = if _index
+                     "#{Utils.__listify(_index)}/_upgrade"
+                   else
+                     "_upgrade"
+                   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(:upgrade, [
-            :allow_no_indices,
-            :expand_wildcards,
-            :ignore_unavailable,
-            :wait_for_completion,
-            :only_ancient_segments ].freeze)
+          :allow_no_indices,
+          :expand_wildcards,
+          :ignore_unavailable,
+          :wait_for_completion,
+          :only_ancient_segments
+        ].freeze)
       end
     end
   end

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

@@ -1,49 +1,32 @@
+# 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 Indices
       module Actions
-
-        # Validate a query
-        #
-        # @example Validate a simple query string query
-        #
-        #     client.indices.validate_query index: 'myindex', q: 'title:foo AND body:bar'
-        #
-        # @example Validate an invalid query (with explanation)
-        #
-        #     client.indices.validate_query index: 'myindex', q: '[[[ BOOM! ]]]', explain: true
-        #
-        # @example Validate a DSL query (with explanation and rewrite). With rewrite set to true, the 
-        #                                explanation is more detailed showing the actual Lucene query that will 
-        #                                be executed.
-        #
-        #     client.indices.validate_query index: 'myindex',
-        #                                   rewrite: true,
-        #                                   explain: true,
-        #                                   body: {
-        #                                     filtered: {
-        #                                       query: {
-        #                                         match: {
-        #                                           title: 'foo'
-        #                                         }
-        #                                       },
-        #                                       filter: {
-        #                                         range: {
-        #                                           published_at: {
-        #                                             from: '2013-06-01'
-        #                                           }
-        #                                         }
-        #                                       }
-        #                                     }
-        #                                   }
+        # Allows a user to validate a potentially expensive query without executing it.
         #
         # @option arguments [List] :index A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices
-        # @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 [Hash] :body The query definition specified with the Query DSL
+        # @option arguments [List] :type A comma-separated list of document types to restrict the operation; leave empty to perform the operation on all types *Deprecated*
         # @option arguments [Boolean] :explain Return detailed information about the error
         # @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)
+        # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
         # @option arguments [String] :q Query in the Lucene query string syntax
         # @option arguments [String] :analyzer The analyzer to use for the query string
         # @option arguments [Boolean] :analyze_wildcard Specify whether wildcard and prefix queries should be analyzed (default: false)
@@ -52,37 +35,61 @@ module Elasticsearch
         # @option arguments [Boolean] :lenient Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
         # @option arguments [Boolean] :rewrite Provide a more detailed explanation showing the actual Lucene query that will be executed.
         # @option arguments [Boolean] :all_shards Execute validation on all shards instead of one random shard per index
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body The query definition specified with the Query DSL
+        #
+        # *Deprecation notice*:
+        # Specifying types in urls has been deprecated
+        # Deprecated since version 7.0.0
+        #
         #
-        # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/search-validate.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/search-validate.html
         #
-        def validate_query(arguments={})
-          method = HTTP_GET
-          path   = Utils.__pathify Utils.__listify(arguments[:index]),
-                                   Utils.__listify(arguments[:type]),
-                                   '_validate/query'
+        def validate_query(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
+          arguments = arguments.clone
+
+          _index = arguments.delete(:index)
+
+          _type = arguments.delete(:type)
+
+          method = if arguments[:body]
+                     Elasticsearch::API::HTTP_POST
+                   else
+                     Elasticsearch::API::HTTP_GET
+                   end
 
+          path = if _index && _type
+                   "#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/_validate/query"
+                 elsif _index
+                   "#{Utils.__listify(_index)}/_validate/query"
+                 else
+                   "_validate/query"
+                 end
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-          body   = arguments[:body]
 
-          perform_request(method, path, params, body).body
+          body = arguments[:body]
+          perform_request(method, path, params, body, headers).body
         end
 
         # Register this action with its valid params when the module is loaded.
         #
         # @since 6.2.0
         ParamsRegistry.register(:validate_query, [
-            :explain,
-            :ignore_unavailable,
-            :allow_no_indices,
-            :expand_wildcards,
-            :q,
-            :analyzer,
-            :analyze_wildcard,
-            :default_operator,
-            :df,
-            :lenient,
-            :rewrite,
-            :all_shards ].freeze)
+          :explain,
+          :ignore_unavailable,
+          :allow_no_indices,
+          :expand_wildcards,
+          :q,
+          :analyzer,
+          :analyze_wildcard,
+          :default_operator,
+          :df,
+          :lenient,
+          :rewrite,
+          :all_shards
+        ].freeze)
       end
     end
   end

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

@@ -1,25 +1,41 @@
+# 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
-
-      # Return simple information about the cluster (name, version).
+      # Returns basic information about the cluster.
       #
-      # @see http://elasticsearch.org/guide/
+      # @option arguments [Hash] :headers Custom HTTP headers
       #
-      def info(arguments={})
-        method = HTTP_GET
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/index.html
+      #
+      def info(arguments = {})
+        headers = arguments.delete(:headers) || {}
+
+        arguments = arguments.clone
+
+        method = Elasticsearch::API::HTTP_GET
         path   = ""
         params = {}
-        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(:info, [
-      ].freeze)
     end
   end
 end

data/lib/elasticsearch/api/actions/ingest/delete_pipeline.rb

@@ -1,32 +1,57 @@
+# 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 Ingest
       module Actions
-
-        # Delete a speficied pipeline
+        # Deletes a pipeline.
         #
-        # @option arguments [String] :id Pipeline ID (*Required*)
+        # @option arguments [String] :id Pipeline ID
         # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
         # @option arguments [Time] :timeout Explicit operation timeout
+        # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/plugins/current/ingest.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/delete-pipeline-api.html
         #
-        def delete_pipeline(arguments={})
+        def delete_pipeline(arguments = {})
           raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
-          method = 'DELETE'
-          path   = Utils.__pathify "_ingest/pipeline", Utils.__escape(arguments[:id])
+
+          headers = arguments.delete(:headers) || {}
+
+          arguments = arguments.clone
+
+          _id = arguments.delete(:id)
+
+          method = Elasticsearch::API::HTTP_DELETE
+          path   = "_ingest/pipeline/#{Utils.__listify(_id)}"
           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(:delete_pipeline, [
-            :master_timeout,
-            :timeout ].freeze)
+          :master_timeout,
+          :timeout
+        ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/ingest/get_pipeline.rb

@@ -1,29 +1,57 @@
+# 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 Ingest
       module Actions
-
-        # Return a specified pipeline
+        # Returns a pipeline.
         #
         # @option arguments [String] :id Comma separated list of pipeline ids. Wildcards supported
         # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
+        # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/plugins/current/ingest.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/get-pipeline-api.html
         #
-        def get_pipeline(arguments={})
-          method = 'GET'
-          path   = Utils.__pathify "_ingest/pipeline", Utils.__escape(arguments[:id])
+        def get_pipeline(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
+          arguments = arguments.clone
+
+          _id = arguments.delete(:id)
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = if _id
+                     "_ingest/pipeline/#{Utils.__listify(_id)}"
+                   else
+                     "_ingest/pipeline"
+                   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(:get_pipeline, [
-            :master_timeout ].freeze)
+          :master_timeout
+        ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/ingest/params_registry.rb

@@ -1,14 +1,30 @@
+# 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 Ingest
       module Actions
         module ParamsRegistry
-
           extend self
 
           # A Mapping of all the actions to their list of valid params.
           #
-          # @since 6.2.0
+          # @since 6.1.1
           PARAMS = {}
 
           # Register an action with its list of valid params.
@@ -19,7 +35,7 @@ module Elasticsearch
           # @param [ Symbol ] action The action to register.
           # @param [ Array[Symbol] ] valid_params The list of valid params.
           #
-          # @since 6.2.0
+          # @since 6.1.1
           def register(action, valid_params)
             PARAMS[action.to_sym] = valid_params
           end
@@ -33,7 +49,7 @@ module Elasticsearch
           #
           # @return [ Array<Symbol> ] The list of valid params for the action.
           #
-          # @since 6.2.0
+          # @since 6.1.1
           def get(action)
             PARAMS.fetch(action, [])
           end

data/lib/elasticsearch/api/actions/ingest/processor_grok.rb

@@ -1,28 +1,42 @@
+# 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 Ingest
       module Actions
-
-        # Extracts structured fields out of a single text field within a document. You choose which field to extract
-        #   matched fields from, as well as the grok pattern you expect will match.
+        # Returns a list of the built-in patterns.
         #
+        # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/plugins/current/ingest.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/grok-processor.html#grok-processor-rest-get
         #
-        def processor_grok(arguments={})
+        def processor_grok(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
+          arguments = arguments.clone
+
           method = Elasticsearch::API::HTTP_GET
           path   = "_ingest/processor/grok"
           params = {}
-          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(:processor_grok, [
-        ].freeze)
       end
     end
   end