opensearch-ruby 3.4.0 → 4.0.0.pre.beta.2

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

@@ -3,106 +3,62 @@
 # The OpenSearch Contributors require contributions made to
 # this file be licensed under the Apache-2.0 license or a
 # compatible open source license.
-#
-# Modifications Copyright OpenSearch Contributors. See
-# GitHub history for details.
-#
-# 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 OpenSearch
-  module API
-    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] :id The id of the document, when not specified a doc param should be supplied.
-      # @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.
-      # @option arguments [Boolean] :offsets Specifies if term offsets should be returned.
-      # @option arguments [Boolean] :positions Specifies if term positions should be returned.
-      # @option arguments [Boolean] :payloads Specifies if term payloads should be returned.
-      # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random).
-      # @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 [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
-      #
-      #
-      #
-      def termvectors(arguments = {})
-        raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
 
-        headers = arguments.delete(:headers) || {}
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
 
-        arguments = arguments.clone
+# frozen_string_literal: true
 
-        _index = arguments.delete(:index)
-
-        _id = arguments.delete(:id)
-
-        method = if arguments[:body]
-                   OpenSearch::API::HTTP_POST
-                 else
-                   OpenSearch::API::HTTP_GET
-                 end
+module OpenSearch
+  module API
+    module Root
+      module Actions
+        # Returns information and statistics about terms in the fields of a particular document.
+        #
+        # @option args [String] :index *Required* Name of the index that contains the document.
+        # @option args [Boolean] :field_statistics (default: true) If `true`, the response includes the document count, sum of document frequencies, and sum of total term frequencies.
+        # @option args [Enumerable<String>, String] :fields Comma-separated list or wildcard expressions of fields to include in the statistics. Used as the default list unless a specific field list is provided in the `completion_fields` or `fielddata_fields` parameters.
+        # @option args [Boolean] :offsets (default: true) If `true`, the response includes term offsets.
+        # @option args [Boolean] :payloads (default: true) If `true`, the response includes term payloads.
+        # @option args [Boolean] :positions (default: true) If `true`, the response includes term positions.
+        # @option args [String] :preference (default: random) Specifies the node or shard the operation should be performed on. Random by default.
+        # @option args [Boolean] :realtime (default: true) If `true`, the request is real-time as opposed to near-real-time.
+        # @option args [Enumerable<String>, String] :routing Custom value used to route operations to a specific shard.
+        # @option args [Boolean] :term_statistics If `true`, the response includes term frequency and document frequency.
+        # @option args [Integer] :version If `true`, returns the document version as part of a hit.
+        # @option args [String] :version_type Specific version type.
+        # @option args [String] :id Unique identifier of the document.
+        # @option args [Hash] :body Define parameters and or supply a document to get termvectors for. See documentation.
+        def termvectors(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'index' missing" if args['index'].nil?
 
-        endpoint = arguments.delete(:endpoint) || '_termvectors'
-        path = if _index && _id
-                 "#{Utils.__listify(_index)}/#{endpoint}/#{Utils.__listify(_id)}"
-               else
-                 "#{Utils.__listify(_index)}/#{endpoint}"
-               end
+          _index = args.delete('index')
+          _id = args.delete('id')
 
-        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = body ? 'POST' : 'GET'
+          url     = Utils.build_url(_index, '_termvectors', _id)
 
-        body = arguments[:body]
-        perform_request(method, path, params, body, headers).body
-      end
+          Utils.validate_query_params! args, TERMVECTORS_QUERY_PARAMS
+          transport.perform_request(method, url, args, body, headers).body
+        end
 
-      # Deprecated: Use the plural version, {#termvectors}
-      #
-      def termvector(arguments = {})
-        termvectors(arguments.merge(endpoint: '_termvector'))
+        TERMVECTORS_QUERY_PARAMS = Set.new(%w[
+          field_statistics
+          fields
+          offsets
+          payloads
+          positions
+          preference
+          realtime
+          routing
+          term_statistics
+          version
+          version_type
+        ]).freeze
       end
-
-      # Register this action with its valid params when the module is loaded.
-      #
-      # @since 6.2.0
-      ParamsRegistry.register(:termvectors, %i[
-        term_statistics
-        field_statistics
-        fields
-        offsets
-        positions
-        payloads
-        preference
-        routing
-        realtime
-        version
-        version_type
-      ].freeze)
     end
   end
 end

data/lib/opensearch/api/actions/transforms/delete.rb

@@ -0,0 +1,36 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Transforms
+      module Actions
+        # Delete an index transform.
+        #
+        # @option args [String] :id *Required* Transform to delete
+        def delete(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'id' missing" if args['id'].nil?
+
+          _id = args.delete('id')
+
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'DELETE'
+          url     = Utils.build_url('_plugins/_transform', _id)
+
+          Utils.validate_query_params! args
+          transport.perform_delete_request method, url, args, body, headers
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/transforms/explain.rb

@@ -0,0 +1,36 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Transforms
+      module Actions
+        # Returns the status and metadata of a transform job.
+        #
+        # @option args [String] :id *Required* Transform to explain
+        def explain(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'id' missing" if args['id'].nil?
+
+          _id = args.delete('id')
+
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          url     = Utils.build_url('_plugins/_transform', _id, '_explain')
+
+          Utils.validate_query_params! args
+          transport.perform_request(method, url, args, body, headers).body
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/transforms/get.rb

@@ -0,0 +1,36 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Transforms
+      module Actions
+        # Returns the status and metadata of a transform job.
+        #
+        # @option args [String] :id *Required* Transform to access
+        def get(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'id' missing" if args['id'].nil?
+
+          _id = args.delete('id')
+
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          url     = Utils.build_url('_plugins/_transform', _id)
+
+          Utils.validate_query_params! args
+          transport.perform_request(method, url, args, body, headers).body
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/transforms/preview.rb

@@ -0,0 +1,32 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Transforms
+      module Actions
+        # Returns a preview of what a transformed index would look like.
+        #
+        # @option args [Hash] :body
+        def preview(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'POST'
+          url     = '_plugins/_transform/_preview'
+
+          Utils.validate_query_params! args
+          transport.perform_request(method, url, args, body, headers).body
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/transforms/put.rb

@@ -0,0 +1,44 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Transforms
+      module Actions
+        # Create an index transform, or update a transform if `if_seq_no` and `if_primary_term` are provided.
+        #
+        # @option args [String] :id *Required* Transform to create/update
+        # @option args [Float] :if_primary_term Only perform the operation if the document has this primary term.
+        # @option args [Integer] :if_seq_no Only perform the operation if the document has this sequence number.
+        # @option args [Hash] :body
+        def put(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'id' missing" if args['id'].nil?
+
+          _id = args.delete('id')
+
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'PUT'
+          url     = Utils.build_url('_plugins/_transform', _id)
+
+          Utils.validate_query_params! args, PUT_QUERY_PARAMS
+          transport.perform_request(method, url, args, body, headers).body
+        end
+
+        PUT_QUERY_PARAMS = Set.new(%w[
+          if_primary_term
+          if_seq_no
+        ]).freeze
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/transforms/search.rb

@@ -0,0 +1,44 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Transforms
+      module Actions
+        # Returns the details of all transform jobs.
+        #
+        # @option args [Float] :from The starting transform to return. Default is `0`.
+        # @option args [String] :search The search term to use to filter results.
+        # @option args [Float] :size Specifies the number of transforms to return. Default is `10`.
+        # @option args [String] :sortDirection Specifies the direction to sort results in. Can be `ASC` or `DESC`. Default is `ASC`.
+        # @option args [String] :sortField The field to sort results with.
+        def search(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          url     = '_plugins/_transform'
+
+          Utils.validate_query_params! args, SEARCH_QUERY_PARAMS
+          transport.perform_request(method, url, args, body, headers).body
+        end
+
+        SEARCH_QUERY_PARAMS = Set.new(%w[
+          from
+          search
+          size
+          sortDirection
+          sortField
+        ]).freeze
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/transforms/start.rb

@@ -0,0 +1,36 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Transforms
+      module Actions
+        # Start transform.
+        #
+        # @option args [String] :id *Required* Transform to start
+        def start(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'id' missing" if args['id'].nil?
+
+          _id = args.delete('id')
+
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'POST'
+          url     = Utils.build_url('_plugins/_transform', _id, '_start')
+
+          Utils.validate_query_params! args
+          transport.perform_request(method, url, args, body, headers).body
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/transforms/stop.rb

@@ -0,0 +1,36 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Transforms
+      module Actions
+        # Stop transform.
+        #
+        # @option args [String] :id *Required* Transform to stop
+        def stop(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'id' missing" if args['id'].nil?
+
+          _id = args.delete('id')
+
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'POST'
+          url     = Utils.build_url('_plugins/_transform', _id, '_stop')
+
+          Utils.validate_query_params! args
+          transport.perform_request(method, url, args, body, headers).body
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/update.rb

@@ -3,97 +3,66 @@
 # The OpenSearch Contributors require contributions made to
 # this file be licensed under the Apache-2.0 license or a
 # compatible open source license.
-#
-# Modifications Copyright OpenSearch Contributors. See
-# GitHub history for details.
-#
-# 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 OpenSearch
-  module API
-    module Actions
-      # 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 [Time] :timeout Explicit operation timeout
-      # @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*)
-      #
-      # *Deprecation notice*:
-      # Specifying types in urls has been deprecated
-      # Deprecated since version 7.0.0
-      #
-      #
-      #
-      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]
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
 
-        headers = arguments.delete(:headers) || {}
+# frozen_string_literal: true
 
-        arguments = arguments.clone
-
-        _id = arguments.delete(:id)
+module OpenSearch
+  module API
+    module Root
+      module Actions
+        # Updates a document with a script or partial document.
+        #
+        # @option args [String] :id *Required* Document ID
+        # @option args [String] :index *Required* The name of the index
+        # @option args [Boolean, Enumerable<String>, String] :_source Set to `false` to disable source retrieval. You can also specify a comma-separated list of the fields you want to retrieve.
+        # @option args [Enumerable<String>, String] :_source_excludes Specify the source fields you want to exclude.
+        # @option args [Enumerable<String>, String] :_source_includes Specify the source fields you want to retrieve.
+        # @option args [Integer] :if_primary_term Only perform the operation if the document has this primary term.
+        # @option args [Integer] :if_seq_no Only perform the operation if the document has this sequence number.
+        # @option args [String] :lang (default: painless) The script language.
+        # @option args [Boolean, String] :refresh If 'true', OpenSearch refreshes 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` do nothing with refreshes.
+        # @option args [Boolean] :require_alias If `true`, the destination must be an index alias.
+        # @option args [Integer] :retry_on_conflict (default: 0) Specify how many times should the operation be retried when a conflict occurs.
+        # @option args [Enumerable<String>, String] :routing Custom value used to route operations to a specific shard.
+        # @option args [String] :timeout Period to wait for dynamic mapping updates and active shards. This guarantees OpenSearch waits for at least the timeout before failing. The actual wait time could be longer, particularly when multiple waits occur.
+        # @option args [Integer, String] :wait_for_active_shards The number of shard copies that must be active before proceeding with the operations. Set to 'all' or any positive integer up to the total number of shards in the index (number_of_replicas+1). Defaults to 1 meaning the primary shard.
+        # @option args [Hash] :body *Required* The request definition requires either `script` or partial `doc`
+        def update(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'id' missing" if args['id'].nil?
+          raise ArgumentError, "Required argument 'index' missing" if args['index'].nil?
+          raise ArgumentError, "Required argument 'body' missing" if args['body'].nil?
 
-        _index = arguments.delete(:index)
+          _id = args.delete('id')
+          _index = args.delete('index')
 
-        method = OpenSearch::API::HTTP_POST
-        path   = "#{Utils.__listify(_index)}/_update/#{Utils.__listify(_id)}"
-        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'POST'
+          url     = Utils.build_url(_index, '_update', _id)
 
-        body = arguments[:body]
-        if Array(arguments[:ignore]).include?(404)
-          Utils.__rescue_from_not_found { perform_request(method, path, params, body, headers).body }
-        else
-          perform_request(method, path, params, body, headers).body
+          Utils.validate_query_params! args, UPDATE_QUERY_PARAMS
+          transport.perform_request(method, url, args, body, headers).body
         end
-      end
 
-      # Register this action with its valid params when the module is loaded.
-      #
-      # @since 6.2.0
-      ParamsRegistry.register(:update, %i[
-        wait_for_active_shards
-        _source
-        _source_excludes
-        _source_includes
-        lang
-        refresh
-        retry_on_conflict
-        routing
-        timeout
-        if_seq_no
-        if_primary_term
-        require_alias
-      ].freeze)
+        UPDATE_QUERY_PARAMS = Set.new(%w[
+          _source
+          _source_excludes
+          _source_includes
+          if_primary_term
+          if_seq_no
+          lang
+          refresh
+          require_alias
+          retry_on_conflict
+          routing
+          timeout
+          wait_for_active_shards
+        ]).freeze
+      end
     end
   end
 end