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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb87cfb56648460b74a2ae459b729860b515d115b4d801c4607a21ee591e2269
-  data.tar.gz: 8466da7f17c294d4c1c78fd69101c0c809a6e2d3938e7afaa0186f5dd3995fae
+  metadata.gz: bd0ba003344de903355ff8dd05b673bbbf5cde0ad186aa3cca4c5e15061496a9
+  data.tar.gz: 8dfd4d4dd95e03d90739d69674fda5ed305542318be5195064fa4d876e65ffd9
 SHA512:
-  metadata.gz: cc5ed4d0b4c0bb30dbbd1a1bc0a3dab182158cd1d095c338c213e94ffe33afdbd16212c68b3457a79f05abebbd61a1b2066336b61c1b8cf874f3766b4d26d203
-  data.tar.gz: ca0c548400b58f48b9ec44bfd126186e7be455ee12f8174d9db916504e989a3cd7d974165faebc7f3314f1b416914bc95a321f57472ede7bc61db6937452e20e
+  metadata.gz: a362e94319b0c1d3ff770af2a2f2b6917da87fdf8223e5389a25e3e997c2635a9fbdb114ab30c711415626e81df8ac5d0d7f34d5712ac6d1a67163187d8b9efe
+  data.tar.gz: 54ec61d9ae890eca45e4bff96c4d457732a5f318e78bf7881abd39482b03dc2c9776a3375e80f99ba0fbd281ab5e337c87cf7ab53f558a89bffc276a291c5dc7

data/lib/opensearch/api/actions/asynchronous_search/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 AsynchronousSearch
+      module Actions
+        # Deletes any responses from an asynchronous search.
+        #
+        # @option args [String] :id *Required*
+        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/_asynchronous_search', _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/asynchronous_search/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 AsynchronousSearch
+      module Actions
+        # Gets partial responses from an asynchronous search.
+        #
+        # @option args [String] :id *Required*
+        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/_asynchronous_search', _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/asynchronous_search/search.rb

