Skip to content

Commit 4925c5e

Browse files
committed
[API] Updates async_search.submit and open_point_in_time
async_search.submit: * Removes keep_alive * Adds css_minimize_roundtrips, rest_total_hits_as_int open_point_in_time: * Adds allow_partial_search_results
1 parent 30c8fbc commit 4925c5e

File tree

2 files changed

+3
-1
lines changed

2 files changed

+3
-1
lines changed

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

+2-1
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,11 @@ module Actions
2727
# @option arguments [List] :index A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
2828
# @option arguments [Time] :wait_for_completion_timeout Specify the time that the request should block waiting for the final response
2929
# @option arguments [Boolean] :keep_on_completion Control whether the response should be stored in the cluster if it completed within the provided [wait_for_completion] time (default: false)
30-
# @option arguments [Time] :keep_alive Update the time interval in which the results (partial or final) for this search will be available
3130
# @option arguments [Number] :batched_reduce_size The number of shard results that should be reduced at once on the coordinating node. This value should be used as the granularity at which progress results will be made available.
3231
# @option arguments [Boolean] :request_cache Specify if request cache should be used for this request or not, defaults to true
3332
# @option arguments [String] :analyzer The analyzer to use for the query string
3433
# @option arguments [Boolean] :analyze_wildcard Specify whether wildcard and prefix queries should be analyzed (default: false)
34+
# @option arguments [Boolean] :ccs_minimize_roundtrips When doing a cross-cluster search, setting it to true may improve overall search latency, particularly when searching clusters with a large number of shards. However, when set to true, the progress of searches on the remote clusters will not be received until the search finishes on all clusters.
3535
# @option arguments [String] :default_operator The default operator for query string query (AND or OR) (options: AND, OR)
3636
# @option arguments [String] :df The field to use as default where no field prefix is given in the query string
3737
# @option arguments [Boolean] :explain Specify whether to return detailed information about score computation as part of a hit
@@ -44,6 +44,7 @@ module Actions
4444
# @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)
4545
# @option arguments [Boolean] :lenient Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
4646
# @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random)
47+
# @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
4748
# @option arguments [String] :q Query in the Lucene query string syntax
4849
# @option arguments [List] :routing A comma-separated list of specific routing values
4950
# @option arguments [String] :search_type Search operation type (options: query_then_fetch, dfs_query_then_fetch)

elasticsearch-api/lib/elasticsearch/api/actions/open_point_in_time.rb

+1
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ module Actions
2929
# @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
3030
# @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)
3131
# @option arguments [String] :keep_alive Specific the time to live for the point in time (*Required*)
32+
# @option arguments [Boolean] :allow_partial_search_results Specify whether to tolerate shards missing when creating the point-in-time, or otherwise throw an exception. (default: false)
3233
# @option arguments [Hash] :headers Custom HTTP headers
3334
# @option arguments [Hash] :body An index_filter specified with the Query DSL
3435
#

0 commit comments

Comments
 (0)