elasticsearch-api 7.2.0 → 8.0.0

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

@@ -6,7 +6,7 @@
 # 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
+#   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
@@ -18,72 +18,40 @@
 module Elasticsearch
   module API
     module Actions
-
-      # Copy documents from one index to another, potentially changing
-      # its settings, mappings and the documents itself.
-      #
-      # @example Copy documents into a different index
-      #
-      #     client.reindex body: { source: { index: 'test1' }, dest: { index: 'test2' } }
-      #
-      # @example Limit the copied documents with a query
+      # Allows to copy documents from one index to another, optionally filtering the source
+      # documents by a query, changing the destination index settings, or fetching the
+      # documents from a remote cluster.
       #
-      #     client.reindex body: {
-      #       source: {
-      #         index: 'test1',
-      #         query: { terms: { category: ['one', 'two'] }  }
-      #       },
-      #       dest: {
-      #         index: 'test2'
-      #       }
-      #     }
-      #
-      # @example Remove a field from reindexed documents
-      #
-      #     client.reindex body: {
-      #       source: {
-      #         index: 'test1'
-      #       },
-      #       dest: {
-      #         index: 'test3'
-      #       },
-      #       script: {
-      #         inline: 'ctx._source.remove("category")'
-      #       }
-      #     }
-      #
-      # @option arguments [Hash] :body The search definition using the Query DSL and the prototype for the index request. (*Required*)
-      # @option arguments [Boolean] :refresh Should the effected indexes be refreshed?
+      # @option arguments [Boolean] :refresh Should the affected indexes be refreshed?
       # @option arguments [Time] :timeout Time each individual bulk request should wait for shards that are unavailable.
       # @option arguments [String] :wait_for_active_shards Sets the number of shard copies that must be active before proceeding with the reindex 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 [Boolean] :wait_for_completion Should the request should block until the reindex is complete.
       # @option arguments [Number] :requests_per_second The throttle to set on this request in sub-requests per second. -1 means no throttle.
       # @option arguments [Time] :scroll Control how long to keep the search context alive
-      # @option arguments [Number] :slices The number of slices this task should be divided into. Defaults to 1 meaning the task isn't sliced into subtasks.
+      # @option arguments [Number|string] :slices The number of slices this task should be divided into. Defaults to 1, meaning the task isn't sliced into subtasks. Can be set to `auto`.
+      # @option arguments [Number] :max_docs Maximum number of documents to process (default: all documents)
+      # @option arguments [Hash] :headers Custom HTTP headers
+      # @option arguments [Hash] :body The search definition using the Query DSL and the prototype for the index request. (*Required*)
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-reindex.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-reindex.html
       #
-      def reindex(arguments={})
+      def reindex(arguments = {})
         raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
-        method = 'POST'
+
+        headers = arguments.delete(:headers) || {}
+
+        body = arguments.delete(:body)
+
+        arguments = arguments.clone
+
+        method = Elasticsearch::API::HTTP_POST
         path   = "_reindex"
-        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-        body   = arguments[:body]
+        params = Utils.process_params(arguments)
 
-        perform_request(method, path, params, body).body
+        Elasticsearch::API::Response.new(
+          perform_request(method, path, params, body, headers)
+        )
       end
-
-      # Register this action with its valid params when the module is loaded.
-      #
-      # @since 6.1.1
-      ParamsRegistry.register(:reindex, [
-          :refresh,
-          :timeout,
-          :wait_for_active_shards,
-          :wait_for_completion,
-          :requests_per_second,
-          :scroll,
-          :slices ].freeze)
     end
   end
 end

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

@@ -6,7 +6,7 @@
 # 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
+#   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
@@ -18,29 +18,33 @@
 module Elasticsearch
   module API
     module Actions
-
-      # The value of requests_per_second can be changed on a running reindex using the _rethrottle
+      # Changes the number of requests per second for a particular Reindex operation.
       #
-      # @option arguments [String] :task_id The task id to rethrottle (*Required*)
-      # @option arguments [Number] :requests_per_second The throttle to set on this request in floating sub-requests per second. -1 means set no throttle.
+      # @option arguments [String] :task_id The task id to rethrottle
+      # @option arguments [Number] :requests_per_second The throttle to set on this request in floating sub-requests per second. -1 means set no throttle. (*Required*)
+      # @option arguments [Hash] :headers Custom HTTP headers
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-reindex.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-reindex.html
       #