@@ -0,0 +1,43 @@
+# 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 AsynchronousSearch
+      module Actions
+        # Performs an asynchronous search.
+        #
+        # @option args [String] :index The name of the index to be searched. Can be an individual name, a comma-separated list of indexes, or a wildcard expression of index names.
+        # @option args [String] :keep_alive The amount of time that the result is saved in the cluster. For example, `2d` means that the results are stored in the cluster for 48 hours.  The saved search results are deleted after this period or if the search is canceled. Note that this includes the query execution time.  If the query exceeds this amount of time, the process cancels this query automatically.
+        # @option args [Boolean] :keep_on_completion Whether to save the results in the cluster after the search is complete. You can examine the stored results at a later time.
+        # @option args [String] :wait_for_completion_timeout The amount of time to wait for the results. You can poll the remaining results based on an ID. The maximum value is 300 seconds. Default is `1s`.
+        # @option args [Hash] :body The search definition using the Query DSL.
+        def search(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'POST'
+          url     = '_plugins/_asynchronous_search'
+
+          Utils.validate_query_params! args, SEARCH_QUERY_PARAMS
+          transport.perform_request(method, url, args, body, headers).body
+        end
+
+        SEARCH_QUERY_PARAMS = Set.new(%w[
+          index
+          keep_alive
+          keep_on_completion
+          wait_for_completion_timeout
+        ]).freeze
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/asynchronous_search/stats.rb

@@ -0,0 +1,31 @@
+# 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 AsynchronousSearch
+      module Actions
+        # Monitors any asynchronous searches that are `running`, `completed`, or `persisted`.
+        #
+        def stats(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          url     = '_plugins/_asynchronous_search/stats'
+
+          Utils.validate_query_params! args
+          transport.perform_request(method, url, args, body, headers).body
+        end
+      end
+    end
+  end
+end

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

@@ -3,89 +3,58 @@
 # 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
-      # Allows to perform multiple index/update/delete operations in a single request.
-      #
-      # @option arguments [String] :index Default index for items which don't provide one
-      # @option arguments [String] :wait_for_active_shards Sets the number of shard copies that must be active before proceeding with the bulk 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 [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 [String] :routing Specific routing value
-      # @option arguments [Time] :timeout Explicit operation timeout
-      # @option arguments [List] :_source True or false to return the _source field or not, or default list of fields to return, can be overridden on each sub-request
-      # @option arguments [List] :_source_excludes Default list of fields to exclude from the returned _source field, can be overridden on each sub-request
-      # @option arguments [List] :_source_includes Default list of fields to extract and return from the _source field, can be overridden on each sub-request
-      # @option arguments [String] :pipeline The pipeline id to preprocess incoming documents with
-      # @option arguments [Boolean] :require_alias Sets require_alias for all incoming documents. Defaults to unset (false)
-      # @option arguments [Hash] :headers Custom HTTP headers
-      # @option arguments [String|Array] :body The operation definition and data (action-data pairs), separated by newlines. Array of Strings, Header/Data pairs,
-      # or the conveniency "combined" format can be passed, refer to OpenSearch::API::Utils.__bulkify documentation.
-      #
-      #
-      def bulk(arguments = {})
-        raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
 
-        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)
-
-        method = OpenSearch::API::HTTP_POST
-        path   = if _index
-                   "#{Utils.__listify(_index)}/_bulk"
-                 else
-                   '_bulk'
-                 end
-        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-
-        body = arguments[:body]
-        payload = if body.is_a? Array
-                    OpenSearch::API::Utils.__bulkify(body)
-                  else
-                    body
-                  end
-
-        headers.merge!('Content-Type' => 'application/x-ndjson')
-        perform_request(method, path, params, payload, headers).body
+module OpenSearch
+  module API
+    module Root
+      module Actions
+        # Allows to perform multiple index/update/delete operations in a single request.
+        #
+        # @option args [Boolean, Enumerable<String>, String] :_source `true` or `false` to return the `_source` field or not, or a list of fields to return.
+        # @option args [Enumerable<String>, String] :_source_excludes A comma-separated list of source fields to exclude from the response.
+        # @option args [Enumerable<String>, String] :_source_includes A comma-separated list of source fields to include in the response.
+        # @option args [String] :pipeline ID of the pipeline to use to preprocess incoming documents. If the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request. If a final pipeline is configured it will always run, regardless of the value of this parameter.
+        # @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. Valid values: `true`, `false`, `wait_for`.
+        # @option args [Boolean] :require_alias If `true`, the request's actions must target an index alias.
+        # @option args [Enumerable<String>, String] :routing Custom value used to route operations to a specific shard.
+        # @option args [String] :timeout Period each action waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards.
+        # @option args [String] :type Default document type for items which don't provide one.
+        # @option args [Integer, String] :wait_for_active_shards The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).
+        # @option args [String] :index Name of the data stream, index, or index alias to perform bulk actions on.
+        # @option args [Enumerable<Hash>] :body *Required* The operation definition and data (action-data pairs), separated by newlines
+        def bulk(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'body' missing" if args['body'].nil?
+
+          _index = args.delete('index')
+
+          headers = (args.delete('headers') || {}).merge('Content-Type' => 'application/x-ndjson')
+          body    = Utils.bulkify(args.delete('body'))
+          method  = _index.nil? ? 'POST' : 'PUT'
+          url     = Utils.build_url(_index, '_bulk')
+
+          Utils.validate_query_params! args, BULK_QUERY_PARAMS
+          transport.perform_request(method, url, args, body, headers).body
+        end
+
+        BULK_QUERY_PARAMS = Set.new(%w[
+          _source
+          _source_excludes
+          _source_includes
+          pipeline
+          refresh
+          require_alias
+          routing
+          timeout
+          type
+          wait_for_active_shards
+        ]).freeze
       end
-
-      # Register this action with its valid params when the module is loaded.
-      #
-      # @since 6.2.0
-      ParamsRegistry.register(:bulk, %i[
-        wait_for_active_shards
-        refresh
-        routing
-        timeout
-        _source
-        _source_excludes
-        _source_includes
-        pipeline
-        require_alias
-      ].freeze)
     end
   end
 end

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

@@ -0,0 +1,64 @@
+# 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 Root
+      module Actions
+        # Allows to perform multiple index/update/delete operations using request response streaming.
+        #
+        # @option args [Boolean, Enumerable<String>, String] :_source `true` or `false` to return the `_source` field or not, or a list of fields to return.
+        # @option args [Enumerable<String>, String] :_source_excludes A comma-separated list of source fields to exclude from the response.
+        # @option args [Enumerable<String>, String] :_source_includes A comma-separated list of source fields to include in the response.
+        # @option args [String] :batch_interval Specifies for how long bulk operations should be accumulated into a batch before sending the batch to data nodes.
+        # @option args [Integer] :batch_size Specifies how many bulk operations should be accumulated into a batch before sending the batch to data nodes.
+        # @option args [String] :pipeline ID of the pipeline to use to preprocess incoming documents. If the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request. If a final pipeline is configured it will always run, regardless of the value of this parameter.
+        # @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. Valid values: `true`, `false`, `wait_for`.
+        # @option args [Boolean] :require_alias If `true`, the request's actions must target an index alias.
+        # @option args [Enumerable<String>, String] :routing Custom value used to route operations to a specific shard.
+        # @option args [String] :timeout Period each action waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards.
+        # @option args [String] :type Default document type for items which don't provide one.
+        # @option args [Integer, String] :wait_for_active_shards The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).
+        # @option args [String] :index Name of the data stream, index, or index alias to perform bulk actions on.
+        # @option args [Enumerable<Hash>] :body *Required* The operation definition and data (action-data pairs), separated by newlines
+        def bulk_stream(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'body' missing" if args['body'].nil?
+
+          _index = args.delete('index')
+
+          headers = (args.delete('headers') || {}).merge('Content-Type' => 'application/x-ndjson')
+          body    = Utils.bulkify(args.delete('body'))
+          method  = _index.nil? ? 'POST' : 'PUT'
+          url     = Utils.build_url(_index, '_bulk/stream')
+
+          Utils.validate_query_params! args, BULK_STREAM_QUERY_PARAMS
+          transport.perform_request(method, url, args, body, headers).body
+        end
+
+        BULK_STREAM_QUERY_PARAMS = Set.new(%w[
+          _source
+          _source_excludes
+          _source_includes
+          batch_interval
+          batch_size
+          pipeline
+          refresh
+          require_alias
+          routing
+          timeout
+          type
+          wait_for_active_shards
+        ]).freeze
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/cat/aliases.rb

@@ -3,76 +3,48 @@
 # 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.
+
+# 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 Cat
       module Actions
-        # Shows information about currently configured aliases to indices including filter and routing infos.
-        #
-        # @option arguments [List] :name A comma-separated list of alias names to return
-        # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
-        # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
-        # @option arguments [List] :h Comma-separated list of column names to display
-        # @option arguments [Boolean] :help Return help information
-        # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
-        # @option arguments [Boolean] :v Verbose mode. Display column headers
-        # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
-        # @option arguments [Hash] :headers Custom HTTP headers
-        #
+        # Shows information about aliases currently configured to indexes, including filter and routing information.
         #
-        def aliases(arguments = {})
-          headers = arguments.delete(:headers) || {}
+        # @option args [Enumerable<String>, String] :expand_wildcards Specifies the type of index that wildcard expressions can match. Supports comma-separated values.
+        # @option args [String] :format A short version of the `Accept` header, such as `json` or `yaml`.
+        # @option args [Enumerable<String>] :h A comma-separated list of column names to display.
+        # @option args [Boolean] :help Returns help information.
+        # @option args [Boolean] :local Whether to return information from the local node only instead of from the cluster manager node.
+        # @option args [Enumerable<String>] :s A comma-separated list of column names or column aliases to sort by.
+        # @option args [Boolean] :v Enables verbose mode, which displays column headers.
+        # @option args [Enumerable<String>, String] :name A comma-separated list of aliases to retrieve. Supports wildcards (`*`).  To retrieve all aliases, omit this parameter or use `*` or `_all`.
+        def aliases(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          _name = args.delete('name')
 
-          arguments = arguments.clone
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          url     = Utils.build_url('_cat/aliases', _name)
 
-          _name = arguments.delete(:name)
-
-          method = OpenSearch::API::HTTP_GET
-          path   = if _name
-                     "_cat/aliases/#{Utils.__listify(_name)}"
-                   else
-                     '_cat/aliases'
-                   end
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-          params[:h] = Utils.__listify(params[:h]) if params[:h]
-
-          body = nil
-          perform_request(method, path, params, body, headers).body
+          Utils.validate_query_params! args, ALIASES_QUERY_PARAMS
+          transport.perform_request(method, url, args, body, headers).body
         end
 
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.2.0
-        ParamsRegistry.register(:aliases, %i[
+        ALIASES_QUERY_PARAMS = Set.new(%w[
+          expand_wildcards
           format
-          local
           h
           help
+          local
           s
           v
-          expand_wildcards
-        ].freeze)
+        ]).freeze
       end
     end
   end

data/lib/opensearch/api/actions/cat/all_pit_segments.rb

@@ -3,42 +3,43 @@
 # 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.
+
+# 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 Cat
       module Actions
-        # Retrieves info of all PIT segments
+        # Lists all active CAT point-in-time segments.
         #
-        # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
-        # @option arguments [List] :h Comma-separated list of column names to display
-        # @option arguments [Boolean] :help Return help information
-        # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
-        # @option arguments [Boolean] :v Verbose mode. Display column headers
-        # @option arguments [Hash] :headers Custom HTTP headers
-        def all_pit_segments(arguments = {})
-          arguments = arguments.clone
-          headers = arguments.delete(:headers) || {}
-
-          method = OpenSearch::API::HTTP_GET
-          path   = '_cat/pit_segments/_all'
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-          params[:h] = Utils.__listify(params[:h]) if params[:h]
+        # @option args [String] :bytes The units used to display byte values.
+        # @option args [String] :format A short version of the `Accept` header, such as `json` or `yaml`.
+        # @option args [Enumerable<String>] :h A comma-separated list of column names to display.
+        # @option args [Boolean] :help Returns help information.
+        # @option args [Enumerable<String>] :s A comma-separated list of column names or column aliases to sort by.
+        # @option args [Boolean] :v Enables verbose mode, which displays column headers.
+        def all_pit_segments(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          url     = '_cat/pit_segments/_all'
 
-          body = nil
-          perform_request(method, path, params, body, headers).body
+          Utils.validate_query_params! args, ALL_PIT_SEGMENTS_QUERY_PARAMS
+          transport.perform_request(method, url, args, body, headers).body
         end
 
-        ParamsRegistry.register(:all_pit_segments, %i[
+        ALL_PIT_SEGMENTS_QUERY_PARAMS = Set.new(%w[
+          bytes
           format
           h
           help
           s
           v
-        ].freeze)
+        ]).freeze
       end
     end
   end