elasticsearch-api 7.2.0 → 8.0.0

data/lib/elasticsearch/api/actions/transform/get_transform_stats.rb

@@ -0,0 +1,54 @@
+# 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 Transform
+      module Actions
+        # Retrieves usage information for transforms.
+        #
+        # @option arguments [String] :transform_id The id of the transform for which to get stats. '_all' or '*' implies all transforms
+        # @option arguments [Number] :from skips a number of transform stats, defaults to 0
+        # @option arguments [Number] :size specifies a max number of transform stats to get, defaults to 100
+        # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no transforms. (This includes `_all` string or when no transforms have been specified)
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform-stats.html
+        #
+        def get_transform_stats(arguments = {})
+          raise ArgumentError, "Required argument 'transform_id' missing" unless arguments[:transform_id]
+
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          arguments = arguments.clone
+
+          _transform_id = arguments.delete(:transform_id)
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = "_transform/#{Utils.__listify(_transform_id)}/_stats"
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/transform/preview_transform.rb

@@ -0,0 +1,60 @@
+# 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 Transform
+      module Actions
+        # Previews a transform.
+        #
+        # @option arguments [String] :transform_id The id of the transform to preview.
+        # @option arguments [Time] :timeout Controls the time to wait for the preview
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body The definition for the transform to preview
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/preview-transform.html
+        #
+        def preview_transform(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
+          body = arguments.delete(:body)
+
+          arguments = arguments.clone
+
+          _transform_id = arguments.delete(:transform_id)
+
+          method = if body
+                     Elasticsearch::API::HTTP_POST
+                   else
+                     Elasticsearch::API::HTTP_GET
+                   end
+
+          path   = if _transform_id
+                     "_transform/#{Utils.__listify(_transform_id)}/_preview"
+                   else
+                     "_transform/_preview"
+                   end
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/transform/put_transform.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 Transform
+      module Actions
+        # Instantiates a transform.
+        #
+        # @option arguments [String] :transform_id The id of the new transform.
+        # @option arguments [Boolean] :defer_validation If validations should be deferred until transform starts, defaults to false.
+        # @option arguments [Time] :timeout Controls the time to wait for the transform to start
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body The transform definition (*Required*)
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/put-transform.html
+        #
+        def put_transform(arguments = {})
+          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+          raise ArgumentError, "Required argument 'transform_id' missing" unless arguments[:transform_id]
+
+          headers = arguments.delete(:headers) || {}
+
+          body = arguments.delete(:body)
+
+          arguments = arguments.clone
+
+          _transform_id = arguments.delete(:transform_id)
+
+          method = Elasticsearch::API::HTTP_PUT
+          path   = "_transform/#{Utils.__listify(_transform_id)}"
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/transform/start_transform.rb

@@ -0,0 +1,52 @@
+# 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 Transform
+      module Actions
+        # Starts one or more transforms.
+        #
+        # @option arguments [String] :transform_id The id of the transform to start
+        # @option arguments [Time] :timeout Controls the time to wait for the transform to start
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/start-transform.html
+        #
+        def start_transform(arguments = {})
+          raise ArgumentError, "Required argument 'transform_id' missing" unless arguments[:transform_id]
+
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          arguments = arguments.clone
+
+          _transform_id = arguments.delete(:transform_id)
+
+          method = Elasticsearch::API::HTTP_POST
+          path   = "_transform/#{Utils.__listify(_transform_id)}/_start"
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/transform/stop_transform.rb

@@ -0,0 +1,56 @@
+# 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 Transform
+      module Actions
+        # Stops one or more transforms.
+        #
+        # @option arguments [String] :transform_id The id of the transform to stop
+        # @option arguments [Boolean] :force Whether to force stop a failed transform or not. Default to false
+        # @option arguments [Boolean] :wait_for_completion Whether to wait for the transform to fully stop before returning or not. Default to false
+        # @option arguments [Time] :timeout Controls the time to wait until the transform has stopped. Default to 30 seconds
+        # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no transforms. (This includes `_all` string or when no transforms have been specified)
+        # @option arguments [Boolean] :wait_for_checkpoint Whether to wait for the transform to reach a checkpoint before stopping. Default to false
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-transform.html
+        #
+        def stop_transform(arguments = {})
+          raise ArgumentError, "Required argument 'transform_id' missing" unless arguments[:transform_id]
+
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          arguments = arguments.clone
+
+          _transform_id = arguments.delete(:transform_id)
+
+          method = Elasticsearch::API::HTTP_POST
+          path   = "_transform/#{Utils.__listify(_transform_id)}/_stop"
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/transform/update_transform.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 Transform
+      module Actions
+        # Updates certain properties of a transform.
+        #
+        # @option arguments [String] :transform_id The id of the transform. (*Required*)
+        # @option arguments [Boolean] :defer_validation If validations should be deferred until transform starts, defaults to false.
+        # @option arguments [Time] :timeout Controls the time to wait for the update
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body The update transform definition (*Required*)
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/update-transform.html
+        #
+        def update_transform(arguments = {})
+          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+          raise ArgumentError, "Required argument 'transform_id' missing" unless arguments[:transform_id]
+
+          headers = arguments.delete(:headers) || {}
+
+          body = arguments.delete(:body)
+
+          arguments = arguments.clone
+
+          _transform_id = arguments.delete(:transform_id)
+
+          method = Elasticsearch::API::HTTP_POST
+          path   = "_transform/#{Utils.__listify(_transform_id)}/_update"
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/transform/upgrade_transforms.rb

@@ -0,0 +1,48 @@
+# 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 Transform
+      module Actions
+        # Upgrades all transforms.
+        #
+        # @option arguments [Boolean] :dry_run Whether to only check for updates but don't execute
+        # @option arguments [Time] :timeout Controls the time to wait for the upgrade
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/upgrade-transforms.html
+        #
+        def upgrade_transforms(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          arguments = arguments.clone
+
+          method = Elasticsearch::API::HTTP_POST
+          path   = "_transform/_upgrade"
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/update.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,124 +18,58 @@
 module Elasticsearch
   module API
     module Actions
-
-      # Update a document without sending the whole document in the request ("partial update").
-      #
-      # Send either a partial document (`doc` ) which will be deeply merged into an existing document,
-      # or a `script`, which will update the document content, in the `:body` argument.
-      #
-      # The partial update operation allows you to limit the amount of data you send over the wire and
-      # reduces the chance of failed updates due to conflict.
-      #
-      # Specify the `:version` and `:retry_on_conflict` arguments to balance convenience and consistency.
-      #
-      # @example Update document _title_ using partial `doc`-ument
-      #
-      #     client.update index: 'myindex', type: 'mytype', id: '1',
-      #                   body: { doc: { title: 'Updated' } }
-      #
-      # @example Add a tag to document `tags` property using a `script`
-      #
-      #     client.update index: 'myindex', type: 'mytype', id: '1',
-      #                    body: { script: { source: 'ctx._source.tags.add(params.tag)', params: { tag: 'x' } } }
-      #
-      # @example Increment a document counter by 1 _or_ initialize it, when the document does not exist
-      #
-      #     client.update index: 'myindex', type: 'mytype', id: '666',
-      #                   body: { script: 'ctx._source.counter += 1', upsert: { counter: 1 } }
-      #
-      # @example Delete a document if it's tagged "to-delete"
-      #
-      #     client.update index: 'myindex', type: 'mytype', id: '1',
-      #                   body: { script: 'ctx._source.tags.contains(params.tag) ? ctx.op = "delete" : ctx.op = "none"',
-      #                           params: { tag: 'to-delete' } }
-      #
-      # @option arguments [String] :id Document ID (*Required*)
-      # @option arguments [Number,List] :ignore The list of HTTP errors to ignore; only `404` supported at the moment
-      # @option arguments [String] :index The name of the index (*Required*)
-      # @option arguments [String] :type The type of the document (*Required*)
-      # @option arguments [Hash] :body The request definition using either `script` or partial `doc` (*Required*)
-      # @option arguments [String] :consistency Explicit write consistency setting for the operation
-      #                                         (options: one, quorum, all)
-      # @option arguments [List] :fields A comma-separated list of fields to return in the response
-      # @option arguments [Boolean] :include_type_name Whether a type should be expected in the body of the mappings.
-      # @option arguments [String] :lang The script language (default: mvel)
-      # @option arguments [String] :parent ID of the parent document
-      # @option arguments [String] :percolate Perform percolation during the operation;
-      #                                       use specific registered query name, attribute, or wildcard
-      # @option arguments [Boolean] :refresh Refresh the index after performing the operation
-      # @option arguments [String] :replication Specific replication type (options: sync, async)
-      # @option arguments [Number] :retry_on_conflict Specify how many times should the operation be retried
-      #                                               when a conflict occurs (default: 0)
+      # Updates a document with a script or partial document.
+      #
+      # @option arguments [String] :id Document ID
+      # @option arguments [String] :index The name of the index
+      # @option arguments [String] :wait_for_active_shards Sets the number of shard copies that must be active before proceeding with the update 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 [List] :_source True or false to return the _source field or not, or a list of fields to return
+      # @option arguments [List] :_source_excludes A list of fields to exclude from the returned _source field
+      # @option arguments [List] :_source_includes A list of fields to extract and return from the _source field
+      # @option arguments [String] :lang The script language (default: painless)
+      # @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 [Number] :retry_on_conflict Specify how many times should the operation be retried when a conflict occurs (default: 0)
       # @option arguments [String] :routing Specific routing value
-      # @option arguments [String] :script The URL-encoded script definition (instead of using request body)
-      # @option arguments [String] :_source Specify whether the _source field should be returned,
-      #                                     or a list of fields to return
-      # @option arguments [String] :_source_exclude A list of fields to exclude from the returned _source field
-      # @option arguments [String] :_source_include A list of fields to extract and return from the _source field
       # @option arguments [Time] :timeout Explicit operation timeout
-      # @option arguments [Time] :timestamp Explicit timestamp for the document
-      # @option arguments [Duration] :ttl Expiration time for the document
-      # @option arguments [Number] :version Explicit version number for concurrency control
-      # @option arguments [Number] :version_type Explicit version number for concurrency control
-      #
-      # @since 0.20
+      # @option arguments [Number] :if_seq_no only perform the update operation if the last operation that has changed the document has the specified sequence number
+      # @option arguments [Number] :if_primary_term only perform the update operation if the last operation that has changed the document has the specified primary term
+      # @option arguments [Boolean] :require_alias When true, requires destination is an alias. Default is false
+      # @option arguments [Hash] :headers Custom HTTP headers
+      # @option arguments [Hash] :body The request definition requires either `script` or partial `doc` (*Required*)
       #
-      # @see http://elasticsearch.org/guide/reference/api/update/
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update.html
       #
-      def update(arguments={})
+      def update(arguments = {})
+        raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
         raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
-        raise ArgumentError, "Required argument 'id' missing"    unless arguments[:id]
-        arguments[:type] ||= DEFAULT_DOC
-        method = HTTP_POST
+        raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
 
-        if arguments[:type]
-          path   = Utils.__pathify Utils.__escape(arguments[:index]),
-                                   Utils.__escape(arguments[:type]),
-                                   Utils.__escape(arguments[:id]),
-                                   '_update'
-        else
-          path   = Utils.__pathify Utils.__escape(arguments[:index]),
-                                   '_update',
-                                   Utils.__escape(arguments[:id])
-        end
+        headers = arguments.delete(:headers) || {}
+
+        body = arguments.delete(:body)
 
-        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-        body   = arguments[:body]
-        params[:fields] = Utils.__listify(params[:fields]) if params[:fields]
+        arguments = arguments.clone
+
+        _id = arguments.delete(:id)
+
+        _index = arguments.delete(:index)
+
+        method = Elasticsearch::API::HTTP_POST
+        path   = "#{Utils.__listify(_index)}/_update/#{Utils.__listify(_id)}"
+        params = Utils.process_params(arguments)
 
         if Array(arguments[:ignore]).include?(404)
-          Utils.__rescue_from_not_found { perform_request(method, path, params, body).body }
+          Utils.__rescue_from_not_found {
+            Elasticsearch::API::Response.new(
+              perform_request(method, path, params, body, headers)
+            )
+          }
         else
-          perform_request(method, path, params, body).body
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
         end
       end
-
-      # Register this action with its valid params when the module is loaded.
-      #
-      # @since 6.1.1
-      ParamsRegistry.register(:update, [
-          :consistency,
-          :fields,
-          :include_type_name,
-          :lang,
-          :parent,
-          :percolate,
-          :refresh,
-          :replication,
-          :retry_on_conflict,
-          :routing,
-          :script,
-          :_source,
-          :_source_include,
-          :_source_exclude,
-          :timeout,
-          :timestamp,
-          :ttl,
-          :version,
-          :version_type,
-          :if_seq_no,
-          :if_primary_term ].freeze)
     end
   end
 end