Skip to content

Commit eb2fd26

Browse files
committed
[API] Updates generated API code to 9.x
1 parent 0df1897 commit eb2fd26

File tree

499 files changed

+9003
-4787
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

499 files changed

+9003
-4787
lines changed

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

+9-6
Original file line numberDiff line numberDiff line change
@@ -15,19 +15,22 @@
1515
# specific language governing permissions and limitations
1616
# under the License.
1717
#
18-
# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
19-
# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
18+
# Auto generated from commit f284cc16f4d4b4289bc679aa1529bb504190fe80
19+
# @see https://github.com/elastic/elasticsearch-specification
2020
#
2121
module Elasticsearch
2222
module API
2323
module AsyncSearch
2424
module Actions
25-
# Deletes an async search by ID. If the search is still running, the search request will be cancelled. Otherwise, the saved search results are deleted.
25+
# Delete an async search.
26+
# If the asynchronous search is still running, it is cancelled.
27+
# Otherwise, the saved search results are deleted.
28+
# 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.
2629
#
27-
# @option arguments [String] :id The async search ID
30+
# @option arguments [String] :id A unique identifier for the async search. (*Required*)
2831
# @option arguments [Hash] :headers Custom HTTP headers
2932
#
30-
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html
33+
# @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-async-search-submit
3134
#
3235
def delete(arguments = {})
3336
request_opts = { endpoint: arguments[:endpoint] || 'async_search.delete' }
@@ -47,7 +50,7 @@ def delete(arguments = {})
4750
_id = arguments.delete(:id)
4851

4952
method = Elasticsearch::API::HTTP_DELETE
50-
path = "_async_search/#{Utils.__listify(_id)}"
53+
path = "_async_search/#{Utils.listify(_id)}"
5154
params = {}
5255

5356
Elasticsearch::API::Response.new(

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

+16-8
Original file line numberDiff line numberDiff line change
@@ -15,22 +15,30 @@
1515
# specific language governing permissions and limitations
1616
# under the License.
1717
#
18-
# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
19-
# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
18+
# Auto generated from commit f284cc16f4d4b4289bc679aa1529bb504190fe80
19+
# @see https://github.com/elastic/elasticsearch-specification
2020
#
2121
module Elasticsearch
2222
module API
2323
module AsyncSearch
2424
module Actions
25-
# Retrieves the results of a previously submitted async search request given its ID.
25+
# Get async search results.
26+
# Retrieve the results of a previously submitted asynchronous search request.
27+
# 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.
2628
#
27-
# @option arguments [String] :id The async search ID
28-
# @option arguments [Time] :wait_for_completion_timeout Specify the time that the request should block waiting for the final response
29-
# @option arguments [Time] :keep_alive Specify the time interval in which the results (partial or final) for this search will be available
29+
# @option arguments [String] :id A unique identifier for the async search. (*Required*)
30+
# @option arguments [Time] :keep_alive The length of time that the async search should be available in the cluster.
31+
# When not specified, the +keep_alive+ set with the corresponding submit async request will be used.
32+
# Otherwise, it is possible to override the value and extend the validity of the request.
33+
# When this period expires, the search, if still running, is cancelled.
34+
# If the search is completed, its saved results are deleted.
3035
# @option arguments [Boolean] :typed_keys Specify whether aggregation and suggester names should be prefixed by their respective types in the response
36+
# @option arguments [Time] :wait_for_completion_timeout Specifies to wait for the search to be completed up until the provided timeout.
37+
# Final results will be returned if available before the timeout expires, otherwise the currently available results will be returned once the timeout expires.
38+
# By default no timeout is set meaning that the currently available results will be returned without any additional wait.
3139
# @option arguments [Hash] :headers Custom HTTP headers
3240
#
33-
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html
41+
# @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-async-search-submit
3442
#
3543
def get(arguments = {})
3644
request_opts = { endpoint: arguments[:endpoint] || 'async_search.get' }
@@ -50,7 +58,7 @@ def get(arguments = {})
5058
_id = arguments.delete(:id)
5159

5260
method = Elasticsearch::API::HTTP_GET
53-
path = "_async_search/#{Utils.__listify(_id)}"
61+
path = "_async_search/#{Utils.listify(_id)}"
5462
params = Utils.process_params(arguments)
5563

5664
Elasticsearch::API::Response.new(

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

+12-7
Original file line numberDiff line numberDiff line change
@@ -15,20 +15,25 @@
1515
# specific language governing permissions and limitations
1616
# under the License.
1717
#
18-
# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
19-
# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
18+
# Auto generated from commit f284cc16f4d4b4289bc679aa1529bb504190fe80
19+
# @see https://github.com/elastic/elasticsearch-specification
2020
#
2121
module Elasticsearch
2222
module API
2323
module AsyncSearch
2424
module Actions
25-
# Retrieves the status of a previously submitted async search request given its ID.
25+
# Get the async search status.
26+
# Get the status of a previously submitted async search request given its identifier, without retrieving search results.
27+
# If the Elasticsearch security features are enabled, the access to the status of a specific async search is restricted to:
28+
# * The user or API key that submitted the original async search request.
29+
# * Users that have the +monitor+ cluster privilege or greater privileges.
2630
#
27-
# @option arguments [String] :id The async search ID
28-
# @option arguments [Time] :keep_alive Specify the time interval in which the results (partial or final) for this search will be available
31+
# @option arguments [String] :id A unique identifier for the async search. (*Required*)
32+
# @option arguments [Time] :keep_alive The length of time that the async search needs to be available.
33+
# Ongoing async searches and any saved search results are deleted after this period. Server default: 5d.
2934
# @option arguments [Hash] :headers Custom HTTP headers
3035
#
31-
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html
36+
# @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-async-search-submit
3237
#
3338
def status(arguments = {})
3439
request_opts = { endpoint: arguments[:endpoint] || 'async_search.status' }
@@ -48,7 +53,7 @@ def status(arguments = {})
4853
_id = arguments.delete(:id)
4954

5055
method = Elasticsearch::API::HTTP_GET
51-
path = "_async_search/status/#{Utils.__listify(_id)}"
56+
path = "_async_search/status/#{Utils.listify(_id)}"
5257
params = Utils.process_params(arguments)
5358

5459
Elasticsearch::API::Response.new(

0 commit comments

Comments
 (0)