elasticsearch-api 7.17.11 → 9.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd3f759f5eac49d7b8e619d3f5acb2810bce407617cafe6639d94035a6f1ae2f
-  data.tar.gz: 2f08fda748a265186d2722cc50a3383cd3633a5f7473e89659897ea9b69eb83c
+  metadata.gz: f8025a98332a0713f20582dfb63b744ef51d79e78b52228ff00f7596bb54672a
+  data.tar.gz: 81d35c25a2293f88fa8a680795169a6f08f2c9c5ca53872d9852240f2ff97369
 SHA512:
-  metadata.gz: 498a3cdbf1f10160eee68f5c11d134db03f3fb7a2f40725e3e3d3e28e9bccd08ea78c0b6e79ec3a01acad899a30a72e981d13c22780b3e131727552374be2bfe
-  data.tar.gz: e61e35bcf1b7ebee5e326dc2aea2fc0c4bcb36b814c64bc1708ea9788a6b592b1f95291599d70af56a79bc4870a411a5d2bae15889578a319cef7185fd0df83f
+  metadata.gz: 775eeff09355366bf1fa5141d53f23988b3cb8b6330a4335ff7b2400a35dee276cf56918c9e77e8ee3fab9e6fe5134b56070a1ffd80105b204b4c310fb504950
+  data.tar.gz: 811268a12ab7cd32fee85a8d82426f751396917d4656121e197592aee0492c8d2e2811efa988974b582fcc879350833839e9263a4287bb55254f88bb52864f47

data/README.md

@@ -1,185 +1,39 @@
 # Elasticsearch::API
 
