elasticsearch-api 7.17.7 → 8.0.0.pre1

data/lib/elasticsearch/api/actions/tasks/cancel.rb

@@ -32,11 +32,13 @@ module Elasticsearch
         # @option arguments [Boolean] :wait_for_completion Should the request block until the cancellation of the task and its descendant tasks is completed. Defaults to false
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/tasks.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html
         #
         def cancel(arguments = {})
           headers = arguments.delete(:headers) || {}
 
+          body = nil
+
           arguments = arguments.clone
 
           _task_id = arguments.delete(:task_id)
@@ -47,21 +49,12 @@ module Elasticsearch
                    else
                      "_tasks/_cancel"
                    end
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+          params = Utils.process_params(arguments)
 
-          body = nil
-          perform_request(method, path, params, body, headers).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(:cancel, [
-          :nodes,
-          :actions,
-          :parent_task_id,
-          :wait_for_completion
-        ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/tasks/get.rb

@@ -30,30 +30,25 @@ module Elasticsearch
         # @option arguments [Time] :timeout Explicit operation timeout
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/tasks.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html
         #
         def get(arguments = {})
           headers = arguments.delete(:headers) || {}
 
+          body = nil
+
           arguments = arguments.clone
 
           _task_id = arguments.delete(:task_id)
 
           method = Elasticsearch::API::HTTP_GET
           path   = "_tasks/#{Utils.__listify(_task_id)}"
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+          params = Utils.process_params(arguments)
 
-          body = nil
-          perform_request(method, path, params, body, headers).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(:get, [
-          :wait_for_completion,
-          :timeout
-        ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/tasks/list.rb

@@ -34,33 +34,23 @@ module Elasticsearch
         # @option arguments [Time] :timeout Explicit operation timeout
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/tasks.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html
         #
         def list(arguments = {})
           headers = arguments.delete(:headers) || {}
 
+          body = nil
+
           arguments = arguments.clone
 
           method = Elasticsearch::API::HTTP_GET
           path   = "_tasks"
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+          params = Utils.process_params(arguments)
 
-          body = nil
-          perform_request(method, path, params, body, headers).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(:list, [
-          :nodes,
-          :actions,
-          :detailed,
-          :parent_task_id,
-          :wait_for_completion,
-          :group_by,
-          :timeout
-        ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/terms_enum.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 Actions
+      # The terms enum API  can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios.
+      #
+      # @option arguments [List] :index A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
+      # @option arguments [Hash] :headers Custom HTTP headers
+      # @option arguments [Hash] :body field name, string which is the prefix expected in matching terms, timeout and size for max number of results
+      #
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-terms-enum.html
+      #
+      def terms_enum(arguments = {})
+        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 = if body
+                   Elasticsearch::API::HTTP_POST
+                 else
+                   Elasticsearch::API::HTTP_GET
+                 end
+
+        path   = "#{Utils.__listify(_index)}/_terms_enum"
+        params = {}
+
+        Elasticsearch::API::Response.new(
+          perform_request(method, path, params, body, headers)
+        )
+      end
+    end
+  end
+end

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

@@ -20,9 +20,8 @@ module Elasticsearch
     module Actions
       # Returns information and statistics about terms in the fields of a particular document.
       #
-      # @option arguments [String] :index The index in which the document resides. (*Required*)
+      # @option arguments [String] :index The index in which the document resides.
       # @option arguments [String] :id The id of the document, when not specified a doc param should be supplied.
-      # @option arguments [String] :type The type of the document.
       # @option arguments [Boolean] :term_statistics Specifies if total term frequency and document frequency should be returned.
       # @option arguments [Boolean] :field_statistics Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned.
       # @option arguments [List] :fields A comma-separated list of fields to return.
@@ -33,51 +32,42 @@ module Elasticsearch
       # @option arguments [String] :routing Specific routing value.
       # @option arguments [Boolean] :realtime Specifies if request is real-time as opposed to near-real-time (default: true).
       # @option arguments [Number] :version Explicit version number for concurrency control
-      # @option arguments [String] :version_type Specific version type (options: internal, external, external_gte, force)
+      # @option arguments [String] :version_type Specific version type (options: internal, external, external_gte)
       # @option arguments [Hash] :headers Custom HTTP headers
       # @option arguments [Hash] :body Define parameters and or supply a document to get termvectors for. See documentation.
       #
-      # *Deprecation notice*:
-      # Specifying types in urls has been deprecated
-      # Deprecated since version 7.0.0
-      #
-      #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/docs-termvectors.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-termvectors.html
       #
       def termvectors(arguments = {})
         raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
 
         headers = arguments.delete(:headers) || {}
 
+        body = arguments.delete(:body)
+
         arguments = arguments.clone
 
         _index = arguments.delete(:index)
 
         _id = arguments.delete(:id)
 
-        _type = arguments.delete(:type)
-
-        method = if arguments[:body]
+        method = if body
                    Elasticsearch::API::HTTP_POST
                  else
                    Elasticsearch::API::HTTP_GET
                  end
 
         endpoint = arguments.delete(:endpoint) || '_termvectors'
-        path   = if _index && _type && _id
-                   "#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/#{Utils.__listify(_id)}/#{endpoint}"
-                 elsif _index && _type
-                   "#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/#{endpoint}"
-                 elsif _index && _id
-                   "#{Utils.__listify(_index)}/#{endpoint}/#{Utils.__listify(_id)}"
+        path   = if _index && _id
+                   "#{Utils.__listify(_index)}/_termvectors/#{Utils.__listify(_id)}"
                  else
-                   "#{Utils.__listify(_index)}/#{endpoint}"
+                   "#{Utils.__listify(_index)}/_termvectors"
                  end
+        params = Utils.process_params(arguments)
 
-        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-
-        body = arguments[:body]
-        perform_request(method, path, params, body, headers).body
+        Elasticsearch::API::Response.new(
+          perform_request(method, path, params, body, headers)
+        )
       end
 
       # Deprecated: Use the plural version, {#termvectors}
@@ -85,23 +75,6 @@ module Elasticsearch
       def termvector(arguments = {})
         termvectors(arguments.merge endpoint: '_termvector')
       end
-
-      # Register this action with its valid params when the module is loaded.
-      #
-      # @since 6.2.0
-      ParamsRegistry.register(:termvectors, [
-        :term_statistics,
-        :field_statistics,
-        :fields,
-        :offsets,
-        :positions,
-        :payloads,
-        :preference,
-        :routing,
-        :realtime,
-        :version,
-        :version_type
-      ].freeze)
     end
   end
 end

data/lib/elasticsearch/api/actions/text_structure/find_structure.rb

@@ -0,0 +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 TextStructure
+      module Actions
+        # Finds the structure of a text file. The text file must contain data that is suitable to be ingested into Elasticsearch.
+        #
+        # @option arguments [Integer] :lines_to_sample How many lines of the file should be included in the analysis
+        # @option arguments [Integer] :line_merge_size_limit Maximum number of characters permitted in a single message when lines are merged to create messages.
+        # @option arguments [Time] :timeout Timeout after which the analysis will be aborted
+        # @option arguments [String] :charset Optional parameter to specify the character set of the file
+        # @option arguments [String] :format Optional parameter to specify the high level file format (options: ndjson, xml, delimited, semi_structured_text)
+        # @option arguments [Boolean] :has_header_row Optional parameter to specify whether a delimited file includes the column names in its first row
+        # @option arguments [List] :column_names Optional parameter containing a comma separated list of the column names for a delimited file
+        # @option arguments [String] :delimiter Optional parameter to specify the delimiter character for a delimited file - must be a single character
+        # @option arguments [String] :quote Optional parameter to specify the quote character for a delimited file - must be a single character
+        # @option arguments [Boolean] :should_trim_fields Optional parameter to specify whether the values between delimiters in a delimited file should have whitespace trimmed from them
+        # @option arguments [String] :grok_pattern Optional parameter to specify the Grok pattern that should be used to extract fields from messages in a semi-structured text file
+        # @option arguments [String] :timestamp_field Optional parameter to specify the timestamp field in the file
+        # @option arguments [String] :timestamp_format Optional parameter to specify the timestamp format in the file - may be either a Joda or Java time format
+        # @option arguments [Boolean] :explain Whether to include a commentary on how the structure was derived
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body The contents of the file to be analyzed (*Required*)
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/find-structure.html
+        #
+        def find_structure(arguments = {})
+          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+
+          headers = arguments.delete(:headers) || {}
+
+          body = arguments.delete(:body)
+
+          arguments = arguments.clone
+
+          method = Elasticsearch::API::HTTP_POST
+          path   = "_text_structure/find_structure"
+          params = Utils.process_params(arguments)
+
+          if body.is_a? Array
+            payload = Elasticsearch::API::Utils.__bulkify(body)
+          else
+            payload = body
+          end
+
+          headers.merge!("Content-Type" => "application/x-ndjson")
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, payload, headers)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/transform/delete_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
+        # Deletes an existing transform.
+        #
+        # @option arguments [String] :transform_id The id of the transform to delete
+        # @option arguments [Boolean] :force When `true`, the transform is deleted regardless of its current state. The default value is `false`, meaning that the transform must be `stopped` before it can be deleted.
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-transform.html
+        #
+        def delete_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_DELETE
+          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/get_transform.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 Transform
+      module Actions
+        # Retrieves configuration information for transforms.
+        #
+        # @option arguments [String] :transform_id The id or comma delimited list of id expressions of the transforms to get, '_all' or '*' implies get all transforms
+        # @option arguments [Integer] :from skips a number of transform configs, defaults to 0
+        # @option arguments [Integer] :size specifies a max number of transforms 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 [Boolean] :exclude_generated Omits fields that are illegal to set on transform PUT
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform.html
+        #
+        def get_transform(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          arguments = arguments.clone
+
+          _transform_id = arguments.delete(:transform_id)
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = if _transform_id
+                     "_transform/#{Utils.__listify(_transform_id)}"
+                   else
+                     "_transform"
+                   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/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,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 Transform
+      module Actions
+        # Previews a transform.
+        #
+        # @option arguments [String] :transform_id The id of the transform to 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 = {}
+
+          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,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
+        # 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 [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