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
** *`include_source_on_error` (Optional, boolean)*: True or false if to include the document source in the error message in case of parsing errors.
152
153
** *`list_executed_pipelines` (Optional, boolean)*: If `true`, the response will include the ingest pipelines that were run for each index or create.
153
154
** *`pipeline` (Optional, string)*: The pipeline identifier to use to preprocess incoming documents. If the index has a default ingest pipeline specified, setting the value to `_none` turns off the default ingest pipeline for this request. If a final pipeline is configured, it will always run regardless of the value of this parameter.
154
155
** *`refresh` (Optional, Enum(true | false | "wait_for"))*: If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search. If `wait_for`, wait for a refresh to make this operation visible to search. If `false`, do nothing with refreshes. Valid values: `true`, `false`, `wait_for`.
@@ -323,6 +324,7 @@ client.create({ id, index })
323
324
** *`id` (string)*: A unique identifier for the document. To automatically generate a document ID, use the `POST /<target>/_doc/` request format.
324
325
** *`index` (string)*: The name of the data stream or index to target. If the target doesn't exist and matches the name or wildcard (`*`) pattern of an index template with a `data_stream` definition, this request creates the data stream. If the target doesn't exist and doesn’t match a data stream template, this request creates the index.
325
326
** *`document` (Optional, object)*: A document.
327
+
** *`include_source_on_error` (Optional, boolean)*: True or false if to include the document source in the error message in case of parsing errors.
326
328
** *`pipeline` (Optional, string)*: The ID of the pipeline to use to preprocess incoming documents. If the index has a default ingest pipeline specified, setting the value to `_none` turns off the default ingest pipeline for this request. If a final pipeline is configured, it will always run regardless of the value of this parameter.
327
329
** *`refresh` (Optional, Enum(true | false | "wait_for"))*: If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search. If `wait_for`, it waits for a refresh to make this operation visible to search. If `false`, it does nothing with refreshes.
328
330
** *`routing` (Optional, string)*: A custom value that is used to route operations to a specific shard.
@@ -1031,6 +1033,7 @@ client.index({ index })
1031
1033
** *`document` (Optional, object)*: A document.
1032
1034
** *`if_primary_term` (Optional, number)*: Only perform the operation if the document has this primary term.
1033
1035
** *`if_seq_no` (Optional, number)*: Only perform the operation if the document has this sequence number.
1036
+
** *`include_source_on_error` (Optional, boolean)*: True or false if to include the document source in the error message in case of parsing errors.
1034
1037
** *`op_type` (Optional, Enum("index" | "create"))*: Set to `create` to only index the document if it does not already exist (put if absent). If a document with the specified `_id` already exists, the indexing operation will fail. The behavior is the same as using the `<index>/_create` endpoint. If a document ID is specified, this paramater defaults to `index`. Otherwise, it defaults to `create`. If the request targets a data stream, an `op_type` of `create` is required.
1035
1038
** *`pipeline` (Optional, string)*: The 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.
1036
1039
** *`refresh` (Optional, Enum(true | false | "wait_for"))*: If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search. If `wait_for`, it waits for a refresh to make this operation visible to search. If `false`, it does nothing with refreshes.
@@ -2140,6 +2143,7 @@ client.update({ id, index })
2140
2143
** *`upsert` (Optional, object)*: If the document does not already exist, the contents of 'upsert' are inserted as a new document. If the document exists, the 'script' is run.
2141
2144
** *`if_primary_term` (Optional, number)*: Only perform the operation if the document has this primary term.
2142
2145
** *`if_seq_no` (Optional, number)*: Only perform the operation if the document has this sequence number.
2146
+
** *`include_source_on_error` (Optional, boolean)*: True or false if to include the document source in the error message in case of parsing errors.
2143
2147
** *`lang` (Optional, string)*: The script language.
2144
2148
** *`refresh` (Optional, Enum(true | false | "wait_for"))*: If 'true', Elasticsearch refreshes the affected shards to make this operation visible to search. If 'wait_for', it waits for a refresh to make this operation visible to search. If 'false', it does nothing with refreshes.
2145
2149
** *`require_alias` (Optional, boolean)*: If `true`, the destination must be an index alias.
@@ -2341,7 +2345,7 @@ client.asyncSearch.get({ id })
2341
2345
2342
2346
* *Request (object):*
2343
2347
** *`id` (string)*: A unique identifier for the async search.
2344
-
** *`keep_alive` (Optional, string | -1 | 0)*: Specifies how long the async search should be available in the cluster.
2348
+
** *`keep_alive` (Optional, string | -1 | 0)*: The length of time that the async search should be available in the cluster.
2345
2349
When not specified, the `keep_alive` set with the corresponding submit async request will be used.
2346
2350
Otherwise, it is possible to override the value and extend the validity of the request.
2347
2351
When this period expires, the search, if still running, is cancelled.
@@ -2356,7 +2360,10 @@ By default no timeout is set meaning that the currently available results will b
2356
2360
Get the async search status.
2357
2361
2358
2362
Get the status of a previously submitted async search request given its identifier, without retrieving search results.
2359
-
If the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role.
2363
+
If the Elasticsearch security features are enabled, the access to the status of a specific async search is restricted to:
2364
+
2365
+
* The user or API key that submitted the original async search request.
2366
+
* Users that have the `monitor` cluster privilege or greater privileges.
Copy file name to clipboardexpand all lines: src/api/api/async_search.ts
+1-1
Original file line number
Diff line number
Diff line change
@@ -128,7 +128,7 @@ export default class AsyncSearch {
128
128
}
129
129
130
130
/**
131
-
* 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, use of this API is restricted tothe `monitoring_user` role.
131
+
* 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.
132
132
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-async-search-submit | Elasticsearch API documentation}
0 commit comments