-**This library is part of the [`elasticsearch-ruby`](https://github.com/elasticsearch/elasticsearch-ruby/) package; please refer to it, unless you want to use this library standalone.**
+*This library is part of the [`elasticsearch-ruby`](https://github.com/elasticsearch/elasticsearch-ruby/) package; please refer to it, unless you want to use this library standalone.*
 
-----
+**Refer to the [official documentation on Elasticsearch API](https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current/api.html).**
 
-The `elasticsearch-api` library provides a Ruby implementation of the [Elasticsearch](http://elasticsearch.com) REST API.
+The `elasticsearch-api` library provides a Ruby implementation of the [Elasticsearch](http://elasticsearch.com) REST API. It does not provide an Elasticsearch client. See [elasticsearch](https://github.com/elastic/elasticsearch-ruby) and the [`elastic-transport`](https://github.com/elastic/elastic-transport-ruby/) libraries for a full Elasticsearch client and HTTP transport layer respectively.
 
-It does not provide an Elasticsearch client; see the [`elasticsearch-transport`](https://github.com/elasticsearch/elasticsearch-ruby/tree/master/elasticsearch-transport) library.
+We follow Ruby’s own maintenance policy and officially support all currently maintained versions per [Ruby Maintenance Branches](https://www.ruby-lang.org/en/downloads/branches/).
 
-Language clients are forward compatible; meaning that clients support communicating with greater or equal minor versions of Elasticsearch. Elasticsearch language clients are only backwards compatible with default distributions and without guarantees made.
+Language clients are forward compatible; meaning that clients support communicating with greater minor versions of Elasticsearch. Elastic language clients are also backwards compatible with lesser supported minor Elasticsearch versions.
 
-## Installation
 
-Install the package from [Rubygems](https://rubygems.org):
-
-```
-gem install elasticsearch-api
-```
-
-Or add it to your Gemfile:
-
-```
-gem 'elasticsearch-api'
-```
-
-## Usage
-
-The library is designed as a group of standalone Ruby modules, which can be mixed into a class providing connection to Elasticsearch -- an Elasticsearch client. It's possible to mix it into any client, and the methods will be available in the top namespace.
-
-### Usage with the `elasticsearch` gem
-
-**When you use the client from the [`elasticsearch-ruby`](https://github.com/elasticsearch/elasticsearch-ruby/) package, the library modules have been already included**, so you just call the API methods:
-
-```ruby
-require 'elasticsearch'
-
-client = Elasticsearch::Client.new(log: true)
-
-client.index(index: 'myindex', type: 'mytype', id: 1, body: { title: 'Test' })
-# => {"_index"=>"myindex", ... "created"=>true}
-
-client.search(index: 'myindex', body: { query: { match: { title: 'test' } } })
-# => {"took"=>2, ..., "hits"=>{"total":5, ...}}
-```
-
-Full documentation is included as RDoc annotations in the source code and available online at <http://rubydoc.info/gems/elasticsearch-api>.
-
-### Usage with a custom client
-
-When you want to mix the library into your own client, it must conform to a following _contract_:
-
-* It responds to a `perform_request(method, path, params, body, headers)` method,
-* the method returns an object with `status`, `body` and `headers` methods.
-
-A simple client could look like this (_with a dependency on `active_support` to parse the query params_):
-
-```ruby
-require 'multi_json'
-require 'faraday'
-require 'elasticsearch/api'
-require 'active_support'
-
-class MySimpleClient
-  include Elasticsearch::API
-
-  CONNECTION = ::Faraday::Connection.new url: 'http://localhost:9200'
-
-  def perform_request(method, path, params, body, headers = nil)
-    puts "--> #{method.upcase} #{path} #{params} #{body} #{headers}"
-
-    CONNECTION.run_request \
-      method.downcase.to_sym,
-      path_with_params(path, params),
-      ( body ? MultiJson.dump(body): nil ),
-      {'Content-Type' => 'application/json'}
-  end
-  
-  private
-  
-  def path_with_params(path, params)
-    return path if params.blank?
-  
-    case params
-    when String
-      "#{path}?#{params}"
-    when Hash
-      "#{path}?#{params.to_query}"
-    else
-      raise ArgumentError, "Cannot parse params: '#{params}'"
-    end
-  end
-end
-
-client = MySimpleClient.new
-
-p client.cluster.health
-# --> GET _cluster/health {}
-# => "{"cluster_name":"elasticsearch" ... }"
-
-p client.index index: 'myindex', type: 'mytype', id: 'custom', body: { title: "Indexing from my client" }
-# --> PUT myindex/mytype/custom {} {:title=>"Indexing from my client"}
-# => "{"ok":true, ... }"
-```
-
-### Using JSON Builders
-
-Instead of passing the `:body` argument as a Ruby _Hash_, you can pass it as a _String_, potentially
-taking advantage of JSON builders such as [JBuilder](https://github.com/rails/jbuilder) or
-[Jsonify](https://github.com/bsiggelkow/jsonify):
-
-```ruby
-require 'jbuilder'
-
-query = Jbuilder.encode do |json|
-  json.query do
-    json.match do
-      json.title do
-        json.query    'test 1'
-        json.operator 'and'
-      end
-    end
-  end
-end
-
-client.search index: 'myindex', body: query
-
-# 2013-06-25 09:56:05 +0200: GET http://localhost:9200/myindex/_search [status:200, request:0.015s, query:0.011s]
-# 2013-06-25 09:56:05 +0200: > {"query":{"match":{"title":{"query":"test 1","operator":"and"}}}}
-# ...
-# => {"took"=>21, ..., "hits"=>{"total"=>1, "hits"=>[{ "_source"=>{"title"=>"Test 1", ...}}]}}
-```
-
-### Using Hash Wrappers
-
-For a more comfortable access to response properties, you may wrap it in one of the _Hash_ "object access"
-wrappers, such as [`Hashie::Mash`](https://github.com/intridea/hashie):
-
-```ruby
-require 'hashie'
+## Development
 
-response = client.search index: 'myindex',
-                         body: {
-                           query: { match: { title: 'test' } },
-                           aggregations: { tags: { terms: { field: 'tags' } } }
-                         }
+Refer to [CONTRIBUTING](https://github.com/elastic/elasticsearch-ruby/blob/main/CONTRIBUTING.md).
 
-mash = Hashie::Mash.new response
+Use `bundle exec rake test:unit` to run Unit tests. Add the environment variable `COVERAGE` to see Simplecov test coverage.
 
-mash.hits.hits.first._source.title
-# => 'Test'
+The integration tests on this project run the [Elasticsearch Client tests](https://github.com/elastic/elasticsearch-clients-tests/) with the [Elasticsearch Tests Runner](https://github.com/elastic/es-test-runner-ruby/) library. You can run a docker container with Elasticsearch with a Rake task from the root directory of this project:
 
-mash.aggregations.tags.terms.first
-# => #<Hashie::Mash count=3 term="z">
+```bash
+$ rake es:up
 ```
 
-### Using a Custom JSON Serializer
-
-The library uses the [MultiJson](https://rubygems.org/gems/multi_json/) gem by default,
-but allows you to set a custom JSON library, provided it uses the standard `load/dump`
-interface:
+This will start whatever version of Elasticsearch is set in the Buildkite pipeline file (`../.buildkite/pipeline.yml`) with security enabled. You can also specify a version and a suite ('free' or 'platinum' for security disabled/enabled):
 
-```ruby
-Elasticsearch::API.settings[:serializer] = JrJackson::Json
-Elasticsearch::API.serializer.dump({foo: 'bar'})
-# => {"foo":"bar"}
+```bash
+$ rake es:start[version,suite] # e.g. rake es:start[9.0.0-SNAPSHOT, free]
 ```
 
-## Development
-
-To work on the code, clone and bootstrap the main repository first -- please see instructions in the main [README](../README.md#development).
-
-To run tests, launch a testing cluster -- again, see instructions in the main [README](../README.md#development) -- and use the Rake tasks:
-
-```
-time rake test:unit
-time rake test:integration
-```
+You can run the integration tests with `bundle exec rake test:integration`.
 
-We run the test suite for Elasticsearch's Rest API tests. You can read more about this in [the test runner README](https://github.com/elastic/elasticsearch-ruby/tree/master/api-spec-testing#rest-api-yaml-test-runner).
+### Code generation
 
-The `rest_api` needs the test files from Elasticsearch. You can run the rake task to download the test artifacts in the root folder of the project. This task needs a running cluster to determine which version and build hash of Elasticsearch to use and test against. `TEST_ES_SERVER=http://localhost:9200 rake elasticsearch:download_artifacts`. This will download the necessary files used for the integration tests to `./tmp`.
+The code for most of this library is automatically generated. See [./utils/README.md](utils/README.md) for more information.
 
 ## License
 

data/elasticsearch-api.gemspec

@@ -23,61 +23,47 @@ require 'elasticsearch/api/version'
 Gem::Specification.new do |s|
   s.name          = 'elasticsearch-api'
   s.version       = Elasticsearch::API::VERSION
-  s.authors       = ['Karel Minarik']
-  s.email         = ['karel.minarik@elasticsearch.org']
+  s.authors       = ['Elastic Client Library Maintainers']
+  s.email         = ['client-libs@elastic.co']
   s.summary       = 'Ruby API for Elasticsearch.'
-  s.homepage      = 'https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/7.16/index.html'
+  s.homepage      = 'https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current/index.html'
   s.license       = 'Apache-2.0'
   s.metadata = {
-    'homepage_uri' => 'https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/7.16/index.html',
-    'changelog_uri' => 'https://github.com/elastic/elasticsearch-ruby/blob/7.16/CHANGELOG.md',
-    'source_code_uri' => 'https://github.com/elastic/elasticsearch-ruby/tree/7.16/elasticsearch-api',
+    'homepage_uri' => 'https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current/index.html',
+    'changelog_uri' => 'https://github.com/elastic/elasticsearch-ruby/blob/main/CHANGELOG.md',
+    'source_code_uri' => 'https://github.com/elastic/elasticsearch-ruby/tree/main/elasticsearch-api',
     'bug_tracker_uri' => 'https://github.com/elastic/elasticsearch-ruby/issues'
   }
-  s.files         = `git ls-files`.split($/)
-  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.files = `git ls-files`.split($/).reject do |file|
+    file.match(/^utils\/|^spec\/|^api-spec-testing\/|^Gemfile|^Rakefile/)
+  end
   s.require_paths = ['lib']
+  s.extra_rdoc_files  = ['README.md', 'LICENSE.txt']
+  s.rdoc_options      = ['--charset=UTF-8']
 
-  s.extra_rdoc_files  = [ 'README.md', 'LICENSE' ]
-  s.rdoc_options      = [ '--charset=UTF-8' ]
-
-  s.required_ruby_version = '>= 2.4'
-
+  s.required_ruby_version = '>= 2.6' # For compatibility with JRuby 9.3
   s.add_dependency 'multi_json'
 
   s.add_development_dependency 'ansi'
   s.add_development_dependency 'bundler'
   s.add_development_dependency 'elasticsearch'
-  s.add_development_dependency 'elasticsearch-transport'
-  s.add_development_dependency 'elasticsearch-xpack'
-  s.add_development_dependency 'minitest'
-  s.add_development_dependency 'minitest-reporters'
-  s.add_development_dependency 'mocha'
+  s.add_development_dependency 'elasticsearch-test-runner' unless defined?(JRUBY_VERSION) && JRUBY_VERSION <= '9.4'
   s.add_development_dependency 'pry'
-  s.add_development_dependency 'rake', '~> 13'
-  s.add_development_dependency 'shoulda-context'
+  s.add_development_dependency 'rake'
   s.add_development_dependency 'yard'
 
   # Gems for testing integrations
-  s.add_development_dependency 'jsonify'
+  s.add_development_dependency 'concurrent-ruby', '1.3.4' if defined? JRUBY_VERSION && JRUBY_VERSION < '9.4'
+  s.add_development_dependency 'activesupport'
   s.add_development_dependency 'hashie'
-  # Temporary support for Ruby 2.6, since it's EOL March 2022:
-  if RUBY_VERSION < '2.7.0'
-    s.add_development_dependency 'jbuilder', '< 7.0.0'
-  else
-    s.add_development_dependency 'activesupport'
-    s.add_development_dependency 'jbuilder'
-  end
+  s.add_development_dependency 'jbuilder'
+  s.add_development_dependency 'jsonify'
 
   s.add_development_dependency 'cane'
   s.add_development_dependency 'escape_utils' unless defined? JRUBY_VERSION
-
   s.add_development_dependency 'require-prof' unless defined?(JRUBY_VERSION) || defined?(Rubinius)
-  s.add_development_dependency 'simplecov'
-  s.add_development_dependency 'test-unit', '~> 2'
   s.add_development_dependency 'ruby-prof' unless defined?(JRUBY_VERSION) || defined?(Rubinius)
-
+  s.add_development_dependency 'simplecov'
   s.description = <<-DESC.gsub(/^    /, '')
     Ruby API for Elasticsearch. See the `elasticsearch` gem for full integration.
   DESC

data/lib/elasticsearch/api/actions/async_search/delete.rb

@@ -0,0 +1,63 @@
+# 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 code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
+module Elasticsearch
+  module API
+    module AsyncSearch
+      module Actions
+        # Delete an async search.
+        # If the asynchronous search is still running, it is cancelled.
+        # Otherwise, the saved search results are deleted.
+        # If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the +cancel_task+ cluster privilege.
+        #
+        # @option arguments [String] :id A unique identifier for the async search. (*Required*)
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-async-search-submit
+        #
+        def delete(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'async_search.delete' }
+
+          defined_params = [:id].each_with_object({}) do |variable, set_variables|
+            set_variables[variable] = arguments[variable] if arguments.key?(variable)
+          end
+          request_opts[:defined_params] = defined_params unless defined_params.empty?
+
+          raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
+
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          _id = arguments.delete(:id)
+
+          method = Elasticsearch::API::HTTP_DELETE
+          path   = "_async_search/#{Utils.listify(_id)}"
+          params = {}
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers, request_opts)
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,71 @@
+# 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 code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
+module Elasticsearch
+  module API
+    module AsyncSearch
+      module Actions
+        # Get async search results.
+        # Retrieve the results of a previously submitted asynchronous search request.
+        # If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it.
+        #
+        # @option arguments [String] :id A unique identifier for the async search. (*Required*)
+        # @option arguments [Time] :keep_alive The length of time that the async search should be available in the cluster.
+        #  When not specified, the +keep_alive+ set with the corresponding submit async request will be used.
+        #  Otherwise, it is possible to override the value and extend the validity of the request.
+        #  When this period expires, the search, if still running, is cancelled.
+        #  If the search is completed, its saved results are deleted.
+        # @option arguments [Boolean] :typed_keys Specify whether aggregation and suggester names should be prefixed by their respective types in the response
+        # @option arguments [Time] :wait_for_completion_timeout Specifies to wait for the search to be completed up until the provided timeout.
+        #  Final results will be returned if available before the timeout expires, otherwise the currently available results will be returned once the timeout expires.
+        #  By default no timeout is set meaning that the currently available results will be returned without any additional wait.
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-async-search-submit
+        #
+        def get(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'async_search.get' }
+
+          defined_params = [:id].each_with_object({}) do |variable, set_variables|
+            set_variables[variable] = arguments[variable] if arguments.key?(variable)
+          end
+          request_opts[:defined_params] = defined_params unless defined_params.empty?
+
+          raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
+
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          _id = arguments.delete(:id)
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = "_async_search/#{Utils.listify(_id)}"
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers, request_opts)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/async_search/status.rb

@@ -0,0 +1,66 @@
+# 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 code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
+module Elasticsearch
+  module API
+    module AsyncSearch
+      module Actions
+        # Get the async search status.
+        # Get the status of a previously submitted async search request given its identifier, without retrieving search results.
+        # If the Elasticsearch security features are enabled, the access to the status of a specific async search is restricted to:
+        # * The user or API key that submitted the original async search request.
+        # * Users that have the +monitor+ cluster privilege or greater privileges.
+        #
+        # @option arguments [String] :id A unique identifier for the async search. (*Required*)
+        # @option arguments [Time] :keep_alive The length of time that the async search needs to be available.
+        #  Ongoing async searches and any saved search results are deleted after this period. Server default: 5d.
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-async-search-submit
+        #
+        def status(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'async_search.status' }
+
+          defined_params = [:id].each_with_object({}) do |variable, set_variables|
+            set_variables[variable] = arguments[variable] if arguments.key?(variable)
+          end
+          request_opts[:defined_params] = defined_params unless defined_params.empty?
+
+          raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
+
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          _id = arguments.delete(:id)
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = "_async_search/status/#{Utils.listify(_id)}"
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers, request_opts)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/async_search/submit.rb

@@ -0,0 +1,113 @@
+# 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 code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
+module Elasticsearch
+  module API
+    module AsyncSearch
+      module Actions
+        # Run an async search.
+        # When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field. Partial results become available following the sort criteria that was requested.
+        # Warning: Asynchronous search does not support scroll or search requests that include only the suggest section.
+        # By default, Elasticsearch does not allow you to store an async search response larger than 10Mb and an attempt to do this results in an error.
+        # The maximum allowed size for a stored async search response can be set by changing the +search.max_async_search_response_size+ cluster level setting.
+        #
+        # @option arguments [String, Array] :index A comma-separated list of index names to search; use +_all+ or empty string to perform the operation on all indices
+        # @option arguments [Time] :wait_for_completion_timeout Blocks and waits until the search is completed up to a certain timeout.
+        #  When the async search completes within the timeout, the response won’t include the ID as the results are not stored in the cluster. Server default: 1s.
+        # @option arguments [Time] :keep_alive Specifies how long the async search needs to be available.
+        #  Ongoing async searches and any saved search results are deleted after this period. Server default: 5d.
+        # @option arguments [Boolean] :keep_on_completion If +true+, results are stored for later retrieval when the search completes within the +wait_for_completion_timeout+.
+        # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes +_all+ string or when no indices have been specified)
+        # @option arguments [Boolean] :allow_partial_search_results Indicate if an error should be returned if there is a partial search failure or timeout
+        # @option arguments [String] :analyzer The analyzer to use for the query string
+        # @option arguments [Boolean] :analyze_wildcard Specify whether wildcard and prefix queries should be analyzed (default: false)
+        # @option arguments [Integer] :batched_reduce_size Affects how often partial results become available, which happens whenever shard results are reduced.
+        #  A partial reduction is performed every time the coordinating node has received a certain number of new shard responses (5 by default). Server default: 5.
+        # @option arguments [Boolean] :ccs_minimize_roundtrips The default value is the only supported value.
+        # @option arguments [String] :default_operator The default operator for query string query (AND or OR)
+        # @option arguments [String] :df The field to use as default where no field prefix is given in the query string
+        # @option arguments [String, Array<String>] :docvalue_fields A comma-separated list of fields to return as the docvalue representation of a field for each hit
+        # @option arguments [String, Array<String>] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
+        # @option arguments [Boolean] :explain Specify whether to return detailed information about score computation as part of a hit
+        # @option arguments [Boolean] :ignore_throttled Whether specified concrete, expanded or aliased indices should be ignored when throttled
+        # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
+        # @option arguments [Boolean] :lenient Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
+        # @option arguments [Integer] :max_concurrent_shard_requests The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests
+        # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random)
+        # @option arguments [Boolean] :request_cache Specify if request cache should be used for this request or not, defaults to true Server default: true.
+        # @option arguments [String] :routing A comma-separated list of specific routing values
+        # @option arguments [String] :search_type Search operation type
+        # @option arguments [Array<String>] :stats Specific 'tag' of the request for logging and statistical purposes
+        # @option arguments [String, Array<String>] :stored_fields A comma-separated list of stored fields to return as part of a hit
+        # @option arguments [String] :suggest_field Specifies which field to use for suggestions.
+        # @option arguments [String] :suggest_mode Specify suggest mode
+        # @option arguments [Integer] :suggest_size How many suggestions to return in response
+        # @option arguments [String] :suggest_text The source text for which the suggestions should be returned.
+        # @option arguments [Integer] :terminate_after The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.
+        # @option arguments [Time] :timeout Explicit operation timeout
+        # @option arguments [Boolean, Integer] :track_total_hits Indicate if the number of documents that match the query should be tracked. A number can also be specified, to accurately track the total hit count up to the number.
+        # @option arguments [Boolean] :track_scores Whether to calculate and return scores even if they are not used for sorting
+        # @option arguments [Boolean] :typed_keys Specify whether aggregation and suggester names should be prefixed by their respective types in the response
+        # @option arguments [Boolean] :rest_total_hits_as_int Indicates whether hits.total should be rendered as an integer or an object in the rest search response
+        # @option arguments [Boolean] :version Specify whether to return document version as part of a hit
+        # @option arguments [Boolean, String, Array<String>] :_source True or false to return the _source field or not, or a list of fields to return
+        # @option arguments [String, Array<String>] :_source_excludes A list of fields to exclude from the returned _source field
+        # @option arguments [String, Array<String>] :_source_includes A list of fields to extract and return from the _source field
+        # @option arguments [Boolean] :seq_no_primary_term Specify whether to return sequence number and primary term of the last modification of each hit
+        # @option arguments [String] :q Query in the Lucene query string syntax
+        # @option arguments [Integer] :size Number of hits to return (default: 10)
+        # @option arguments [Integer] :from Starting offset (default: 0)
+        # @option arguments [String] :sort A comma-separated list of <field>:<direction> pairs
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body request body
+        #
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-async-search-submit
+        #
+        def submit(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'async_search.submit' }
+
+          defined_params = [:index].each_with_object({}) do |variable, set_variables|
+            set_variables[variable] = arguments[variable] if arguments.key?(variable)
+          end
+          request_opts[:defined_params] = defined_params unless defined_params.empty?
+
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body = arguments.delete(:body)
+
+          _index = arguments.delete(:index)
+
+          method = Elasticsearch::API::HTTP_POST
+          path   = if _index
+                     "#{Utils.listify(_index)}/_async_search"
+                   else
+                     '_async_search'
+                   end
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers, request_opts)
+          )
+        end
+      end
+    end
+  end
+end