You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: elasticsearch-api/lib/elasticsearch/api/actions/async_search/submit.rb
+4-4Lines changed: 4 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -35,29 +35,29 @@ module Actions
35
35
# Ongoing async searches and any saved search results are deleted after this period. Server default: 5d.
36
36
# @option arguments [Boolean] :keep_on_completion If `true`, results are stored for later retrieval when the search completes within the `wait_for_completion_timeout`.
37
37
# @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)
38
-
# @option arguments [Boolean] :allow_partial_search_results Indicate if an error should be returned if there is a partial search failure or timeout
38
+
# @option arguments [Boolean] :allow_partial_search_results Indicate if an error should be returned if there is a partial search failure or timeout Server default: true.
39
39
# @option arguments [String] :analyzer The analyzer to use for the query string
40
40
# @option arguments [Boolean] :analyze_wildcard Specify whether wildcard and prefix queries should be analyzed (default: false)
41
41
# @option arguments [Integer] :batched_reduce_size Affects how often partial results become available, which happens whenever shard results are reduced.
42
42
# 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.
43
43
# @option arguments [Boolean] :ccs_minimize_roundtrips The default value is the only supported value.
44
-
# @option arguments [String] :default_operator The default operator for query string query (AND or OR)
44
+
# @option arguments [String] :default_operator The default operator for query string query (AND or OR) Server default: or.
45
45
# @option arguments [String] :df The field to use as default where no field prefix is given in the query string
46
46
# @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
47
47
# @option arguments [String, Array<String>] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
48
48
# @option arguments [Boolean] :explain Specify whether to return detailed information about score computation as part of a hit
49
49
# @option arguments [Boolean] :ignore_throttled Whether specified concrete, expanded or aliased indices should be ignored when throttled
50
50
# @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
51
51
# @option arguments [Boolean] :lenient Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
52
-
# @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
52
+
# @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 Server default: 5.
53
53
# @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random)
54
54
# @option arguments [Boolean] :request_cache Specify if request cache should be used for this request or not, defaults to true Server default: true.
55
55
# @option arguments [String] :routing A comma-separated list of specific routing values
56
56
# @option arguments [String] :search_type Search operation type
57
57
# @option arguments [Array<String>] :stats Specific 'tag' of the request for logging and statistical purposes
58
58
# @option arguments [String, Array<String>] :stored_fields A comma-separated list of stored fields to return as part of a hit
59
59
# @option arguments [String] :suggest_field Specifies which field to use for suggestions.
# @option arguments [Integer] :suggest_size How many suggestions to return in response
62
62
# @option arguments [String] :suggest_text The source text for which the suggestions should be returned.
63
63
# @option arguments [Integer] :terminate_after The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.
Copy file name to clipboardExpand all lines: elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_data_frame_analytics.rb
+2-1Lines changed: 2 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -29,7 +29,8 @@ module Actions
29
29
# application consumption, use the get data frame analytics jobs statistics API.
30
30
#
31
31
# @option arguments [String] :id The ID of the data frame analytics to fetch
32
-
# @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no configs. (This includes `_all` string or when no configs have been specified)
32
+
# @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no configs.
33
+
# (This includes `_all` string or when no configs have been specified.)
33
34
# @option arguments [String, Array<String>] :h Comma-separated list of column names to display. Server default: create_time,id,state,type.
34
35
# @option arguments [String, Array<String>] :s Comma-separated list of column names or column aliases used to sort the
Copy file name to clipboardExpand all lines: elasticsearch-api/lib/elasticsearch/api/actions/cat/segments.rb
+10Lines changed: 10 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -40,6 +40,16 @@ module Actions
40
40
# from the cluster state of the master node. In both cases the coordinating
41
41
# node will send requests for further information to each selected node.
42
42
# @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
43
+
# @option arguments [String, Array<String>] :expand_wildcards Type of index that wildcard expressions can match. If the request can target data streams, this argument
44
+
# determines whether wildcard expressions match hidden data streams. Supports comma-separated values,
45
+
# such as open,hidden. Server default: open.
46
+
# @option arguments [Boolean] :allow_no_indices If false, the request returns an error if any wildcard expression, index alias, or _all value targets only
47
+
# missing or closed indices. This behavior applies even if the request targets other open indices. For example,
48
+
# a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. Server default: true.
49
+
# @option arguments [Boolean] :ignore_throttled If true, concrete, expanded or aliased indices are ignored when frozen.
50
+
# @option arguments [Boolean] :ignore_unavailable If true, missing or closed indices are not included in the response.
51
+
# @option arguments [Boolean] :allow_closed If true, allow closed indices to be returned in the response otherwise if false, keep the legacy behaviour
52
+
# of throwing an exception if index pattern matches closed indices
43
53
# @option arguments [String] :format Specifies the format to return the columnar data in, can be set to
44
54
# `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text.
45
55
# @option arguments [Boolean] :help When set to `true` will output available columns. This option
Copy file name to clipboardExpand all lines: elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/follow.rb
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -31,7 +31,7 @@ module Actions
31
31
# @option arguments [Integer, String] :wait_for_active_shards Specifies the number of shards to wait on being active before responding. This defaults to waiting on none of the shards to be
32
32
# active.
33
33
# A shard must be restored from the leader index before being active. Restoring a follower shard requires transferring all the
34
-
# remote Lucene segment files to the follower index.
34
+
# remote Lucene segment files to the follower index. Server default: 0.
35
35
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
36
36
# when they occur.
37
37
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
Copy file name to clipboardExpand all lines: elasticsearch-api/lib/elasticsearch/api/actions/dangling_indices/delete_dangling_index.rb
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -28,7 +28,7 @@ module Actions
28
28
#
29
29
# @option arguments [String] :index_uuid The UUID of the index to delete. Use the get dangling indices API to find the UUID. (*Required*)
30
30
# @option arguments [Boolean] :accept_data_loss This parameter must be set to true to acknowledge that it will no longer be possible to recove data from the dangling index. (*Required*)
31
-
# @option arguments [Time] :master_timeout Specify timeout for connection to master
31
+
# @option arguments [Time] :master_timeout Specify timeout for connection to master Server default: 30s.
Copy file name to clipboardExpand all lines: elasticsearch-api/lib/elasticsearch/api/actions/dangling_indices/import_dangling_index.rb
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -29,7 +29,7 @@ module Actions
29
29
# @option arguments [String] :index_uuid The UUID of the index to import. Use the get dangling indices API to locate the UUID. (*Required*)
30
30
# @option arguments [Boolean] :accept_data_loss This parameter must be set to true to import a dangling index.
31
31
# Because Elasticsearch cannot know where the dangling index data came from or determine which shard copies are fresh and which are stale, it cannot guarantee that the imported data represents the latest state of the index when it was last in the cluster. (*Required*)
32
-
# @option arguments [Time] :master_timeout Specify timeout for connection to master
32
+
# @option arguments [Time] :master_timeout Specify timeout for connection to master Server default: 30s.
0 commit comments