@elastic/elasticsearch 9.3.0 → 9.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/esm/api/api/async_search.d.ts +4 -4
- package/esm/api/api/autoscaling.d.ts +4 -4
- package/esm/api/api/bulk.d.ts +1 -1
- package/esm/api/api/cat.d.ts +27 -27
- package/esm/api/api/ccr.d.ts +13 -13
- package/esm/api/api/clear_scroll.d.ts +1 -1
- package/esm/api/api/close_point_in_time.d.ts +1 -1
- package/esm/api/api/cluster.d.ts +16 -16
- package/esm/api/api/connector.d.ts +30 -30
- package/esm/api/api/count.d.ts +1 -1
- package/esm/api/api/create.d.ts +1 -1
- package/esm/api/api/dangling_indices.d.ts +3 -3
- package/esm/api/api/delete.d.ts +1 -1
- package/esm/api/api/delete_by_query.d.ts +1 -1
- package/esm/api/api/delete_by_query_rethrottle.d.ts +1 -1
- package/esm/api/api/delete_script.d.ts +1 -1
- package/esm/api/api/enrich.d.ts +5 -5
- package/esm/api/api/eql.d.ts +4 -4
- package/esm/api/api/esql.d.ts +6 -6
- package/esm/api/api/exists.d.ts +1 -1
- package/esm/api/api/exists_source.d.ts +1 -1
- package/esm/api/api/explain.d.ts +1 -1
- package/esm/api/api/features.d.ts +2 -2
- package/esm/api/api/field_caps.d.ts +1 -1
- package/esm/api/api/fleet.d.ts +3 -3
- package/esm/api/api/get.d.ts +1 -1
- package/esm/api/api/get_script.d.ts +1 -1
- package/esm/api/api/get_script_context.d.ts +1 -1
- package/esm/api/api/get_script_languages.d.ts +1 -1
- package/esm/api/api/get_source.d.ts +1 -1
- package/esm/api/api/graph.d.ts +1 -1
- package/esm/api/api/health_report.d.ts +1 -1
- package/esm/api/api/ilm.d.ts +11 -11
- package/esm/api/api/index.d.ts +1 -1
- package/esm/api/api/indices.d.ts +71 -71
- package/esm/api/api/inference.d.ts +36 -36
- package/esm/api/api/info.d.ts +1 -1
- package/esm/api/api/ingest.d.ts +9 -9
- package/esm/api/api/knn_search.d.ts +1 -1
- package/esm/api/api/license.d.ts +7 -7
- package/esm/api/api/logstash.d.ts +3 -3
- package/esm/api/api/mget.d.ts +1 -1
- package/esm/api/api/migration.d.ts +3 -3
- package/esm/api/api/ml.d.ts +72 -72
- package/esm/api/api/monitoring.d.ts +1 -1
- package/esm/api/api/msearch.d.ts +1 -1
- package/esm/api/api/msearch_template.d.ts +1 -1
- package/esm/api/api/mtermvectors.d.ts +1 -1
- package/esm/api/api/nodes.d.ts +7 -7
- package/esm/api/api/open_point_in_time.d.ts +1 -1
- package/esm/api/api/ping.d.ts +1 -1
- package/esm/api/api/put_script.d.ts +1 -1
- package/esm/api/api/query_rules.d.ts +8 -8
- package/esm/api/api/rank_eval.d.ts +1 -1
- package/esm/api/api/reindex.d.ts +1 -1
- package/esm/api/api/reindex_rethrottle.d.ts +1 -1
- package/esm/api/api/render_search_template.d.ts +1 -1
- package/esm/api/api/rollup.d.ts +8 -8
- package/esm/api/api/scroll.d.ts +1 -1
- package/esm/api/api/search.d.ts +1 -1
- package/esm/api/api/search_application.d.ts +10 -10
- package/esm/api/api/search_mvt.d.ts +1 -1
- package/esm/api/api/search_shards.d.ts +1 -1
- package/esm/api/api/search_template.d.ts +1 -1
- package/esm/api/api/searchable_snapshots.d.ts +4 -4
- package/esm/api/api/security.d.ts +65 -65
- package/esm/api/api/shutdown.d.ts +3 -3
- package/esm/api/api/simulate.d.ts +1 -1
- package/esm/api/api/slm.d.ts +9 -9
- package/esm/api/api/snapshot.d.ts +13 -13
- package/esm/api/api/sql.d.ts +6 -6
- package/esm/api/api/ssl.d.ts +1 -1
- package/esm/api/api/synonyms.d.ts +7 -7
- package/esm/api/api/tasks.d.ts +3 -3
- package/esm/api/api/terms_enum.d.ts +1 -1
- package/esm/api/api/termvectors.d.ts +1 -1
- package/esm/api/api/text_structure.d.ts +4 -4
- package/esm/api/api/transform.d.ts +13 -13
- package/esm/api/api/update.d.ts +1 -1
- package/esm/api/api/update_by_query.d.ts +1 -1
- package/esm/api/api/update_by_query_rethrottle.d.ts +1 -1
- package/esm/api/api/watcher.d.ts +13 -13
- package/esm/api/api/xpack.d.ts +2 -2
- package/esm/api/types.d.ts +2 -1
- package/esm/api/types.d.ts.map +1 -1
- package/esm/client.d.ts.map +1 -1
- package/esm/client.js +3 -8
- package/esm/client.js.map +1 -1
- package/esm/index.d.ts +1 -0
- package/esm/index.d.ts.map +1 -1
- package/esm/index.js +1 -0
- package/esm/index.js.map +1 -1
- package/esm/version.generated.d.ts +3 -0
- package/esm/version.generated.d.ts.map +1 -0
- package/esm/version.generated.js +9 -0
- package/esm/version.generated.js.map +1 -0
- package/lib/api/api/async_search.d.ts +4 -4
- package/lib/api/api/autoscaling.d.ts +4 -4
- package/lib/api/api/bulk.d.ts +1 -1
- package/lib/api/api/cat.d.ts +27 -27
- package/lib/api/api/ccr.d.ts +13 -13
- package/lib/api/api/clear_scroll.d.ts +1 -1
- package/lib/api/api/close_point_in_time.d.ts +1 -1
- package/lib/api/api/cluster.d.ts +16 -16
- package/lib/api/api/connector.d.ts +30 -30
- package/lib/api/api/count.d.ts +1 -1
- package/lib/api/api/create.d.ts +1 -1
- package/lib/api/api/dangling_indices.d.ts +3 -3
- package/lib/api/api/delete.d.ts +1 -1
- package/lib/api/api/delete_by_query.d.ts +1 -1
- package/lib/api/api/delete_by_query_rethrottle.d.ts +1 -1
- package/lib/api/api/delete_script.d.ts +1 -1
- package/lib/api/api/enrich.d.ts +5 -5
- package/lib/api/api/eql.d.ts +4 -4
- package/lib/api/api/esql.d.ts +6 -6
- package/lib/api/api/exists.d.ts +1 -1
- package/lib/api/api/exists_source.d.ts +1 -1
- package/lib/api/api/explain.d.ts +1 -1
- package/lib/api/api/features.d.ts +2 -2
- package/lib/api/api/field_caps.d.ts +1 -1
- package/lib/api/api/fleet.d.ts +3 -3
- package/lib/api/api/get.d.ts +1 -1
- package/lib/api/api/get_script.d.ts +1 -1
- package/lib/api/api/get_script_context.d.ts +1 -1
- package/lib/api/api/get_script_languages.d.ts +1 -1
- package/lib/api/api/get_source.d.ts +1 -1
- package/lib/api/api/graph.d.ts +1 -1
- package/lib/api/api/health_report.d.ts +1 -1
- package/lib/api/api/ilm.d.ts +11 -11
- package/lib/api/api/index.d.ts +1 -1
- package/lib/api/api/indices.d.ts +71 -71
- package/lib/api/api/inference.d.ts +36 -36
- package/lib/api/api/info.d.ts +1 -1
- package/lib/api/api/ingest.d.ts +9 -9
- package/lib/api/api/knn_search.d.ts +1 -1
- package/lib/api/api/license.d.ts +7 -7
- package/lib/api/api/logstash.d.ts +3 -3
- package/lib/api/api/mget.d.ts +1 -1
- package/lib/api/api/migration.d.ts +3 -3
- package/lib/api/api/ml.d.ts +72 -72
- package/lib/api/api/monitoring.d.ts +1 -1
- package/lib/api/api/msearch.d.ts +1 -1
- package/lib/api/api/msearch_template.d.ts +1 -1
- package/lib/api/api/mtermvectors.d.ts +1 -1
- package/lib/api/api/nodes.d.ts +7 -7
- package/lib/api/api/open_point_in_time.d.ts +1 -1
- package/lib/api/api/ping.d.ts +1 -1
- package/lib/api/api/put_script.d.ts +1 -1
- package/lib/api/api/query_rules.d.ts +8 -8
- package/lib/api/api/rank_eval.d.ts +1 -1
- package/lib/api/api/reindex.d.ts +1 -1
- package/lib/api/api/reindex_rethrottle.d.ts +1 -1
- package/lib/api/api/render_search_template.d.ts +1 -1
- package/lib/api/api/rollup.d.ts +8 -8
- package/lib/api/api/scroll.d.ts +1 -1
- package/lib/api/api/search.d.ts +1 -1
- package/lib/api/api/search_application.d.ts +10 -10
- package/lib/api/api/search_mvt.d.ts +1 -1
- package/lib/api/api/search_shards.d.ts +1 -1
- package/lib/api/api/search_template.d.ts +1 -1
- package/lib/api/api/searchable_snapshots.d.ts +4 -4
- package/lib/api/api/security.d.ts +65 -65
- package/lib/api/api/shutdown.d.ts +3 -3
- package/lib/api/api/simulate.d.ts +1 -1
- package/lib/api/api/slm.d.ts +9 -9
- package/lib/api/api/snapshot.d.ts +13 -13
- package/lib/api/api/sql.d.ts +6 -6
- package/lib/api/api/ssl.d.ts +1 -1
- package/lib/api/api/synonyms.d.ts +7 -7
- package/lib/api/api/tasks.d.ts +3 -3
- package/lib/api/api/terms_enum.d.ts +1 -1
- package/lib/api/api/termvectors.d.ts +1 -1
- package/lib/api/api/text_structure.d.ts +4 -4
- package/lib/api/api/transform.d.ts +13 -13
- package/lib/api/api/update.d.ts +1 -1
- package/lib/api/api/update_by_query.d.ts +1 -1
- package/lib/api/api/update_by_query_rethrottle.d.ts +1 -1
- package/lib/api/api/watcher.d.ts +13 -13
- package/lib/api/api/xpack.d.ts +2 -2
- package/lib/api/types.d.ts +2 -1
- package/lib/client.js +3 -6
- package/lib/client.js.map +1 -1
- package/lib/index.js.map +1 -1
- package/lib/version.generated.d.ts +2 -0
- package/lib/version.generated.js +12 -0
- package/lib/version.generated.js.map +1 -0
- package/package.json +6 -4
|
@@ -19,7 +19,7 @@ export default class Monitoring {
|
|
|
19
19
|
constructor(transport: Transport);
|
|
20
20
|
/**
|
|
21
21
|
* Send monitoring data. This API is used by the monitoring features to send monitoring data.
|
|
22
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch | Elasticsearch API documentation}
|
|
22
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/ | Elasticsearch API documentation}
|
|
23
23
|
*/
|
|
24
24
|
bulk<TDocument = unknown, TPartialDocument = unknown>(this: That, params: T.MonitoringBulkRequest<TDocument, TPartialDocument>, options?: TransportRequestOptionsWithOutMeta): Promise<T.MonitoringBulkResponse>;
|
|
25
25
|
bulk<TDocument = unknown, TPartialDocument = unknown>(this: That, params: T.MonitoringBulkRequest<TDocument, TPartialDocument>, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MonitoringBulkResponse, unknown>>;
|
package/esm/api/api/msearch.d.ts
CHANGED
|
@@ -5,7 +5,7 @@ interface That {
|
|
|
5
5
|
}
|
|
6
6
|
/**
|
|
7
7
|
* Run multiple searches. The format of the request is similar to the bulk API format and makes use of the newline delimited JSON (NDJSON) format. The structure is as follows: ``` header\n body\n header\n body\n ``` This structure is specifically optimized to reduce parsing if a specific search ends up redirected to another node. IMPORTANT: The final line of data must end with a newline character `\n`. Each newline character may be preceded by a carriage return `\r`. When sending requests to this endpoint the `Content-Type` header should be set to `application/x-ndjson`.
|
|
8
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-msearch | Elasticsearch API documentation}
|
|
8
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-msearch | Elasticsearch API documentation}
|
|
9
9
|
*/
|
|
10
10
|
export default function MsearchApi<TDocument = unknown, TAggregations = Record<T.AggregateName, T.AggregationsAggregate>>(this: That, params: T.MsearchRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MsearchResponse<TDocument, TAggregations>>;
|
|
11
11
|
export default function MsearchApi<TDocument = unknown, TAggregations = Record<T.AggregateName, T.AggregationsAggregate>>(this: That, params: T.MsearchRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MsearchResponse<TDocument, TAggregations>, unknown>>;
|
|
@@ -5,7 +5,7 @@ interface That {
|
|
|
5
5
|
}
|
|
6
6
|
/**
|
|
7
7
|
* Run multiple templated searches. Run multiple templated searches with a single request. If you are providing a text file or text input to `curl`, use the `--data-binary` flag instead of `-d` to preserve newlines. For example: ``` $ cat requests { "index": "my-index" } { "id": "my-search-template", "params": { "query_string": "hello world", "from": 0, "size": 10 }} { "index": "my-other-index" } { "id": "my-other-search-template", "params": { "query_type": "match_all" }} $ curl -H "Content-Type: application/x-ndjson" -XGET localhost:9200/_msearch/template --data-binary "@requests"; echo ```
|
|
8
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-msearch-template | Elasticsearch API documentation}
|
|
8
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-msearch-template | Elasticsearch API documentation}
|
|
9
9
|
*/
|
|
10
10
|
export default function MsearchTemplateApi<TDocument = unknown, TAggregations = Record<T.AggregateName, T.AggregationsAggregate>>(this: That, params: T.MsearchTemplateRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MsearchTemplateResponse<TDocument, TAggregations>>;
|
|
11
11
|
export default function MsearchTemplateApi<TDocument = unknown, TAggregations = Record<T.AggregateName, T.AggregationsAggregate>>(this: That, params: T.MsearchTemplateRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MsearchTemplateResponse<TDocument, TAggregations>, unknown>>;
|
|
@@ -5,7 +5,7 @@ interface That {
|
|
|
5
5
|
}
|
|
6
6
|
/**
|
|
7
7
|
* Get multiple term vectors. Get multiple term vectors with a single request. You can specify existing documents by index and ID or provide artificial documents in the body of the request. You can specify the index in the request body or request URI. The response contains a `docs` array with all the fetched termvectors. Each element has the structure provided by the termvectors API. **Artificial documents** You can also use `mtermvectors` to generate term vectors for artificial documents provided in the body of the request. The mapping used is determined by the specified `_index`.
|
|
8
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-mtermvectors | Elasticsearch API documentation}
|
|
8
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-mtermvectors | Elasticsearch API documentation}
|
|
9
9
|
*/
|
|
10
10
|
export default function MtermvectorsApi(this: That, params?: T.MtermvectorsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MtermvectorsResponse>;
|
|
11
11
|
export default function MtermvectorsApi(this: That, params?: T.MtermvectorsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MtermvectorsResponse, unknown>>;
|
package/esm/api/api/nodes.d.ts
CHANGED
|
@@ -19,49 +19,49 @@ export default class Nodes {
|
|
|
19
19
|
constructor(transport: Transport);
|
|
20
20
|
/**
|
|
21
21
|
* Clear the archived repositories metering. Clear the archived repositories metering information in the cluster.
|
|
22
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-nodes-clear-repositories-metering-archive | Elasticsearch API documentation}
|
|
22
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-nodes-clear-repositories-metering-archive | Elasticsearch API documentation}
|
|
23
23
|
*/
|
|
24
24
|
clearRepositoriesMeteringArchive(this: That, params: T.NodesClearRepositoriesMeteringArchiveRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.NodesClearRepositoriesMeteringArchiveResponse>;
|
|
25
25
|
clearRepositoriesMeteringArchive(this: That, params: T.NodesClearRepositoriesMeteringArchiveRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.NodesClearRepositoriesMeteringArchiveResponse, unknown>>;
|
|
26
26
|
clearRepositoriesMeteringArchive(this: That, params: T.NodesClearRepositoriesMeteringArchiveRequest, options?: TransportRequestOptions): Promise<T.NodesClearRepositoriesMeteringArchiveResponse>;
|
|
27
27
|
/**
|
|
28
28
|
* Get cluster repositories metering. Get repositories metering information for a cluster. This API exposes monotonically non-decreasing counters and it is expected that clients would durably store the information needed to compute aggregations over a period of time. Additionally, the information exposed by this API is volatile, meaning that it will not be present after node restarts.
|
|
29
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-nodes-get-repositories-metering-info | Elasticsearch API documentation}
|
|
29
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-nodes-get-repositories-metering-info | Elasticsearch API documentation}
|
|
30
30
|
*/
|
|
31
31
|
getRepositoriesMeteringInfo(this: That, params: T.NodesGetRepositoriesMeteringInfoRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.NodesGetRepositoriesMeteringInfoResponse>;
|
|
32
32
|
getRepositoriesMeteringInfo(this: That, params: T.NodesGetRepositoriesMeteringInfoRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.NodesGetRepositoriesMeteringInfoResponse, unknown>>;
|
|
33
33
|
getRepositoriesMeteringInfo(this: That, params: T.NodesGetRepositoriesMeteringInfoRequest, options?: TransportRequestOptions): Promise<T.NodesGetRepositoriesMeteringInfoResponse>;
|
|
34
34
|
/**
|
|
35
35
|
* Get the hot threads for nodes. Get a breakdown of the hot threads on each selected node in the cluster. The output is plain text with a breakdown of the top hot threads for each node.
|
|
36
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-nodes-hot-threads | Elasticsearch API documentation}
|
|
36
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-nodes-hot-threads | Elasticsearch API documentation}
|
|
37
37
|
*/
|
|
38
38
|
hotThreads(this: That, params?: T.NodesHotThreadsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.NodesHotThreadsResponse>;
|
|
39
39
|
hotThreads(this: That, params?: T.NodesHotThreadsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.NodesHotThreadsResponse, unknown>>;
|
|
40
40
|
hotThreads(this: That, params?: T.NodesHotThreadsRequest, options?: TransportRequestOptions): Promise<T.NodesHotThreadsResponse>;
|
|
41
41
|
/**
|
|
42
42
|
* Get node information. By default, the API returns all attributes and core settings for cluster nodes.
|
|
43
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-nodes-info | Elasticsearch API documentation}
|
|
43
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-nodes-info | Elasticsearch API documentation}
|
|
44
44
|
*/
|
|
45
45
|
info(this: That, params?: T.NodesInfoRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.NodesInfoResponse>;
|
|
46
46
|
info(this: That, params?: T.NodesInfoRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.NodesInfoResponse, unknown>>;
|
|
47
47
|
info(this: That, params?: T.NodesInfoRequest, options?: TransportRequestOptions): Promise<T.NodesInfoResponse>;
|
|
48
48
|
/**
|
|
49
49
|
* Reload the keystore on nodes in the cluster. Secure settings are stored in an on-disk keystore. Certain of these settings are reloadable. That is, you can change them on disk and reload them without restarting any nodes in the cluster. When you have updated reloadable secure settings in your keystore, you can use this API to reload those settings on each node. When the Elasticsearch keystore is password protected and not simply obfuscated, you must provide the password for the keystore when you reload the secure settings. Reloading the settings for the whole cluster assumes that the keystores for all nodes are protected with the same password; this method is allowed only when inter-node communications are encrypted. Alternatively, you can reload the secure settings on each node by locally accessing the API and passing the node-specific Elasticsearch keystore password.
|
|
50
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-nodes-reload-secure-settings | Elasticsearch API documentation}
|
|
50
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-nodes-reload-secure-settings | Elasticsearch API documentation}
|
|
51
51
|
*/
|
|
52
52
|
reloadSecureSettings(this: That, params?: T.NodesReloadSecureSettingsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.NodesReloadSecureSettingsResponse>;
|
|
53
53
|
reloadSecureSettings(this: That, params?: T.NodesReloadSecureSettingsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.NodesReloadSecureSettingsResponse, unknown>>;
|
|
54
54
|
reloadSecureSettings(this: That, params?: T.NodesReloadSecureSettingsRequest, options?: TransportRequestOptions): Promise<T.NodesReloadSecureSettingsResponse>;
|
|
55
55
|
/**
|
|
56
56
|
* Get node statistics. Get statistics for nodes in a cluster. By default, all stats are returned. You can limit the returned information by using metrics.
|
|
57
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-nodes-stats | Elasticsearch API documentation}
|
|
57
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-nodes-stats | Elasticsearch API documentation}
|
|
58
58
|
*/
|
|
59
59
|
stats(this: That, params?: T.NodesStatsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.NodesStatsResponse>;
|
|
60
60
|
stats(this: That, params?: T.NodesStatsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.NodesStatsResponse, unknown>>;
|
|
61
61
|
stats(this: That, params?: T.NodesStatsRequest, options?: TransportRequestOptions): Promise<T.NodesStatsResponse>;
|
|
62
62
|
/**
|
|
63
63
|
* Get feature usage information.
|
|
64
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-nodes-usage | Elasticsearch API documentation}
|
|
64
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-nodes-usage | Elasticsearch API documentation}
|
|
65
65
|
*/
|
|
66
66
|
usage(this: That, params?: T.NodesUsageRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.NodesUsageResponse>;
|
|
67
67
|
usage(this: That, params?: T.NodesUsageRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.NodesUsageResponse, unknown>>;
|
|
@@ -5,7 +5,7 @@ interface That {
|
|
|
5
5
|
}
|
|
6
6
|
/**
|
|
7
7
|
* Open a point in time. A search request by default runs against the most recent visible data of the target indices, which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple search requests using the same point in time. For example, if refreshes happen between `search_after` requests, then the results of those requests might not be consistent as changes happening between searches are only visible to the more recent point in time. A point in time must be opened explicitly before being used in search requests. A subsequent search request with the `pit` parameter must not specify `index`, `routing`, or `preference` values as these parameters are copied from the point in time. Just like regular searches, you can use `from` and `size` to page through point in time search results, up to the first 10,000 hits. If you want to retrieve more hits, use PIT with `search_after`. IMPORTANT: The open point in time request and each subsequent search request can return different identifiers; always use the most recently received ID for the next search request. When a PIT that contains shard failures is used in a search request, the missing are always reported in the search response as a `NoShardAvailableActionException` exception. To get rid of these exceptions, a new PIT needs to be created so that shards missing from the previous PIT can be handled, assuming they become available in the meantime. **Keeping point in time alive** The `keep_alive` parameter, which is passed to a open point in time request and search request, extends the time to live of the corresponding point in time. The value does not need to be long enough to process all data — it just needs to be long enough for the next request. Normally, the background merge process optimizes the index by merging together smaller segments to create new, bigger segments. Once the smaller segments are no longer needed they are deleted. However, open point-in-times prevent the old segments from being deleted since they are still in use. TIP: Keeping older segments alive means that more disk space and file handles are needed. Ensure that you have configured your nodes to have ample free file handles. Additionally, if a segment contains deleted or updated documents then the point in time must keep track of whether each document in the segment was live at the time of the initial search request. Ensure that your nodes have sufficient heap space if you have many open point-in-times on an index that is subject to ongoing deletes or updates. Note that a point-in-time doesn't prevent its associated indices from being deleted. You can check how many point-in-times (that is, search contexts) are open with the nodes stats API.
|
|
8
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-open-point-in-time | Elasticsearch API documentation}
|
|
8
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-open-point-in-time | Elasticsearch API documentation}
|
|
9
9
|
*/
|
|
10
10
|
export default function OpenPointInTimeApi(this: That, params: T.OpenPointInTimeRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.OpenPointInTimeResponse>;
|
|
11
11
|
export default function OpenPointInTimeApi(this: That, params: T.OpenPointInTimeRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.OpenPointInTimeResponse, unknown>>;
|
package/esm/api/api/ping.d.ts
CHANGED
|
@@ -5,7 +5,7 @@ interface That {
|
|
|
5
5
|
}
|
|
6
6
|
/**
|
|
7
7
|
* Ping the cluster. Get information about whether the cluster is running.
|
|
8
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-cluster | Elasticsearch API documentation}
|
|
8
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-cluster | Elasticsearch API documentation}
|
|
9
9
|
*/
|
|
10
10
|
export default function PingApi(this: That, params?: T.PingRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.PingResponse>;
|
|
11
11
|
export default function PingApi(this: That, params?: T.PingRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.PingResponse, unknown>>;
|
|
@@ -5,7 +5,7 @@ interface That {
|
|
|
5
5
|
}
|
|
6
6
|
/**
|
|
7
7
|
* Create or update a script or search template. Creates or updates a stored script or search template.
|
|
8
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-put-script | Elasticsearch API documentation}
|
|
8
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-put-script | Elasticsearch API documentation}
|
|
9
9
|
*/
|
|
10
10
|
export default function PutScriptApi(this: That, params: T.PutScriptRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.PutScriptResponse>;
|
|
11
11
|
export default function PutScriptApi(this: That, params: T.PutScriptRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.PutScriptResponse, unknown>>;
|
|
@@ -19,56 +19,56 @@ export default class QueryRules {
|
|
|
19
19
|
constructor(transport: Transport);
|
|
20
20
|
/**
|
|
21
21
|
* Delete a query rule. Delete a query rule within a query ruleset. This is a destructive action that is only recoverable by re-adding the same rule with the create or update query rule API.
|
|
22
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-query-rules-delete-rule | Elasticsearch API documentation}
|
|
22
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-query-rules-delete-rule | Elasticsearch API documentation}
|
|
23
23
|
*/
|
|
24
24
|
deleteRule(this: That, params: T.QueryRulesDeleteRuleRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.QueryRulesDeleteRuleResponse>;
|
|
25
25
|
deleteRule(this: That, params: T.QueryRulesDeleteRuleRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.QueryRulesDeleteRuleResponse, unknown>>;
|
|
26
26
|
deleteRule(this: That, params: T.QueryRulesDeleteRuleRequest, options?: TransportRequestOptions): Promise<T.QueryRulesDeleteRuleResponse>;
|
|
27
27
|
/**
|
|
28
28
|
* Delete a query ruleset. Remove a query ruleset and its associated data. This is a destructive action that is not recoverable.
|
|
29
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-query-rules-delete-ruleset | Elasticsearch API documentation}
|
|
29
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-query-rules-delete-ruleset | Elasticsearch API documentation}
|
|
30
30
|
*/
|
|
31
31
|
deleteRuleset(this: That, params: T.QueryRulesDeleteRulesetRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.QueryRulesDeleteRulesetResponse>;
|
|
32
32
|
deleteRuleset(this: That, params: T.QueryRulesDeleteRulesetRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.QueryRulesDeleteRulesetResponse, unknown>>;
|
|
33
33
|
deleteRuleset(this: That, params: T.QueryRulesDeleteRulesetRequest, options?: TransportRequestOptions): Promise<T.QueryRulesDeleteRulesetResponse>;
|
|
34
34
|
/**
|
|
35
35
|
* Get a query rule. Get details about a query rule within a query ruleset.
|
|
36
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-query-rules-get-rule | Elasticsearch API documentation}
|
|
36
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-query-rules-get-rule | Elasticsearch API documentation}
|
|
37
37
|
*/
|
|
38
38
|
getRule(this: That, params: T.QueryRulesGetRuleRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.QueryRulesGetRuleResponse>;
|
|
39
39
|
getRule(this: That, params: T.QueryRulesGetRuleRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.QueryRulesGetRuleResponse, unknown>>;
|
|
40
40
|
getRule(this: That, params: T.QueryRulesGetRuleRequest, options?: TransportRequestOptions): Promise<T.QueryRulesGetRuleResponse>;
|
|
41
41
|
/**
|
|
42
42
|
* Get a query ruleset. Get details about a query ruleset.
|
|
43
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-query-rules-get-ruleset | Elasticsearch API documentation}
|
|
43
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-query-rules-get-ruleset | Elasticsearch API documentation}
|
|
44
44
|
*/
|
|
45
45
|
getRuleset(this: That, params: T.QueryRulesGetRulesetRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.QueryRulesGetRulesetResponse>;
|
|
46
46
|
getRuleset(this: That, params: T.QueryRulesGetRulesetRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.QueryRulesGetRulesetResponse, unknown>>;
|
|
47
47
|
getRuleset(this: That, params: T.QueryRulesGetRulesetRequest, options?: TransportRequestOptions): Promise<T.QueryRulesGetRulesetResponse>;
|
|
48
48
|
/**
|
|
49
49
|
* Get all query rulesets. Get summarized information about the query rulesets.
|
|
50
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-query-rules-list-rulesets | Elasticsearch API documentation}
|
|
50
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-query-rules-list-rulesets | Elasticsearch API documentation}
|
|
51
51
|
*/
|
|
52
52
|
listRulesets(this: That, params?: T.QueryRulesListRulesetsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.QueryRulesListRulesetsResponse>;
|
|
53
53
|
listRulesets(this: That, params?: T.QueryRulesListRulesetsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.QueryRulesListRulesetsResponse, unknown>>;
|
|
54
54
|
listRulesets(this: That, params?: T.QueryRulesListRulesetsRequest, options?: TransportRequestOptions): Promise<T.QueryRulesListRulesetsResponse>;
|
|
55
55
|
/**
|
|
56
56
|
* Create or update a query rule. Create or update a query rule within a query ruleset. IMPORTANT: Due to limitations within pinned queries, you can only pin documents using ids or docs, but cannot use both in single rule. It is advised to use one or the other in query rulesets, to avoid errors. Additionally, pinned queries have a maximum limit of 100 pinned hits. If multiple matching rules pin more than 100 documents, only the first 100 documents are pinned in the order they are specified in the ruleset.
|
|
57
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-query-rules-put-rule | Elasticsearch API documentation}
|
|
57
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-query-rules-put-rule | Elasticsearch API documentation}
|
|
58
58
|
*/
|
|
59
59
|
putRule(this: That, params: T.QueryRulesPutRuleRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.QueryRulesPutRuleResponse>;
|
|
60
60
|
putRule(this: That, params: T.QueryRulesPutRuleRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.QueryRulesPutRuleResponse, unknown>>;
|
|
61
61
|
putRule(this: That, params: T.QueryRulesPutRuleRequest, options?: TransportRequestOptions): Promise<T.QueryRulesPutRuleResponse>;
|
|
62
62
|
/**
|
|
63
63
|
* Create or update a query ruleset. There is a limit of 100 rules per ruleset. This limit can be increased by using the `xpack.applications.rules.max_rules_per_ruleset` cluster setting. IMPORTANT: Due to limitations within pinned queries, you can only select documents using `ids` or `docs`, but cannot use both in single rule. It is advised to use one or the other in query rulesets, to avoid errors. Additionally, pinned queries have a maximum limit of 100 pinned hits. If multiple matching rules pin more than 100 documents, only the first 100 documents are pinned in the order they are specified in the ruleset.
|
|
64
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-query-rules-put-ruleset | Elasticsearch API documentation}
|
|
64
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-query-rules-put-ruleset | Elasticsearch API documentation}
|
|
65
65
|
*/
|
|
66
66
|
putRuleset(this: That, params: T.QueryRulesPutRulesetRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.QueryRulesPutRulesetResponse>;
|
|
67
67
|
putRuleset(this: That, params: T.QueryRulesPutRulesetRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.QueryRulesPutRulesetResponse, unknown>>;
|
|
68
68
|
putRuleset(this: That, params: T.QueryRulesPutRulesetRequest, options?: TransportRequestOptions): Promise<T.QueryRulesPutRulesetResponse>;
|
|
69
69
|
/**
|
|
70
70
|
* Test a query ruleset. Evaluate match criteria against a query ruleset to identify the rules that would match that criteria.
|
|
71
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-query-rules-test | Elasticsearch API documentation}
|
|
71
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-query-rules-test | Elasticsearch API documentation}
|
|
72
72
|
*/
|
|
73
73
|
test(this: That, params: T.QueryRulesTestRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.QueryRulesTestResponse>;
|
|
74
74
|
test(this: That, params: T.QueryRulesTestRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.QueryRulesTestResponse, unknown>>;
|
|
@@ -5,7 +5,7 @@ interface That {
|
|
|
5
5
|
}
|
|
6
6
|
/**
|
|
7
7
|
* Evaluate ranked search results. Evaluate the quality of ranked search results over a set of typical search queries.
|
|
8
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rank-eval | Elasticsearch API documentation}
|
|
8
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-rank-eval | Elasticsearch API documentation}
|
|
9
9
|
*/
|
|
10
10
|
export default function RankEvalApi(this: That, params: T.RankEvalRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.RankEvalResponse>;
|
|
11
11
|
export default function RankEvalApi(this: That, params: T.RankEvalRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.RankEvalResponse, unknown>>;
|
package/esm/api/api/reindex.d.ts
CHANGED
|
@@ -5,7 +5,7 @@ interface That {
|
|
|
5
5
|
}
|
|
6
6
|
/**
|
|
7
7
|
* Reindex documents. Copy documents from a source to a destination. You can copy all documents to the destination index or reindex a subset of the documents. The source can be any existing index, alias, or data stream. The destination must differ from the source. For example, you cannot reindex a data stream into itself. IMPORTANT: Reindex requires `_source` to be enabled for all documents in the source. The destination should be configured as wanted before calling the reindex API. Reindex does not copy the settings from the source or its associated template. Mappings, shard counts, and replicas, for example, must be configured ahead of time. If the Elasticsearch security features are enabled, you must have the following security privileges: * The `read` index privilege for the source data stream, index, or alias. * The `write` index privilege for the destination data stream, index, or index alias. * To automatically create a data stream or index with a reindex API request, you must have the `auto_configure`, `create_index`, or `manage` index privilege for the destination data stream, index, or alias. * If reindexing from a remote cluster, the `source.remote.user` must have the `monitor` cluster privilege and the `read` index privilege for the source data stream, index, or alias. If reindexing from a remote cluster into a cluster using Elastic Stack, you must explicitly allow the remote host using the `reindex.remote.whitelist` node setting on the destination cluster. If reindexing from a remote cluster into an Elastic Cloud Serverless project, only remote hosts from Elastic Cloud Hosted are allowed. Automatic data stream creation requires a matching index template with data stream enabled. The `dest` element can be configured like the index API to control optimistic concurrency control. Omitting `version_type` or setting it to `internal` causes Elasticsearch to blindly dump documents into the destination, overwriting any that happen to have the same ID. Setting `version_type` to `external` causes Elasticsearch to preserve the `version` from the source, create any documents that are missing, and update any documents that have an older version in the destination than they do in the source. Setting `op_type` to `create` causes the reindex API to create only missing documents in the destination. All existing documents will cause a version conflict. IMPORTANT: Because data streams are append-only, any reindex request to a destination data stream must have an `op_type` of `create`. A reindex can only add new documents to a destination data stream. It cannot update existing documents in a destination data stream. By default, version conflicts abort the reindex process. To continue reindexing if there are conflicts, set the `conflicts` request body property to `proceed`. In this case, the response includes a count of the version conflicts that were encountered. Note that the handling of other error types is unaffected by the `conflicts` property. Additionally, if you opt to count version conflicts, the operation could attempt to reindex more documents from the source than `max_docs` until it has successfully indexed `max_docs` documents into the target or it has gone through every document in the source query. It's recommended to reindex on indices with a green status. Reindexing can fail when a node shuts down or crashes. * When requested with `wait_for_completion=true` (default), the request fails if the node shuts down. * When requested with `wait_for_completion=false`, a task id is returned, for use with the task management APIs. The task may disappear or fail if the node shuts down. When retrying a failed reindex operation, it might be necessary to set `conflicts=proceed` or to first delete the partial destination index. Additionally, dry runs, checking disk space, and fetching index recovery information can help address the root cause. Refer to the linked documentation for examples of how to reindex documents.
|
|
8
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-reindex | Elasticsearch API documentation}
|
|
8
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-reindex | Elasticsearch API documentation}
|
|
9
9
|
*/
|
|
10
10
|
export default function ReindexApi(this: That, params: T.ReindexRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ReindexResponse>;
|
|
11
11
|
export default function ReindexApi(this: That, params: T.ReindexRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.ReindexResponse, unknown>>;
|
|
@@ -5,7 +5,7 @@ interface That {
|
|
|
5
5
|
}
|
|
6
6
|
/**
|
|
7
7
|
* Throttle a reindex operation. Change the number of requests per second for a particular reindex operation. For example: ``` POST _reindex/r1A2WoRbTwKZ516z6NEs5A:36619/_rethrottle?requests_per_second=-1 ``` Rethrottling that speeds up the query takes effect immediately. Rethrottling that slows down the query will take effect after completing the current batch. This behavior prevents scroll timeouts.
|
|
8
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-reindex | Elasticsearch API documentation}
|
|
8
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-reindex | Elasticsearch API documentation}
|
|
9
9
|
*/
|
|
10
10
|
export default function ReindexRethrottleApi(this: That, params: T.ReindexRethrottleRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ReindexRethrottleResponse>;
|
|
11
11
|
export default function ReindexRethrottleApi(this: That, params: T.ReindexRethrottleRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.ReindexRethrottleResponse, unknown>>;
|
|
@@ -5,7 +5,7 @@ interface That {
|
|
|
5
5
|
}
|
|
6
6
|
/**
|
|
7
7
|
* Render a search template. Render a search template as a search request body.
|
|
8
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-render-search-template | Elasticsearch API documentation}
|
|
8
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-render-search-template | Elasticsearch API documentation}
|
|
9
9
|
*/
|
|
10
10
|
export default function RenderSearchTemplateApi(this: That, params?: T.RenderSearchTemplateRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.RenderSearchTemplateResponse>;
|
|
11
11
|
export default function RenderSearchTemplateApi(this: That, params?: T.RenderSearchTemplateRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.RenderSearchTemplateResponse, unknown>>;
|
package/esm/api/api/rollup.d.ts
CHANGED
|
@@ -19,56 +19,56 @@ export default class Rollup {
|
|
|
19
19
|
constructor(transport: Transport);
|
|
20
20
|
/**
|
|
21
21
|
* Delete a rollup job. A job must be stopped before it can be deleted. If you attempt to delete a started job, an error occurs. Similarly, if you attempt to delete a nonexistent job, an exception occurs. IMPORTANT: When you delete a job, you remove only the process that is actively monitoring and rolling up data. The API does not delete any previously rolled up data. This is by design; a user may wish to roll up a static data set. Because the data set is static, after it has been fully rolled up there is no need to keep the indexing rollup job around (as there will be no new data). Thus the job can be deleted, leaving behind the rolled up data for analysis. If you wish to also remove the rollup data and the rollup index contains the data for only a single job, you can delete the whole rollup index. If the rollup index stores data from several jobs, you must issue a delete-by-query that targets the rollup job's identifier in the rollup index. For example: ``` POST my_rollup_index/_delete_by_query { "query": { "term": { "_rollup.id": "the_rollup_job_id" } } } ```
|
|
22
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rollup-delete-job | Elasticsearch API documentation}
|
|
22
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-rollup-delete-job | Elasticsearch API documentation}
|
|
23
23
|
*/
|
|
24
24
|
deleteJob(this: That, params: T.RollupDeleteJobRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.RollupDeleteJobResponse>;
|
|
25
25
|
deleteJob(this: That, params: T.RollupDeleteJobRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.RollupDeleteJobResponse, unknown>>;
|
|
26
26
|
deleteJob(this: That, params: T.RollupDeleteJobRequest, options?: TransportRequestOptions): Promise<T.RollupDeleteJobResponse>;
|
|
27
27
|
/**
|
|
28
28
|
* Get rollup job information. Get the configuration, stats, and status of rollup jobs. NOTE: This API returns only active (both `STARTED` and `STOPPED`) jobs. If a job was created, ran for a while, then was deleted, the API does not return any details about it. For details about a historical rollup job, the rollup capabilities API may be more useful.
|
|
29
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rollup-get-jobs | Elasticsearch API documentation}
|
|
29
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-rollup-get-jobs | Elasticsearch API documentation}
|
|
30
30
|
*/
|
|
31
31
|
getJobs(this: That, params?: T.RollupGetJobsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.RollupGetJobsResponse>;
|
|
32
32
|
getJobs(this: That, params?: T.RollupGetJobsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.RollupGetJobsResponse, unknown>>;
|
|
33
33
|
getJobs(this: That, params?: T.RollupGetJobsRequest, options?: TransportRequestOptions): Promise<T.RollupGetJobsResponse>;
|
|
34
34
|
/**
|
|
35
35
|
* Get the rollup job capabilities. Get the capabilities of any rollup jobs that have been configured for a specific index or index pattern. This API is useful because a rollup job is often configured to rollup only a subset of fields from the source index. Furthermore, only certain aggregations can be configured for various fields, leading to a limited subset of functionality depending on that configuration. This API enables you to inspect an index and determine: 1. Does this index have associated rollup data somewhere in the cluster? 2. If yes to the first question, what fields were rolled up, what aggregations can be performed, and where does the data live?
|
|
36
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rollup-get-rollup-caps | Elasticsearch API documentation}
|
|
36
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-rollup-get-rollup-caps | Elasticsearch API documentation}
|
|
37
37
|
*/
|
|
38
38
|
getRollupCaps(this: That, params?: T.RollupGetRollupCapsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.RollupGetRollupCapsResponse>;
|
|
39
39
|
getRollupCaps(this: That, params?: T.RollupGetRollupCapsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.RollupGetRollupCapsResponse, unknown>>;
|
|
40
40
|
getRollupCaps(this: That, params?: T.RollupGetRollupCapsRequest, options?: TransportRequestOptions): Promise<T.RollupGetRollupCapsResponse>;
|
|
41
41
|
/**
|
|
42
42
|
* Get the rollup index capabilities. Get the rollup capabilities of all jobs inside of a rollup index. A single rollup index may store the data for multiple rollup jobs and may have a variety of capabilities depending on those jobs. This API enables you to determine: * What jobs are stored in an index (or indices specified via a pattern)? * What target indices were rolled up, what fields were used in those rollups, and what aggregations can be performed on each job?
|
|
43
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rollup-get-rollup-index-caps | Elasticsearch API documentation}
|
|
43
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-rollup-get-rollup-index-caps | Elasticsearch API documentation}
|
|
44
44
|
*/
|
|
45
45
|
getRollupIndexCaps(this: That, params: T.RollupGetRollupIndexCapsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.RollupGetRollupIndexCapsResponse>;
|
|
46
46
|
getRollupIndexCaps(this: That, params: T.RollupGetRollupIndexCapsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.RollupGetRollupIndexCapsResponse, unknown>>;
|
|
47
47
|
getRollupIndexCaps(this: That, params: T.RollupGetRollupIndexCapsRequest, options?: TransportRequestOptions): Promise<T.RollupGetRollupIndexCapsResponse>;
|
|
48
48
|
/**
|
|
49
49
|
* Create a rollup job. WARNING: From 8.15.0, calling this API in a cluster with no rollup usage will fail with a message about the deprecation and planned removal of rollup features. A cluster needs to contain either a rollup job or a rollup index in order for this API to be allowed to run. The rollup job configuration contains all the details about how the job should run, when it indexes documents, and what future queries will be able to run against the rollup index. There are three main sections to the job configuration: the logistical details about the job (for example, the cron schedule), the fields that are used for grouping, and what metrics to collect for each group. Jobs are created in a `STOPPED` state. You can start them with the start rollup jobs API.
|
|
50
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rollup-put-job | Elasticsearch API documentation}
|
|
50
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-rollup-put-job | Elasticsearch API documentation}
|
|
51
51
|
*/
|
|
52
52
|
putJob(this: That, params: T.RollupPutJobRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.RollupPutJobResponse>;
|
|
53
53
|
putJob(this: That, params: T.RollupPutJobRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.RollupPutJobResponse, unknown>>;
|
|
54
54
|
putJob(this: That, params: T.RollupPutJobRequest, options?: TransportRequestOptions): Promise<T.RollupPutJobResponse>;
|
|
55
55
|
/**
|
|
56
56
|
* Search rolled-up data. The rollup search endpoint is needed because, internally, rolled-up documents utilize a different document structure than the original data. It rewrites standard Query DSL into a format that matches the rollup documents then takes the response and rewrites it back to what a client would expect given the original query. The request body supports a subset of features from the regular search API. The following functionality is not available: `size`: Because rollups work on pre-aggregated data, no search hits can be returned and so size must be set to zero or omitted entirely. `highlighter`, `suggestors`, `post_filter`, `profile`, `explain`: These are similarly disallowed. For more detailed examples of using the rollup search API, including querying rolled-up data only or combining rolled-up and live data, refer to the External documentation.
|
|
57
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rollup-rollup-search | Elasticsearch API documentation}
|
|
57
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-rollup-rollup-search | Elasticsearch API documentation}
|
|
58
58
|
*/
|
|
59
59
|
rollupSearch<TDocument = unknown, TAggregations = Record<T.AggregateName, T.AggregationsAggregate>>(this: That, params: T.RollupRollupSearchRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.RollupRollupSearchResponse<TDocument, TAggregations>>;
|
|
60
60
|
rollupSearch<TDocument = unknown, TAggregations = Record<T.AggregateName, T.AggregationsAggregate>>(this: That, params: T.RollupRollupSearchRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.RollupRollupSearchResponse<TDocument, TAggregations>, unknown>>;
|
|
61
61
|
rollupSearch<TDocument = unknown, TAggregations = Record<T.AggregateName, T.AggregationsAggregate>>(this: That, params: T.RollupRollupSearchRequest, options?: TransportRequestOptions): Promise<T.RollupRollupSearchResponse<TDocument, TAggregations>>;
|
|
62
62
|
/**
|
|
63
63
|
* Start rollup jobs. If you try to start a job that does not exist, an exception occurs. If you try to start a job that is already started, nothing happens.
|
|
64
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rollup-start-job | Elasticsearch API documentation}
|
|
64
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-rollup-start-job | Elasticsearch API documentation}
|
|
65
65
|
*/
|
|
66
66
|
startJob(this: That, params: T.RollupStartJobRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.RollupStartJobResponse>;
|
|
67
67
|
startJob(this: That, params: T.RollupStartJobRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.RollupStartJobResponse, unknown>>;
|
|
68
68
|
startJob(this: That, params: T.RollupStartJobRequest, options?: TransportRequestOptions): Promise<T.RollupStartJobResponse>;
|
|
69
69
|
/**
|
|
70
70
|
* Stop rollup jobs. If you try to stop a job that does not exist, an exception occurs. If you try to stop a job that is already stopped, nothing happens. Since only a stopped job can be deleted, it can be useful to block the API until the indexer has fully stopped. This is accomplished with the `wait_for_completion` query parameter, and optionally a timeout. For example: ``` POST _rollup/job/sensor/_stop?wait_for_completion=true&timeout=10s ``` The parameter blocks the API call from returning until either the job has moved to STOPPED or the specified time has elapsed. If the specified time elapses without the job moving to STOPPED, a timeout exception occurs.
|
|
71
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rollup-stop-job | Elasticsearch API documentation}
|
|
71
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-rollup-stop-job | Elasticsearch API documentation}
|
|
72
72
|
*/
|
|
73
73
|
stopJob(this: That, params: T.RollupStopJobRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.RollupStopJobResponse>;
|
|
74
74
|
stopJob(this: That, params: T.RollupStopJobRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.RollupStopJobResponse, unknown>>;
|
package/esm/api/api/scroll.d.ts
CHANGED
|
@@ -5,7 +5,7 @@ interface That {
|
|
|
5
5
|
}
|
|
6
6
|
/**
|
|
7
7
|
* Run a scrolling search. IMPORTANT: The scroll API is no longer recommend for deep pagination. If you need to preserve the index state while paging through more than 10,000 hits, use the `search_after` parameter with a point in time (PIT). The scroll API gets large sets of results from a single scrolling search request. To get the necessary scroll ID, submit a search API request that includes an argument for the `scroll` query parameter. The `scroll` parameter indicates how long Elasticsearch should retain the search context for the request. The search response returns a scroll ID in the `_scroll_id` response body parameter. You can then use the scroll ID with the scroll API to retrieve the next batch of results for the request. If the Elasticsearch security features are enabled, the access to the results of a specific scroll ID is restricted to the user or API key that submitted the search. You can also use the scroll API to specify a new scroll parameter that extends or shortens the retention period for the search context. IMPORTANT: Results from a scrolling search reflect the state of the index at the time of the initial search request. Subsequent indexing or document changes only affect later search and scroll requests.
|
|
8
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-scroll | Elasticsearch API documentation}
|
|
8
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-scroll | Elasticsearch API documentation}
|
|
9
9
|
*/
|
|
10
10
|
export default function ScrollApi<TDocument = unknown, TAggregations = Record<T.AggregateName, T.AggregationsAggregate>>(this: That, params: T.ScrollRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ScrollResponse<TDocument, TAggregations>>;
|
|
11
11
|
export default function ScrollApi<TDocument = unknown, TAggregations = Record<T.AggregateName, T.AggregationsAggregate>>(this: That, params: T.ScrollRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.ScrollResponse<TDocument, TAggregations>, unknown>>;
|
package/esm/api/api/search.d.ts
CHANGED
|
@@ -5,7 +5,7 @@ interface That {
|
|
|
5
5
|
}
|
|
6
6
|
/**
|
|
7
7
|
* Run a search. Get search hits that match the query defined in the request. You can provide search queries using the `q` query string parameter or the request body. If both are specified, only the query parameter is used. If the Elasticsearch security features are enabled, you must have the read index privilege for the target data stream, index, or alias. For cross-cluster search, refer to the documentation about configuring CCS privileges. To search a point in time (PIT) for an alias, you must have the `read` index privilege for the alias's data streams or indices. **Search slicing** When paging through a large number of documents, it can be helpful to split the search into multiple slices to consume them independently with the `slice` and `pit` properties. By default the splitting is done first on the shards, then locally on each shard. The local splitting partitions the shard into contiguous ranges based on Lucene document IDs. For instance if the number of shards is equal to 2 and you request 4 slices, the slices 0 and 2 are assigned to the first shard and the slices 1 and 3 are assigned to the second shard. IMPORTANT: The same point-in-time ID should be used for all slices. If different PIT IDs are used, slices can overlap and miss documents. This situation can occur because the splitting criterion is based on Lucene document IDs, which are not stable across changes to the index.
|
|
8
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search | Elasticsearch API documentation}
|
|
8
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-search | Elasticsearch API documentation}
|
|
9
9
|
*/
|
|
10
10
|
export default function SearchApi<TDocument = unknown, TAggregations = Record<T.AggregateName, T.AggregationsAggregate>>(this: That, params?: T.SearchRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SearchResponse<TDocument, TAggregations>>;
|
|
11
11
|
export default function SearchApi<TDocument = unknown, TAggregations = Record<T.AggregateName, T.AggregationsAggregate>>(this: That, params?: T.SearchRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SearchResponse<TDocument, TAggregations>, unknown>>;
|
|
@@ -19,70 +19,70 @@ export default class SearchApplication {
|
|
|
19
19
|
constructor(transport: Transport);
|
|
20
20
|
/**
|
|
21
21
|
* Delete a search application. Remove a search application and its associated alias. Indices attached to the search application are not removed.
|
|
22
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-delete | Elasticsearch API documentation}
|
|
22
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-search-application-delete | Elasticsearch API documentation}
|
|
23
23
|
*/
|
|
24
24
|
delete(this: That, params: T.SearchApplicationDeleteRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SearchApplicationDeleteResponse>;
|
|
25
25
|
delete(this: That, params: T.SearchApplicationDeleteRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SearchApplicationDeleteResponse, unknown>>;
|
|
26
26
|
delete(this: That, params: T.SearchApplicationDeleteRequest, options?: TransportRequestOptions): Promise<T.SearchApplicationDeleteResponse>;
|
|
27
27
|
/**
|
|
28
28
|
* Delete a behavioral analytics collection. The associated data stream is also deleted.
|
|
29
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-delete-behavioral-analytics | Elasticsearch API documentation}
|
|
29
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-search-application-delete-behavioral-analytics | Elasticsearch API documentation}
|
|
30
30
|
*/
|
|
31
31
|
deleteBehavioralAnalytics(this: That, params: T.SearchApplicationDeleteBehavioralAnalyticsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SearchApplicationDeleteBehavioralAnalyticsResponse>;
|
|
32
32
|
deleteBehavioralAnalytics(this: That, params: T.SearchApplicationDeleteBehavioralAnalyticsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SearchApplicationDeleteBehavioralAnalyticsResponse, unknown>>;
|
|
33
33
|
deleteBehavioralAnalytics(this: That, params: T.SearchApplicationDeleteBehavioralAnalyticsRequest, options?: TransportRequestOptions): Promise<T.SearchApplicationDeleteBehavioralAnalyticsResponse>;
|
|
34
34
|
/**
|
|
35
35
|
* Get search application details.
|
|
36
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-get | Elasticsearch API documentation}
|
|
36
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-search-application-get | Elasticsearch API documentation}
|
|
37
37
|
*/
|
|
38
38
|
get(this: That, params: T.SearchApplicationGetRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SearchApplicationGetResponse>;
|
|
39
39
|
get(this: That, params: T.SearchApplicationGetRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SearchApplicationGetResponse, unknown>>;
|
|
40
40
|
get(this: That, params: T.SearchApplicationGetRequest, options?: TransportRequestOptions): Promise<T.SearchApplicationGetResponse>;
|
|
41
41
|
/**
|
|
42
42
|
* Get behavioral analytics collections.
|
|
43
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-get-behavioral-analytics | Elasticsearch API documentation}
|
|
43
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-search-application-get-behavioral-analytics | Elasticsearch API documentation}
|
|
44
44
|
*/
|
|
45
45
|
getBehavioralAnalytics(this: That, params?: T.SearchApplicationGetBehavioralAnalyticsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SearchApplicationGetBehavioralAnalyticsResponse>;
|
|
46
46
|
getBehavioralAnalytics(this: That, params?: T.SearchApplicationGetBehavioralAnalyticsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SearchApplicationGetBehavioralAnalyticsResponse, unknown>>;
|
|
47
47
|
getBehavioralAnalytics(this: That, params?: T.SearchApplicationGetBehavioralAnalyticsRequest, options?: TransportRequestOptions): Promise<T.SearchApplicationGetBehavioralAnalyticsResponse>;
|
|
48
48
|
/**
|
|
49
49
|
* Get search applications. Get information about search applications.
|
|
50
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-get-behavioral-analytics | Elasticsearch API documentation}
|
|
50
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-search-application-get-behavioral-analytics | Elasticsearch API documentation}
|
|
51
51
|
*/
|
|
52
52
|
list(this: That, params?: T.SearchApplicationListRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SearchApplicationListResponse>;
|
|
53
53
|
list(this: That, params?: T.SearchApplicationListRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SearchApplicationListResponse, unknown>>;
|
|
54
54
|
list(this: That, params?: T.SearchApplicationListRequest, options?: TransportRequestOptions): Promise<T.SearchApplicationListResponse>;
|
|
55
55
|
/**
|
|
56
56
|
* Create a behavioral analytics collection event.
|
|
57
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-post-behavioral-analytics-event | Elasticsearch API documentation}
|
|
57
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-search-application-post-behavioral-analytics-event | Elasticsearch API documentation}
|
|
58
58
|
*/
|
|
59
59
|
postBehavioralAnalyticsEvent(this: That, params: T.SearchApplicationPostBehavioralAnalyticsEventRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SearchApplicationPostBehavioralAnalyticsEventResponse>;
|
|
60
60
|
postBehavioralAnalyticsEvent(this: That, params: T.SearchApplicationPostBehavioralAnalyticsEventRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SearchApplicationPostBehavioralAnalyticsEventResponse, unknown>>;
|
|
61
61
|
postBehavioralAnalyticsEvent(this: That, params: T.SearchApplicationPostBehavioralAnalyticsEventRequest, options?: TransportRequestOptions): Promise<T.SearchApplicationPostBehavioralAnalyticsEventResponse>;
|
|
62
62
|
/**
|
|
63
63
|
* Create or update a search application.
|
|
64
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-put | Elasticsearch API documentation}
|
|
64
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-search-application-put | Elasticsearch API documentation}
|
|
65
65
|
*/
|
|
66
66
|
put(this: That, params: T.SearchApplicationPutRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SearchApplicationPutResponse>;
|
|
67
67
|
put(this: That, params: T.SearchApplicationPutRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SearchApplicationPutResponse, unknown>>;
|
|
68
68
|
put(this: That, params: T.SearchApplicationPutRequest, options?: TransportRequestOptions): Promise<T.SearchApplicationPutResponse>;
|
|
69
69
|
/**
|
|
70
70
|
* Create a behavioral analytics collection.
|
|
71
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-put-behavioral-analytics | Elasticsearch API documentation}
|
|
71
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-search-application-put-behavioral-analytics | Elasticsearch API documentation}
|
|
72
72
|
*/
|
|
73
73
|
putBehavioralAnalytics(this: That, params: T.SearchApplicationPutBehavioralAnalyticsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SearchApplicationPutBehavioralAnalyticsResponse>;
|
|
74
74
|
putBehavioralAnalytics(this: That, params: T.SearchApplicationPutBehavioralAnalyticsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SearchApplicationPutBehavioralAnalyticsResponse, unknown>>;
|
|
75
75
|
putBehavioralAnalytics(this: That, params: T.SearchApplicationPutBehavioralAnalyticsRequest, options?: TransportRequestOptions): Promise<T.SearchApplicationPutBehavioralAnalyticsResponse>;
|
|
76
76
|
/**
|
|
77
77
|
* Render a search application query. Generate an Elasticsearch query using the specified query parameters and the search template associated with the search application or a default template if none is specified. If a parameter used in the search template is not specified in `params`, the parameter's default value will be used. The API returns the specific Elasticsearch query that would be generated and run by calling the search application search API. You must have `read` privileges on the backing alias of the search application.
|
|
78
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-render-query | Elasticsearch API documentation}
|
|
78
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-search-application-render-query | Elasticsearch API documentation}
|
|
79
79
|
*/
|
|
80
80
|
renderQuery(this: That, params: T.SearchApplicationRenderQueryRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SearchApplicationRenderQueryResponse>;
|
|
81
81
|
renderQuery(this: That, params: T.SearchApplicationRenderQueryRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SearchApplicationRenderQueryResponse, unknown>>;
|
|
82
82
|
renderQuery(this: That, params: T.SearchApplicationRenderQueryRequest, options?: TransportRequestOptions): Promise<T.SearchApplicationRenderQueryResponse>;
|
|
83
83
|
/**
|
|
84
84
|
* Run a search application search. Generate and run an Elasticsearch query that uses the specified query parameteter and the search template associated with the search application or default template. Unspecified template parameters are assigned their default values if applicable.
|
|
85
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-search | Elasticsearch API documentation}
|
|
85
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-search-application-search | Elasticsearch API documentation}
|
|
86
86
|
*/
|
|
87
87
|
search<TDocument = unknown, TAggregations = Record<T.AggregateName, T.AggregationsAggregate>>(this: That, params: T.SearchApplicationSearchRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SearchApplicationSearchResponse<TDocument, TAggregations>>;
|
|
88
88
|
search<TDocument = unknown, TAggregations = Record<T.AggregateName, T.AggregationsAggregate>>(this: That, params: T.SearchApplicationSearchRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SearchApplicationSearchResponse<TDocument, TAggregations>, unknown>>;
|
|
@@ -5,7 +5,7 @@ interface That {
|
|
|
5
5
|
}
|
|
6
6
|
/**
|
|
7
7
|
* Search a vector tile. Search a vector tile for geospatial values. Before using this API, you should be familiar with the Mapbox vector tile specification. The API returns results as a binary mapbox vector tile. Internally, Elasticsearch translates a vector tile search API request into a search containing: * A `geo_bounding_box` query on the `<field>`. The query uses the `<zoom>/<x>/<y>` tile as a bounding box. * A `geotile_grid` or `geohex_grid` aggregation on the `<field>`. The `grid_agg` parameter determines the aggregation type. The aggregation uses the `<zoom>/<x>/<y>` tile as a bounding box. * Optionally, a `geo_bounds` aggregation on the `<field>`. The search only includes this aggregation if the `exact_bounds` parameter is `true`. * If the optional parameter `with_labels` is `true`, the internal search will include a dynamic runtime field that calls the `getLabelPosition` function of the geometry doc value. This enables the generation of new point features containing suggested geometry labels, so that, for example, multi-polygons will have only one label. The API returns results as a binary Mapbox vector tile. Mapbox vector tiles are encoded as Google Protobufs (PBF). By default, the tile contains three layers: * A `hits` layer containing a feature for each `<field>` value matching the `geo_bounding_box` query. * An `aggs` layer containing a feature for each cell of the `geotile_grid` or `geohex_grid`. The layer only contains features for cells with matching data. * A meta layer containing: * A feature containing a bounding box. By default, this is the bounding box of the tile. * Value ranges for any sub-aggregations on the `geotile_grid` or `geohex_grid`. * Metadata for the search. The API only returns features that can display at its zoom level. For example, if a polygon feature has no area at its zoom level, the API omits it. The API returns errors as UTF-8 encoded JSON. IMPORTANT: You can specify several options for this API as either a query parameter or request body parameter. If you specify both parameters, the query parameter takes precedence. **Grid precision for geotile** For a `grid_agg` of `geotile`, you can use cells in the `aggs` layer as tiles for lower zoom levels. `grid_precision` represents the additional zoom levels available through these cells. The final precision is computed by as follows: `<zoom> + grid_precision`. For example, if `<zoom>` is 7 and `grid_precision` is 8, then the `geotile_grid` aggregation will use a precision of 15. The maximum final precision is 29. The `grid_precision` also determines the number of cells for the grid as follows: `(2^grid_precision) x (2^grid_precision)`. For example, a value of 8 divides the tile into a grid of 256 x 256 cells. The `aggs` layer only contains features for cells with matching data. **Grid precision for geohex** For a `grid_agg` of `geohex`, Elasticsearch uses `<zoom>` and `grid_precision` to calculate a final precision as follows: `<zoom> + grid_precision`. This precision determines the H3 resolution of the hexagonal cells produced by the `geohex` aggregation. The following table maps the H3 resolution for each precision. For example, if `<zoom>` is 3 and `grid_precision` is 3, the precision is 6. At a precision of 6, hexagonal cells have an H3 resolution of 2. If `<zoom>` is 3 and `grid_precision` is 4, the precision is 7. At a precision of 7, hexagonal cells have an H3 resolution of 3. | Precision | Unique tile bins | H3 resolution | Unique hex bins | Ratio | | --------- | ---------------- | ------------- | ----------------| ----- | | 1 | 4 | 0 | 122 | 30.5 | | 2 | 16 | 0 | 122 | 7.625 | | 3 | 64 | 1 | 842 | 13.15625 | | 4 | 256 | 1 | 842 | 3.2890625 | | 5 | 1024 | 2 | 5882 | 5.744140625 | | 6 | 4096 | 2 | 5882 | 1.436035156 | | 7 | 16384 | 3 | 41162 | 2.512329102 | | 8 | 65536 | 3 | 41162 | 0.6280822754 | | 9 | 262144 | 4 | 288122 | 1.099098206 | | 10 | 1048576 | 4 | 288122 | 0.2747745514 | | 11 | 4194304 | 5 | 2016842 | 0.4808526039 | | 12 | 16777216 | 6 | 14117882 | 0.8414913416 | | 13 | 67108864 | 6 | 14117882 | 0.2103728354 | | 14 | 268435456 | 7 | 98825162 | 0.3681524172 | | 15 | 1073741824 | 8 | 691776122 | 0.644266719 | | 16 | 4294967296 | 8 | 691776122 | 0.1610666797 | | 17 | 17179869184 | 9 | 4842432842 | 0.2818666889 | | 18 | 68719476736 | 10 | 33897029882 | 0.4932667053 | | 19 | 274877906944 | 11 | 237279209162 | 0.8632167343 | | 20 | 1099511627776 | 11 | 237279209162 | 0.2158041836 | | 21 | 4398046511104 | 12 | 1660954464122 | 0.3776573213 | | 22 | 17592186044416 | 13 | 11626681248842 | 0.6609003122 | | 23 | 70368744177664 | 13 | 11626681248842 | 0.165225078 | | 24 | 281474976710656 | 14 | 81386768741882 | 0.2891438866 | | 25 | 1125899906842620 | 15 | 569707381193162 | 0.5060018015 | | 26 | 4503599627370500 | 15 | 569707381193162 | 0.1265004504 | | 27 | 18014398509482000 | 15 | 569707381193162 | 0.03162511259 | | 28 | 72057594037927900 | 15 | 569707381193162 | 0.007906278149 | | 29 | 288230376151712000 | 15 | 569707381193162 | 0.001976569537 | Hexagonal cells don't align perfectly on a vector tile. Some cells may intersect more than one vector tile. To compute the H3 resolution for each precision, Elasticsearch compares the average density of hexagonal bins at each resolution with the average density of tile bins at each zoom level. Elasticsearch uses the H3 resolution that is closest to the corresponding geotile density. Learn how to use the vector tile search API with practical examples in the [Vector tile search examples](https://www.elastic.co/docs/reference/elasticsearch/rest-apis/vector-tile-search) guide.
|
|
8
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-mvt | Elasticsearch API documentation}
|
|
8
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-search-mvt | Elasticsearch API documentation}
|
|
9
9
|
*/
|
|
10
10
|
export default function SearchMvtApi(this: That, params: T.SearchMvtRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SearchMvtResponse>;
|
|
11
11
|
export default function SearchMvtApi(this: That, params: T.SearchMvtRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SearchMvtResponse, unknown>>;
|
|
@@ -5,7 +5,7 @@ interface That {
|
|
|
5
5
|
}
|
|
6
6
|
/**
|
|
7
7
|
* Get the search shards. Get the indices and shards that a search request would be run against. This information can be useful for working out issues or planning optimizations with routing and shard preferences. When filtered aliases are used, the filter is returned as part of the `indices` section. If the Elasticsearch security features are enabled, you must have the `view_index_metadata` or `manage` index privilege for the target data stream, index, or alias.
|
|
8
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-shards | Elasticsearch API documentation}
|
|
8
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-search-shards | Elasticsearch API documentation}
|
|
9
9
|
*/
|
|
10
10
|
export default function SearchShardsApi(this: That, params?: T.SearchShardsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SearchShardsResponse>;
|
|
11
11
|
export default function SearchShardsApi(this: That, params?: T.SearchShardsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SearchShardsResponse, unknown>>;
|
|
@@ -5,7 +5,7 @@ interface That {
|
|
|
5
5
|
}
|
|
6
6
|
/**
|
|
7
7
|
* Run a search with a search template.
|
|
8
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-template | Elasticsearch API documentation}
|
|
8
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-search-template | Elasticsearch API documentation}
|
|
9
9
|
*/
|
|
10
10
|
export default function SearchTemplateApi<TDocument = unknown>(this: That, params?: T.SearchTemplateRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SearchTemplateResponse<TDocument>>;
|
|
11
11
|
export default function SearchTemplateApi<TDocument = unknown>(this: That, params?: T.SearchTemplateRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SearchTemplateResponse<TDocument>, unknown>>;
|
|
@@ -19,28 +19,28 @@ export default class SearchableSnapshots {
|
|
|
19
19
|
constructor(transport: Transport);
|
|
20
20
|
/**
|
|
21
21
|
* Get cache statistics. Get statistics about the shared cache for partially mounted indices.
|
|
22
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-searchable-snapshots-cache-stats | Elasticsearch API documentation}
|
|
22
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-searchable-snapshots-cache-stats | Elasticsearch API documentation}
|
|
23
23
|
*/
|
|
24
24
|
cacheStats(this: That, params?: T.SearchableSnapshotsCacheStatsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SearchableSnapshotsCacheStatsResponse>;
|
|
25
25
|
cacheStats(this: That, params?: T.SearchableSnapshotsCacheStatsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SearchableSnapshotsCacheStatsResponse, unknown>>;
|
|
26
26
|
cacheStats(this: That, params?: T.SearchableSnapshotsCacheStatsRequest, options?: TransportRequestOptions): Promise<T.SearchableSnapshotsCacheStatsResponse>;
|
|
27
27
|
/**
|
|
28
28
|
* Clear the cache. Clear indices and data streams from the shared cache for partially mounted indices.
|
|
29
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-searchable-snapshots-clear-cache | Elasticsearch API documentation}
|
|
29
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-searchable-snapshots-clear-cache | Elasticsearch API documentation}
|
|
30
30
|
*/
|
|
31
31
|
clearCache(this: That, params?: T.SearchableSnapshotsClearCacheRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SearchableSnapshotsClearCacheResponse>;
|
|
32
32
|
clearCache(this: That, params?: T.SearchableSnapshotsClearCacheRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SearchableSnapshotsClearCacheResponse, unknown>>;
|
|
33
33
|
clearCache(this: That, params?: T.SearchableSnapshotsClearCacheRequest, options?: TransportRequestOptions): Promise<T.SearchableSnapshotsClearCacheResponse>;
|
|
34
34
|
/**
|
|
35
35
|
* Mount a snapshot. Mount a snapshot as a searchable snapshot index. Do not use this API for snapshots managed by index lifecycle management (ILM). Manually mounting ILM-managed snapshots can interfere with ILM processes.
|
|
36
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-searchable-snapshots-mount | Elasticsearch API documentation}
|
|
36
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-searchable-snapshots-mount | Elasticsearch API documentation}
|
|
37
37
|
*/
|
|
38
38
|
mount(this: That, params: T.SearchableSnapshotsMountRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SearchableSnapshotsMountResponse>;
|
|
39
39
|
mount(this: That, params: T.SearchableSnapshotsMountRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SearchableSnapshotsMountResponse, unknown>>;
|
|
40
40
|
mount(this: That, params: T.SearchableSnapshotsMountRequest, options?: TransportRequestOptions): Promise<T.SearchableSnapshotsMountResponse>;
|
|
41
41
|
/**
|
|
42
42
|
* Get searchable snapshot statistics.
|
|
43
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-searchable-snapshots-stats | Elasticsearch API documentation}
|
|
43
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-searchable-snapshots-stats | Elasticsearch API documentation}
|
|
44
44
|
*/
|
|
45
45
|
stats(this: That, params?: T.SearchableSnapshotsStatsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SearchableSnapshotsStatsResponse>;
|
|
46
46
|
stats(this: That, params?: T.SearchableSnapshotsStatsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SearchableSnapshotsStatsResponse, unknown>>;
|