-      def reindex_rethrottle(arguments={})
+      def reindex_rethrottle(arguments = {})
         raise ArgumentError, "Required argument 'task_id' missing" unless arguments[:task_id]
+
+        headers = arguments.delete(:headers) || {}
+
+        body = nil
+
+        arguments = arguments.clone
+
+        _task_id = arguments.delete(:task_id)
+
         method = Elasticsearch::API::HTTP_POST
-        path   = "_reindex/#{arguments[:task_id]}/_rethrottle"
-        params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-        body   = nil
+        path   = "_reindex/#{Utils.__listify(_task_id)}/_rethrottle"
+        params = Utils.process_params(arguments)
 
-        perform_request(method, path, params, body).body
+        Elasticsearch::API::Response.new(
+          perform_request(method, path, params, body, headers)
+        )
       end
-
-      # Register this action with its valid params when the module is loaded.
-      #
-      # @since 6.2.0
-      ParamsRegistry.register(:reindex_rethrottle, [
-          :requests_per_second ].freeze)
     end
   end
-end
+end

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

@@ -6,7 +6,7 @@
 # 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
+#   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
@@ -18,28 +18,40 @@
 module Elasticsearch
   module API
     module Actions
-
-      # Pre-render search requests before they are executed and fill existing templates with template parameters
+      # Allows to use the Mustache language to pre-render a search definition.
       #
       # @option arguments [String] :id The id of the stored search template
+      # @option arguments [Hash] :headers Custom HTTP headers
       # @option arguments [Hash] :body The search definition template and its params
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/search-template.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/render-search-template-api.html
       #
-      def render_search_template(arguments={})
-        method = 'GET'
-        path   = "_render/template"
-        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-        body   = arguments[:body]
+      def render_search_template(arguments = {})
+        headers = arguments.delete(:headers) || {}
 
-        perform_request(method, path, params, body).body
-      end
+        body = arguments.delete(:body)
 
-      # Register this action with its valid params when the module is loaded.
-      #
-      # @since 6.1.1
-      ParamsRegistry.register(:render_search_template, [
-          :id ].freeze)
+        arguments = arguments.clone
+
+        _id = arguments.delete(:id)
+
+        method = if body
+                   Elasticsearch::API::HTTP_POST
+                 else
+                   Elasticsearch::API::HTTP_GET
+                 end
+
+        path   = if _id
+                   "_render/template/#{Utils.__listify(_id)}"
+                 else
+                   "_render/template"
+                 end
+        params = {}
+
+        Elasticsearch::API::Response.new(
+          perform_request(method, path, params, body, headers)
+        )
+      end
     end
   end
 end

data/lib/elasticsearch/api/actions/rollup/delete_job.rb

@@ -0,0 +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 Rollup
+      module Actions
+        # Deletes an existing rollup job.
+        # This functionality is Experimental and may be changed or removed
+        # completely in a future release. Elastic will take a best effort approach
+        # to fix any issues, but experimental features are not subject to the
+        # support SLA of official GA features.
+        #
+        # @option arguments [String] :id The ID of the job to delete
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-delete-job.html
+        #
+        def delete_job(arguments = {})
+          raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
+
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          arguments = arguments.clone
+
+          _id = arguments.delete(:id)
+
+          method = Elasticsearch::API::HTTP_DELETE
+          path   = "_rollup/job/#{Utils.__listify(_id)}"
+          params = {}
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/rollup/get_jobs.rb

