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: lib/opensearch/api/actions/asynchronous_search/search.rb
+4-4Lines changed: 4 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -13,12 +13,12 @@ module OpenSearch
13
13
moduleAPI
14
14
moduleAsynchronousSearch
15
15
moduleActions
16
-
# Performs an asynchronous search.
16
+
# Perform an asynchronous search.
17
17
#
18
18
# @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.
19
-
# @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.
20
-
# @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.
21
-
# @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`.
19
+
# @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 overruns this time, the process cancels this query automatically.
20
+
# @option args [Boolean] :keep_on_completion Whether you want to save the results in the cluster after the search is complete.
21
+
# @option args [String] :wait_for_completion_timeout The amount of time that you plan to wait for the results. You can poll the remaining results based on an ID. The maximum value is `300s`. Default is `1s`.
22
22
# @option args [Hash] :body The search definition using the Query DSL.
Copy file name to clipboardExpand all lines: lib/opensearch/api/actions/bulk_stream.rb
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -23,7 +23,7 @@ module Actions
23
23
# @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.
24
24
# @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`.
25
25
# @option args [Boolean] :require_alias If `true`, the request's actions must target an index alias.
26
-
# @option args [Hash] :routing Custom value used to route operations to a specific shard.
26
+
# @option args [Enumerable<String>, String] :routing Custom value used to route operations to a specific shard.
27
27
# @option args [String] :timeout Period each action waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards.
28
28
# @option args [String] :type Default document type for items which don't provide one.
29
29
# @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`).
Copy file name to clipboardExpand all lines: lib/opensearch/api/actions/cat/aliases.rb
+8-8Lines changed: 8 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -13,15 +13,15 @@ module OpenSearch
13
13
moduleAPI
14
14
moduleCat
15
15
moduleActions
16
-
# Shows information about aliases currently configured to indexes, including filter and routing information.
16
+
# Shows information about currently configured aliases to indexes including filter and routing info.
17
17
#
18
-
# @option args [Enumerable<String>, String] :expand_wildcards Specifies the type of index that wildcard expressions can match. Supports comma-separated values.
19
-
# @option args [String] :format A short version of the `Accept` header, such as `json` or `yaml`.
20
-
# @option args [Enumerable<String>] :h A comma-separated list of column names to display.
21
-
# @option args [Boolean] :help Returns help information.
22
-
# @option args [Boolean] :local Whether to return information from the local node only instead of from the clustermanager node.
23
-
# @option args [Enumerable<String>] :s A comma-separated list of column names or column aliases to sort by.
# @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`.
# @option args [Enumerable<String>, String] :index Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`.
0 commit comments