@@ -0,0 +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 Rollup
+      module Actions
+        # Retrieves the configuration, stats, and status of rollup jobs.
+        # This functionality is Experimental and may be changed or removed
+        # completely in a future release. Elastic will take a best effort approach
+        # to fix any issues, but experimental features are not subject to the
+        # support SLA of official GA features.
+        #
+        # @option arguments [String] :id The ID of the job(s) to fetch. Accepts glob patterns, or left blank for all jobs
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-get-job.html
+        #
+        def get_jobs(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          arguments = arguments.clone
+
+          _id = arguments.delete(:id)
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = if _id
+                     "_rollup/job/#{Utils.__listify(_id)}"
+                   else
+                     "_rollup/job"
+                   end
+          params = {}
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/rollup/get_rollup_caps.rb

@@ -0,0 +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 Rollup
+      module Actions
+        # Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern.
+        # This functionality is Experimental and may be changed or removed
+        # completely in a future release. Elastic will take a best effort approach
+        # to fix any issues, but experimental features are not subject to the
+        # support SLA of official GA features.
+        #
+        # @option arguments [String] :id The ID of the index to check rollup capabilities on, or left blank for all jobs
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-get-rollup-caps.html
+        #
+        def get_rollup_caps(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          arguments = arguments.clone
+
+          _id = arguments.delete(:id)
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = if _id
+                     "_rollup/data/#{Utils.__listify(_id)}"
+                   else
+                     "_rollup/data"
+                   end
+          params = {}
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/rollup/get_rollup_index_caps.rb

@@ -0,0 +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 Rollup
+      module Actions
+        # Returns the rollup capabilities of all jobs inside of a rollup index (e.g. the index where rollup data is stored).
+        # This functionality is Experimental and may be changed or removed
+        # completely in a future release. Elastic will take a best effort approach
+        # to fix any issues, but experimental features are not subject to the
+        # support SLA of official GA features.
+        #
+        # @option arguments [String] :index The rollup index or index pattern to obtain rollup capabilities from.
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-get-rollup-index-caps.html
+        #
+        def get_rollup_index_caps(arguments = {})
+          raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
+
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          arguments = arguments.clone
+
+          _index = arguments.delete(:index)
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = "#{Utils.__listify(_index)}/_rollup/data"
+          params = {}
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/rollup/put_job.rb

@@ -0,0 +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 Rollup
+      module Actions
+        # Creates a rollup job.
+        # This functionality is Experimental and may be changed or removed
+        # completely in a future release. Elastic will take a best effort approach
+        # to fix any issues, but experimental features are not subject to the
+        # support SLA of official GA features.
+        #
+        # @option arguments [String] :id The ID of the job to create
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body The job configuration (*Required*)
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-put-job.html
+        #
+        def put_job(arguments = {})
+          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+          raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
+
+          headers = arguments.delete(:headers) || {}
+
+          body = arguments.delete(:body)
+
+          arguments = arguments.clone
+
+          _id = arguments.delete(:id)
+
+          method = Elasticsearch::API::HTTP_PUT
+          path   = "_rollup/job/#{Utils.__listify(_id)}"
+          params = {}
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,61 @@
+# 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 Rollup
+      module Actions
+        # Rollup an index
+        # This functionality is Experimental and may be changed or removed
+        # completely in a future release. Elastic will take a best effort approach
+        # to fix any issues, but experimental features are not subject to the
+        # support SLA of official GA features.
+        #
+        # @option arguments [String] :index The index to roll up (*Required*)
+        # @option arguments [String] :rollup_index The name of the rollup index to create (*Required*)
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body The rollup configuration (*Required*)
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/xpack-rollup.html
+        #
+        def rollup(arguments = {})
+          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+          raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
+          raise ArgumentError, "Required argument 'rollup_index' missing" unless arguments[:rollup_index]
+
+          headers = arguments.delete(:headers) || {}
+
+          body = arguments.delete(:body)
+
+          arguments = arguments.clone
+
+          _index = arguments.delete(:index)
+
+          _rollup_index = arguments.delete(:rollup_index)
+
+          method = Elasticsearch::API::HTTP_POST
+          path   = "#{Utils.__listify(_index)}/_rollup/#{Utils.__listify(_rollup_index)}"
+          params = {}
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/rollup/rollup_search.rb

@@ -0,0 +1,59 @@
+# 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 Rollup
+      module Actions
+        # Enables searching rolled-up data using the standard query DSL.
+        # This functionality is Experimental and may be changed or removed
+        # completely in a future release. Elastic will take a best effort approach
+        # to fix any issues, but experimental features are not subject to the
+        # support SLA of official GA features.
+        #
+        # @option arguments [List] :index The indices or index-pattern(s) (containing rollup or regular data) that should be searched
+        # @option arguments [Boolean] :typed_keys Specify whether aggregation and suggester names should be prefixed by their respective types in the response
+        # @option arguments [Boolean] :rest_total_hits_as_int Indicates whether hits.total should be rendered as an integer or an object in the rest search response
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body The search request body (*Required*)
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-search.html
+        #
+        def rollup_search(arguments = {})
+          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+          raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
+
+          headers = arguments.delete(:headers) || {}
+
+          body = arguments.delete(:body)
+
+          arguments = arguments.clone
+
+          _index = arguments.delete(:index)
+
+          method = Elasticsearch::API::HTTP_POST
+          path   = "#{Utils.__listify(_index)}/_rollup_search"
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end