@elastic/elasticsearch 9.3.0 → 9.3.2
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/esql.d.ts.map +1 -1
- package/esm/api/api/esql.js +6 -2
- package/esm/api/api/esql.js.map +1 -1
- 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/inference.d.ts.map +1 -1
- package/esm/api/api/inference.js +4 -0
- package/esm/api/api/inference.js.map +1 -1
- 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 +59 -23
- 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/esql.js +6 -2
- package/lib/api/api/esql.js.map +1 -1
- 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/inference.js +4 -0
- package/lib/api/api/inference.js.map +1 -1
- 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 +59 -23
- 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,91 +19,91 @@ export default class Transform {
|
|
|
19
19
|
constructor(transport: Transport);
|
|
20
20
|
/**
|
|
21
21
|
* Delete a transform.
|
|
22
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-delete-transform | Elasticsearch API documentation}
|
|
22
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-transform-delete-transform | Elasticsearch API documentation}
|
|
23
23
|
*/
|
|
24
24
|
deleteTransform(this: That, params: T.TransformDeleteTransformRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.TransformDeleteTransformResponse>;
|
|
25
25
|
deleteTransform(this: That, params: T.TransformDeleteTransformRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TransformDeleteTransformResponse, unknown>>;
|
|
26
26
|
deleteTransform(this: That, params: T.TransformDeleteTransformRequest, options?: TransportRequestOptions): Promise<T.TransformDeleteTransformResponse>;
|
|
27
27
|
/**
|
|
28
28
|
* Get node stats. Get per-node information about transform usage.
|
|
29
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-get-node-stats | Elasticsearch API documentation}
|
|
29
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-transform-get-node-stats | Elasticsearch API documentation}
|
|
30
30
|
*/
|
|
31
31
|
getNodeStats(this: That, params?: T.TransformGetNodeStatsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.TransformGetNodeStatsResponse>;
|
|
32
32
|
getNodeStats(this: That, params?: T.TransformGetNodeStatsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TransformGetNodeStatsResponse, unknown>>;
|
|
33
33
|
getNodeStats(this: That, params?: T.TransformGetNodeStatsRequest, options?: TransportRequestOptions): Promise<T.TransformGetNodeStatsResponse>;
|
|
34
34
|
/**
|
|
35
35
|
* Get transforms. Get configuration information for transforms.
|
|
36
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-get-transform | Elasticsearch API documentation}
|
|
36
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-transform-get-transform | Elasticsearch API documentation}
|
|
37
37
|
*/
|
|
38
38
|
getTransform(this: That, params?: T.TransformGetTransformRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.TransformGetTransformResponse>;
|
|
39
39
|
getTransform(this: That, params?: T.TransformGetTransformRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TransformGetTransformResponse, unknown>>;
|
|
40
40
|
getTransform(this: That, params?: T.TransformGetTransformRequest, options?: TransportRequestOptions): Promise<T.TransformGetTransformResponse>;
|
|
41
41
|
/**
|
|
42
42
|
* Get transform stats. Get usage information for transforms.
|
|
43
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-get-transform-stats | Elasticsearch API documentation}
|
|
43
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-transform-get-transform-stats | Elasticsearch API documentation}
|
|
44
44
|
*/
|
|
45
45
|
getTransformStats(this: That, params: T.TransformGetTransformStatsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.TransformGetTransformStatsResponse>;
|
|
46
46
|
getTransformStats(this: That, params: T.TransformGetTransformStatsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TransformGetTransformStatsResponse, unknown>>;
|
|
47
47
|
getTransformStats(this: That, params: T.TransformGetTransformStatsRequest, options?: TransportRequestOptions): Promise<T.TransformGetTransformStatsResponse>;
|
|
48
48
|
/**
|
|
49
49
|
* Preview a transform. Generates a preview of the results that you will get when you create a transform with the same configuration. It returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also generates a list of mappings and settings for the destination index. These values are determined based on the field types of the source index and the transform aggregations.
|
|
50
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-preview-transform | Elasticsearch API documentation}
|
|
50
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-transform-preview-transform | Elasticsearch API documentation}
|
|
51
51
|
*/
|
|
52
52
|
previewTransform<TTransform = unknown>(this: That, params?: T.TransformPreviewTransformRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.TransformPreviewTransformResponse<TTransform>>;
|
|
53
53
|
previewTransform<TTransform = unknown>(this: That, params?: T.TransformPreviewTransformRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TransformPreviewTransformResponse<TTransform>, unknown>>;
|
|
54
54
|
previewTransform<TTransform = unknown>(this: That, params?: T.TransformPreviewTransformRequest, options?: TransportRequestOptions): Promise<T.TransformPreviewTransformResponse<TTransform>>;
|
|
55
55
|
/**
|
|
56
56
|
* Create a transform. Creates a transform. A transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as a data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a unique row per entity. You must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If you choose to use the pivot method for your transform, the entities are defined by the set of `group_by` fields in the pivot object. If you choose to use the latest method, the entities are defined by the `unique_key` field values in the latest object. You must have `create_index`, `index`, and `read` privileges on the destination index and `read` and `view_index_metadata` privileges on the source indices. When Elasticsearch security features are enabled, the transform remembers which roles the user that created it had at the time of creation and uses those same roles. If those roles do not have the required privileges on the source and destination indices, the transform fails when it attempts unauthorized operations. NOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any `.transform-internal*` indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do not give users any privileges on `.transform-internal*` indices. If you used transforms prior to 7.5, also do not give users any privileges on `.data-frame-internal*` indices.
|
|
57
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-put-transform | Elasticsearch API documentation}
|
|
57
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-transform-put-transform | Elasticsearch API documentation}
|
|
58
58
|
*/
|
|
59
59
|
putTransform(this: That, params: T.TransformPutTransformRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.TransformPutTransformResponse>;
|
|
60
60
|
putTransform(this: That, params: T.TransformPutTransformRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TransformPutTransformResponse, unknown>>;
|
|
61
61
|
putTransform(this: That, params: T.TransformPutTransformRequest, options?: TransportRequestOptions): Promise<T.TransformPutTransformResponse>;
|
|
62
62
|
/**
|
|
63
63
|
* Reset a transform. Before you can reset it, you must stop it; alternatively, use the `force` query parameter. If the destination index was created by the transform, it is deleted.
|
|
64
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-reset-transform | Elasticsearch API documentation}
|
|
64
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-transform-reset-transform | Elasticsearch API documentation}
|
|
65
65
|
*/
|
|
66
66
|
resetTransform(this: That, params: T.TransformResetTransformRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.TransformResetTransformResponse>;
|
|
67
67
|
resetTransform(this: That, params: T.TransformResetTransformRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TransformResetTransformResponse, unknown>>;
|
|
68
68
|
resetTransform(this: That, params: T.TransformResetTransformRequest, options?: TransportRequestOptions): Promise<T.TransformResetTransformResponse>;
|
|
69
69
|
/**
|
|
70
70
|
* Schedule a transform to start now. Instantly run a transform to process data. If you run this API, the transform will process the new data instantly, without waiting for the configured frequency interval. After the API is called, the transform will be processed again at `now + frequency` unless the API is called again in the meantime.
|
|
71
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-schedule-now-transform | Elasticsearch API documentation}
|
|
71
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-transform-schedule-now-transform | Elasticsearch API documentation}
|
|
72
72
|
*/
|
|
73
73
|
scheduleNowTransform(this: That, params: T.TransformScheduleNowTransformRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.TransformScheduleNowTransformResponse>;
|
|
74
74
|
scheduleNowTransform(this: That, params: T.TransformScheduleNowTransformRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TransformScheduleNowTransformResponse, unknown>>;
|
|
75
75
|
scheduleNowTransform(this: That, params: T.TransformScheduleNowTransformRequest, options?: TransportRequestOptions): Promise<T.TransformScheduleNowTransformResponse>;
|
|
76
76
|
/**
|
|
77
77
|
* Set upgrade_mode for transform indices. Sets a cluster wide upgrade_mode setting that prepares transform indices for an upgrade. When upgrading your cluster, in some circumstances you must restart your nodes and reindex your transform indices. In those circumstances, there must be no transforms running. You can close the transforms, do the upgrade, then open all the transforms again. Alternatively, you can use this API to temporarily halt tasks associated with the transforms and prevent new transforms from opening. You can also use this API during upgrades that do not require you to reindex your transform indices, though stopping transforms is not a requirement in that case. You can see the current value for the upgrade_mode setting by using the get transform info API.
|
|
78
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-set-upgrade-mode | Elasticsearch API documentation}
|
|
78
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-transform-set-upgrade-mode | Elasticsearch API documentation}
|
|
79
79
|
*/
|
|
80
80
|
setUpgradeMode(this: That, params?: T.TransformSetUpgradeModeRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.TransformSetUpgradeModeResponse>;
|
|
81
81
|
setUpgradeMode(this: That, params?: T.TransformSetUpgradeModeRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TransformSetUpgradeModeResponse, unknown>>;
|
|
82
82
|
setUpgradeMode(this: That, params?: T.TransformSetUpgradeModeRequest, options?: TransportRequestOptions): Promise<T.TransformSetUpgradeModeResponse>;
|
|
83
83
|
/**
|
|
84
84
|
* Start a transform. When you start a transform, it creates the destination index if it does not already exist. The `number_of_shards` is set to `1` and the `auto_expand_replicas` is set to `0-1`. If it is a pivot transform, it deduces the mapping definitions for the destination index from the source indices and the transform aggregations. If fields in the destination index are derived from scripts (as in the case of `scripted_metric` or `bucket_script` aggregations), the transform uses dynamic mappings unless an index template exists. If it is a latest transform, it does not deduce mapping definitions; it uses dynamic mappings. To use explicit mappings, create the destination index before you start the transform. Alternatively, you can create an index template, though it does not affect the deduced mappings in a pivot transform. When the transform starts, a series of validations occur to ensure its success. If you deferred validation when you created the transform, they occur when you start the transform—with the exception of privilege checks. When Elasticsearch security features are enabled, the transform remembers which roles the user that created it had at the time of creation and uses those same roles. If those roles do not have the required privileges on the source and destination indices, the transform fails when it attempts unauthorized operations.
|
|
85
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-start-transform | Elasticsearch API documentation}
|
|
85
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-transform-start-transform | Elasticsearch API documentation}
|
|
86
86
|
*/
|
|
87
87
|
startTransform(this: That, params: T.TransformStartTransformRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.TransformStartTransformResponse>;
|
|
88
88
|
startTransform(this: That, params: T.TransformStartTransformRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TransformStartTransformResponse, unknown>>;
|
|
89
89
|
startTransform(this: That, params: T.TransformStartTransformRequest, options?: TransportRequestOptions): Promise<T.TransformStartTransformResponse>;
|
|
90
90
|
/**
|
|
91
91
|
* Stop transforms. Stops one or more transforms.
|
|
92
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-stop-transform | Elasticsearch API documentation}
|
|
92
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-transform-stop-transform | Elasticsearch API documentation}
|
|
93
93
|
*/
|
|
94
94
|
stopTransform(this: That, params: T.TransformStopTransformRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.TransformStopTransformResponse>;
|
|
95
95
|
stopTransform(this: That, params: T.TransformStopTransformRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TransformStopTransformResponse, unknown>>;
|
|
96
96
|
stopTransform(this: That, params: T.TransformStopTransformRequest, options?: TransportRequestOptions): Promise<T.TransformStopTransformResponse>;
|
|
97
97
|
/**
|
|
98
98
|
* Update a transform. Updates certain properties of a transform. All updated properties except `description` do not take effect until after the transform starts the next checkpoint, thus there is data consistency in each checkpoint. To use this API, you must have `read` and `view_index_metadata` privileges for the source indices. You must also have `index` and `read` privileges for the destination index. When Elasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the time of update and runs with those privileges.
|
|
99
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-update-transform | Elasticsearch API documentation}
|
|
99
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-transform-update-transform | Elasticsearch API documentation}
|
|
100
100
|
*/
|
|
101
101
|
updateTransform(this: That, params: T.TransformUpdateTransformRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.TransformUpdateTransformResponse>;
|
|
102
102
|
updateTransform(this: That, params: T.TransformUpdateTransformRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TransformUpdateTransformResponse, unknown>>;
|
|
103
103
|
updateTransform(this: That, params: T.TransformUpdateTransformRequest, options?: TransportRequestOptions): Promise<T.TransformUpdateTransformResponse>;
|
|
104
104
|
/**
|
|
105
105
|
* Upgrade all transforms. Transforms are compatible across minor versions and between supported major versions. However, over time, the format of transform configuration information may change. This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. It also cleans up the internal data structures that store the transform state and checkpoints. The upgrade does not affect the source and destination indices. The upgrade also does not affect the roles that transforms use when Elasticsearch security features are enabled; the role used to read source data and write to the destination index remains unchanged. If a transform upgrade step fails, the upgrade stops and an error is returned about the underlying issue. Resolve the issue then re-run the process again. A summary is returned when the upgrade is finished. To ensure continuous transforms remain running during a major version upgrade of the cluster – for example, from 7.16 to 8.0 – it is recommended to upgrade transforms before upgrading the cluster. You may want to perform a recent cluster backup prior to the upgrade.
|
|
106
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-upgrade-transforms | Elasticsearch API documentation}
|
|
106
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-transform-upgrade-transforms | Elasticsearch API documentation}
|
|
107
107
|
*/
|
|
108
108
|
upgradeTransforms(this: That, params?: T.TransformUpgradeTransformsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.TransformUpgradeTransformsResponse>;
|
|
109
109
|
upgradeTransforms(this: That, params?: T.TransformUpgradeTransformsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TransformUpgradeTransformsResponse, unknown>>;
|
package/lib/api/api/update.d.ts
CHANGED
|
@@ -5,7 +5,7 @@ interface That {
|
|
|
5
5
|
}
|
|
6
6
|
/**
|
|
7
7
|
* Update a document. Update a document by running a script or passing a partial document. If the Elasticsearch security features are enabled, you must have the `index` or `write` index privilege for the target index or index alias. The script can update, delete, or skip modifying the document. The API also supports passing a partial document, which is merged into the existing document. To fully replace an existing document, use the index API. This operation: * Gets the document (collocated with the shard) from the index. * Runs the specified script. * Indexes the result. The document must still be reindexed, but using this API removes some network roundtrips and reduces chances of version conflicts between the GET and the index operation. The `_source` field must be enabled to use this API. In addition to `_source`, you can access the following variables through the `ctx` map: `_index`, `_type`, `_id`, `_version`, `_routing`, and `_now` (the current timestamp). For usage examples such as partial updates, upserts, and scripted updates, see the External documentation.
|
|
8
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-update | Elasticsearch API documentation}
|
|
8
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-update | Elasticsearch API documentation}
|
|
9
9
|
*/
|
|
10
10
|
export default function UpdateApi<TDocument = unknown, TPartialDocument = unknown, TDocumentR = unknown>(this: That, params: T.UpdateRequest<TDocument, TPartialDocument>, options?: TransportRequestOptionsWithOutMeta): Promise<T.UpdateResponse<TDocumentR>>;
|
|
11
11
|
export default function UpdateApi<TDocument = unknown, TPartialDocument = unknown, TDocumentR = unknown>(this: That, params: T.UpdateRequest<TDocument, TPartialDocument>, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.UpdateResponse<TDocumentR>, unknown>>;
|
|
@@ -5,7 +5,7 @@ interface That {
|
|
|
5
5
|
}
|
|
6
6
|
/**
|
|
7
7
|
* Update documents. Updates documents that match the specified query. If no query is specified, performs an update on every document in the data stream or index without modifying the source, which is useful for picking up mapping changes. If the Elasticsearch security features are enabled, you must have the following index privileges for the target data stream, index, or alias: * `read` * `index` or `write` You can specify the query criteria in the request URI or the request body using the same syntax as the search API. When you submit an update by query request, Elasticsearch gets a snapshot of the data stream or index when it begins processing the request and updates matching documents using internal versioning. When the versions match, the document is updated and the version number is incremented. If a document changes between the time that the snapshot is taken and the update operation is processed, it results in a version conflict and the operation fails. You can opt to count version conflicts instead of halting and returning by setting `conflicts` to `proceed`. Note that if you opt to count version conflicts, the operation could attempt to update more documents from the source than `max_docs` until it has successfully updated `max_docs` documents or it has gone through every document in the source query. NOTE: Documents with a version equal to 0 cannot be updated using update by query because internal versioning does not support 0 as a valid version number. While processing an update by query request, Elasticsearch performs multiple search requests sequentially to find all of the matching documents. A bulk update request is performed for each batch of matching documents. Any query or update failures cause the update by query request to fail and the failures are shown in the response. Any update requests that completed successfully still stick, they are not rolled back. **Refreshing shards** Specifying the `refresh` parameter refreshes all shards once the request completes. This is different to the update API's `refresh` parameter, which causes only the shard that received the request to be refreshed. Unlike the update API, it does not support `wait_for`. **Running update by query asynchronously** If the request contains `wait_for_completion=false`, Elasticsearch performs some preflight checks, launches the request, and returns a [task](https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-tasks) you can use to cancel or get the status of the task. Elasticsearch creates a record of this task as a document at `.tasks/task/${taskId}`. **Waiting for active shards** `wait_for_active_shards` controls how many copies of a shard must be active before proceeding with the request. See [`wait_for_active_shards`](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-create#operation-create-wait_for_active_shards) for details. `timeout` controls how long each write request waits for unavailable shards to become available. Both work exactly the way they work in the [Bulk API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-bulk). Update by query uses scrolled searches, so you can also specify the `scroll` parameter to control how long it keeps the search context alive, for example `?scroll=10m`. The default is 5 minutes. **Throttling update requests** To control the rate at which update by query issues batches of update operations, you can set `requests_per_second` to any positive decimal number. This pads each batch with a wait time to throttle the rate. Set `requests_per_second` to `-1` to turn off throttling. Throttling uses a wait time between batches so that the internal scroll requests can be given a timeout that takes the request padding into account. The padding time is the difference between the batch size divided by the `requests_per_second` and the time spent writing. By default the batch size is 1000, so if `requests_per_second` is set to `500`: ``` target_time = 1000 / 500 per second = 2 seconds wait_time = target_time - write_time = 2 seconds - .5 seconds = 1.5 seconds ``` Since the batch is issued as a single _bulk request, large batch sizes cause Elasticsearch to create many requests and wait before starting the next set. This is "bursty" instead of "smooth". **Slicing** Update by query supports sliced scroll to parallelize the update process. This can improve efficiency and provide a convenient way to break the request down into smaller parts. Setting `slices` to `auto` chooses a reasonable number for most data streams and indices. This setting will use one slice per shard, up to a certain limit. If there are multiple source data streams or indices, it will choose the number of slices based on the index or backing index with the smallest number of shards. Adding `slices` to `_update_by_query` just automates the manual process of creating sub-requests, which means it has some quirks: * You can see these requests in the tasks APIs. These sub-requests are "child" tasks of the task for the request with slices. * Fetching the status of the task for the request with `slices` only contains the status of completed slices. * These sub-requests are individually addressable for things like cancellation and rethrottling. * Rethrottling the request with `slices` will rethrottle the unfinished sub-request proportionally. * Canceling the request with slices will cancel each sub-request. * Due to the nature of slices each sub-request won't get a perfectly even portion of the documents. All documents will be addressed, but some slices may be larger than others. Expect larger slices to have a more even distribution. * Parameters like `requests_per_second` and `max_docs` on a request with slices are distributed proportionally to each sub-request. Combine that with the point above about distribution being uneven and you should conclude that using `max_docs` with `slices` might not result in exactly `max_docs` documents being updated. * Each sub-request gets a slightly different snapshot of the source data stream or index though these are all taken at approximately the same time. If you're slicing manually or otherwise tuning automatic slicing, keep in mind that: * Query performance is most efficient when the number of slices is equal to the number of shards in the index or backing index. If that number is large (for example, 500), choose a lower number as too many slices hurts performance. Setting slices higher than the number of shards generally does not improve efficiency and adds overhead. * Update performance scales linearly across available resources with the number of slices. Whether query or update performance dominates the runtime depends on the documents being reindexed and cluster resources. Refer to the linked documentation for examples of how to update documents using the `_update_by_query` API:
|
|
8
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-update-by-query | Elasticsearch API documentation}
|
|
8
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-update-by-query | Elasticsearch API documentation}
|
|
9
9
|
*/
|
|
10
10
|
export default function UpdateByQueryApi(this: That, params: T.UpdateByQueryRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.UpdateByQueryResponse>;
|
|
11
11
|
export default function UpdateByQueryApi(this: That, params: T.UpdateByQueryRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.UpdateByQueryResponse, unknown>>;
|
|
@@ -5,7 +5,7 @@ interface That {
|
|
|
5
5
|
}
|
|
6
6
|
/**
|
|
7
7
|
* Throttle an update by query operation. Change the number of requests per second for a particular update by query operation. Rethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts.
|
|
8
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-update-by-query-rethrottle | Elasticsearch API documentation}
|
|
8
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-update-by-query-rethrottle | Elasticsearch API documentation}
|
|
9
9
|
*/
|
|
10
10
|
export default function UpdateByQueryRethrottleApi(this: That, params: T.UpdateByQueryRethrottleRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.UpdateByQueryRethrottleResponse>;
|
|
11
11
|
export default function UpdateByQueryRethrottleApi(this: That, params: T.UpdateByQueryRethrottleRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.UpdateByQueryRethrottleResponse, unknown>>;
|
package/lib/api/api/watcher.d.ts
CHANGED
|
@@ -19,91 +19,91 @@ export default class Watcher {
|
|
|
19
19
|
constructor(transport: Transport);
|
|
20
20
|
/**
|
|
21
21
|
* Acknowledge a watch. Acknowledging a watch enables you to manually throttle the execution of the watch's actions. The acknowledgement state of an action is stored in the `status.actions.<id>.ack.state` structure. IMPORTANT: If the specified watch is currently being executed, this API will return an error The reason for this behavior is to prevent overwriting the watch status from a watch execution. Acknowledging an action throttles further executions of that action until its `ack.state` is reset to `awaits_successful_execution`. This happens when the condition of the watch is not met (the condition evaluates to false). To demonstrate how throttling works in practice and how it can be configured for individual actions within a watch, refer to External documentation.
|
|
22
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-ack-watch | Elasticsearch API documentation}
|
|
22
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-watcher-ack-watch | Elasticsearch API documentation}
|
|
23
23
|
*/
|
|
24
24
|
ackWatch(this: That, params: T.WatcherAckWatchRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.WatcherAckWatchResponse>;
|
|
25
25
|
ackWatch(this: That, params: T.WatcherAckWatchRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.WatcherAckWatchResponse, unknown>>;
|
|
26
26
|
ackWatch(this: That, params: T.WatcherAckWatchRequest, options?: TransportRequestOptions): Promise<T.WatcherAckWatchResponse>;
|
|
27
27
|
/**
|
|
28
28
|
* Activate a watch. A watch can be either active or inactive.
|
|
29
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-activate-watch | Elasticsearch API documentation}
|
|
29
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-watcher-activate-watch | Elasticsearch API documentation}
|
|
30
30
|
*/
|
|
31
31
|
activateWatch(this: That, params: T.WatcherActivateWatchRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.WatcherActivateWatchResponse>;
|
|
32
32
|
activateWatch(this: That, params: T.WatcherActivateWatchRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.WatcherActivateWatchResponse, unknown>>;
|
|
33
33
|
activateWatch(this: That, params: T.WatcherActivateWatchRequest, options?: TransportRequestOptions): Promise<T.WatcherActivateWatchResponse>;
|
|
34
34
|
/**
|
|
35
35
|
* Deactivate a watch. A watch can be either active or inactive.
|
|
36
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-deactivate-watch | Elasticsearch API documentation}
|
|
36
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-watcher-deactivate-watch | Elasticsearch API documentation}
|
|
37
37
|
*/
|
|
38
38
|
deactivateWatch(this: That, params: T.WatcherDeactivateWatchRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.WatcherDeactivateWatchResponse>;
|
|
39
39
|
deactivateWatch(this: That, params: T.WatcherDeactivateWatchRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.WatcherDeactivateWatchResponse, unknown>>;
|
|
40
40
|
deactivateWatch(this: That, params: T.WatcherDeactivateWatchRequest, options?: TransportRequestOptions): Promise<T.WatcherDeactivateWatchResponse>;
|
|
41
41
|
/**
|
|
42
42
|
* Delete a watch. When the watch is removed, the document representing the watch in the `.watches` index is gone and it will never be run again. Deleting a watch does not delete any watch execution records related to this watch from the watch history. IMPORTANT: Deleting a watch must be done by using only this API. Do not delete the watch directly from the `.watches` index using the Elasticsearch delete document API When Elasticsearch security features are enabled, make sure no write privileges are granted to anyone for the `.watches` index.
|
|
43
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-delete-watch | Elasticsearch API documentation}
|
|
43
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-watcher-delete-watch | Elasticsearch API documentation}
|
|
44
44
|
*/
|
|
45
45
|
deleteWatch(this: That, params: T.WatcherDeleteWatchRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.WatcherDeleteWatchResponse>;
|
|
46
46
|
deleteWatch(this: That, params: T.WatcherDeleteWatchRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.WatcherDeleteWatchResponse, unknown>>;
|
|
47
47
|
deleteWatch(this: That, params: T.WatcherDeleteWatchRequest, options?: TransportRequestOptions): Promise<T.WatcherDeleteWatchResponse>;
|
|
48
48
|
/**
|
|
49
49
|
* Run a watch. This API can be used to force execution of the watch outside of its triggering logic or to simulate the watch execution for debugging purposes. For testing and debugging purposes, you also have fine-grained control on how the watch runs. You can run the watch without running all of its actions or alternatively by simulating them. You can also force execution by ignoring the watch condition and control whether a watch record would be written to the watch history after it runs. You can use the run watch API to run watches that are not yet registered by specifying the watch definition inline. This serves as great tool for testing and debugging your watches prior to adding them to Watcher. When Elasticsearch security features are enabled on your cluster, watches are run with the privileges of the user that stored the watches. If your user is allowed to read index `a`, but not index `b`, then the exact same set of rules will apply during execution of a watch. When using the run watch API, the authorization data of the user that called the API will be used as a base, instead of the information who stored the watch. Refer to the external documentation for examples of watch execution requests, including existing, customized, and inline watches.
|
|
50
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-execute-watch | Elasticsearch API documentation}
|
|
50
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-watcher-execute-watch | Elasticsearch API documentation}
|
|
51
51
|
*/
|
|
52
52
|
executeWatch(this: That, params?: T.WatcherExecuteWatchRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.WatcherExecuteWatchResponse>;
|
|
53
53
|
executeWatch(this: That, params?: T.WatcherExecuteWatchRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.WatcherExecuteWatchResponse, unknown>>;
|
|
54
54
|
executeWatch(this: That, params?: T.WatcherExecuteWatchRequest, options?: TransportRequestOptions): Promise<T.WatcherExecuteWatchResponse>;
|
|
55
55
|
/**
|
|
56
56
|
* Get Watcher index settings. Get settings for the Watcher internal index (`.watches`). Only a subset of settings are shown, for example `index.auto_expand_replicas` and `index.number_of_replicas`.
|
|
57
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-get-settings | Elasticsearch API documentation}
|
|
57
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-watcher-get-settings | Elasticsearch API documentation}
|
|
58
58
|
*/
|
|
59
59
|
getSettings(this: That, params?: T.WatcherGetSettingsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.WatcherGetSettingsResponse>;
|
|
60
60
|
getSettings(this: That, params?: T.WatcherGetSettingsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.WatcherGetSettingsResponse, unknown>>;
|
|
61
61
|
getSettings(this: That, params?: T.WatcherGetSettingsRequest, options?: TransportRequestOptions): Promise<T.WatcherGetSettingsResponse>;
|
|
62
62
|
/**
|
|
63
63
|
* Get a watch.
|
|
64
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-get-watch | Elasticsearch API documentation}
|
|
64
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-watcher-get-watch | Elasticsearch API documentation}
|
|
65
65
|
*/
|
|
66
66
|
getWatch(this: That, params: T.WatcherGetWatchRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.WatcherGetWatchResponse>;
|
|
67
67
|
getWatch(this: That, params: T.WatcherGetWatchRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.WatcherGetWatchResponse, unknown>>;
|
|
68
68
|
getWatch(this: That, params: T.WatcherGetWatchRequest, options?: TransportRequestOptions): Promise<T.WatcherGetWatchResponse>;
|
|
69
69
|
/**
|
|
70
70
|
* Create or update a watch. When a watch is registered, a new document that represents the watch is added to the `.watches` index and its trigger is immediately registered with the relevant trigger engine. Typically for the `schedule` trigger, the scheduler is the trigger engine. IMPORTANT: You must use Kibana or this API to create a watch. Do not add a watch directly to the `.watches` index by using the Elasticsearch index API. If Elasticsearch security features are enabled, do not give users write privileges on the `.watches` index. When you add a watch you can also define its initial active state by setting the *active* parameter. When Elasticsearch security features are enabled, your watch can index or search only on indices for which the user that stored the watch has privileges. If the user is able to read index `a`, but not index `b`, the same will apply when the watch runs.
|
|
71
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-put-watch | Elasticsearch API documentation}
|
|
71
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-watcher-put-watch | Elasticsearch API documentation}
|
|
72
72
|
*/
|
|
73
73
|
putWatch(this: That, params: T.WatcherPutWatchRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.WatcherPutWatchResponse>;
|
|
74
74
|
putWatch(this: That, params: T.WatcherPutWatchRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.WatcherPutWatchResponse, unknown>>;
|
|
75
75
|
putWatch(this: That, params: T.WatcherPutWatchRequest, options?: TransportRequestOptions): Promise<T.WatcherPutWatchResponse>;
|
|
76
76
|
/**
|
|
77
77
|
* Query watches. Get all registered watches in a paginated manner and optionally filter watches by a query. Note that only the `_id` and `metadata.*` fields are queryable or sortable.
|
|
78
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-query-watches | Elasticsearch API documentation}
|
|
78
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-watcher-query-watches | Elasticsearch API documentation}
|
|
79
79
|
*/
|
|
80
80
|
queryWatches(this: That, params?: T.WatcherQueryWatchesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.WatcherQueryWatchesResponse>;
|
|
81
81
|
queryWatches(this: That, params?: T.WatcherQueryWatchesRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.WatcherQueryWatchesResponse, unknown>>;
|
|
82
82
|
queryWatches(this: That, params?: T.WatcherQueryWatchesRequest, options?: TransportRequestOptions): Promise<T.WatcherQueryWatchesResponse>;
|
|
83
83
|
/**
|
|
84
84
|
* Start the watch service. Start the Watcher service if it is not already running.
|
|
85
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-start | Elasticsearch API documentation}
|
|
85
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-watcher-start | Elasticsearch API documentation}
|
|
86
86
|
*/
|
|
87
87
|
start(this: That, params?: T.WatcherStartRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.WatcherStartResponse>;
|
|
88
88
|
start(this: That, params?: T.WatcherStartRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.WatcherStartResponse, unknown>>;
|
|
89
89
|
start(this: That, params?: T.WatcherStartRequest, options?: TransportRequestOptions): Promise<T.WatcherStartResponse>;
|
|
90
90
|
/**
|
|
91
91
|
* Get Watcher statistics. This API always returns basic metrics. You retrieve more metrics by using the metric parameter.
|
|
92
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-stats | Elasticsearch API documentation}
|
|
92
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-watcher-stats | Elasticsearch API documentation}
|
|
93
93
|
*/
|
|
94
94
|
stats(this: That, params?: T.WatcherStatsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.WatcherStatsResponse>;
|
|
95
95
|
stats(this: That, params?: T.WatcherStatsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.WatcherStatsResponse, unknown>>;
|
|
96
96
|
stats(this: That, params?: T.WatcherStatsRequest, options?: TransportRequestOptions): Promise<T.WatcherStatsResponse>;
|
|
97
97
|
/**
|
|
98
98
|
* Stop the watch service. Stop the Watcher service if it is running.
|
|
99
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-stop | Elasticsearch API documentation}
|
|
99
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-watcher-stop | Elasticsearch API documentation}
|
|
100
100
|
*/
|
|
101
101
|
stop(this: That, params?: T.WatcherStopRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.WatcherStopResponse>;
|
|
102
102
|
stop(this: That, params?: T.WatcherStopRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.WatcherStopResponse, unknown>>;
|
|
103
103
|
stop(this: That, params?: T.WatcherStopRequest, options?: TransportRequestOptions): Promise<T.WatcherStopResponse>;
|
|
104
104
|
/**
|
|
105
105
|
* Update Watcher index settings. Update settings for the Watcher internal index (`.watches`). Only a subset of settings can be modified. This includes `index.auto_expand_replicas`, `index.number_of_replicas`, `index.routing.allocation.exclude.*`, `index.routing.allocation.include.*` and `index.routing.allocation.require.*`. Modification of `index.routing.allocation.include._tier_preference` is an exception and is not allowed as the Watcher shards must always be in the `data_content` tier.
|
|
106
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-update-settings | Elasticsearch API documentation}
|
|
106
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-watcher-update-settings | Elasticsearch API documentation}
|
|
107
107
|
*/
|
|
108
108
|
updateSettings(this: That, params?: T.WatcherUpdateSettingsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.WatcherUpdateSettingsResponse>;
|
|
109
109
|
updateSettings(this: That, params?: T.WatcherUpdateSettingsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.WatcherUpdateSettingsResponse, unknown>>;
|
package/lib/api/api/xpack.d.ts
CHANGED
|
@@ -19,14 +19,14 @@ export default class Xpack {
|
|
|
19
19
|
constructor(transport: Transport);
|
|
20
20
|
/**
|
|
21
21
|
* Get information. The information provided by the API includes: * Build information including the build number and timestamp. * License information about the currently installed license. * Feature information for the features that are currently enabled and available under the current license.
|
|
22
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-info | Elasticsearch API documentation}
|
|
22
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-info | Elasticsearch API documentation}
|
|
23
23
|
*/
|
|
24
24
|
info(this: That, params?: T.XpackInfoRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.XpackInfoResponse>;
|
|
25
25
|
info(this: That, params?: T.XpackInfoRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.XpackInfoResponse, unknown>>;
|
|
26
26
|
info(this: That, params?: T.XpackInfoRequest, options?: TransportRequestOptions): Promise<T.XpackInfoResponse>;
|
|
27
27
|
/**
|
|
28
28
|
* Get usage information. Get information about the features that are currently enabled and available under the current license. The API also provides some usage statistics.
|
|
29
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-xpack | Elasticsearch API documentation}
|
|
29
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-xpack | Elasticsearch API documentation}
|
|
30
30
|
*/
|
|
31
31
|
usage(this: That, params?: T.XpackUsageRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.XpackUsageResponse>;
|
|
32
32
|
usage(this: That, params?: T.XpackUsageRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.XpackUsageResponse, unknown>>;
|
package/lib/api/types.d.ts
CHANGED
|
@@ -26,8 +26,8 @@ export interface BulkOperationBase {
|
|
|
26
26
|
_id?: Id;
|
|
27
27
|
/** The name of the index or index alias to perform the action on. */
|
|
28
28
|
_index?: IndexName;
|
|
29
|
-
/** A custom value used to route operations to a specific shard. */
|
|
30
|
-
routing?:
|
|
29
|
+
/** A custom value used to route operations to a specific shard, or multiple comma separated values. */
|
|
30
|
+
routing?: string;
|
|
31
31
|
if_primary_term?: long;
|
|
32
32
|
if_seq_no?: SequenceNumber;
|
|
33
33
|
version?: VersionNumber;
|
|
@@ -2426,7 +2426,7 @@ export interface ReindexDestination {
|
|
|
2426
2426
|
* If it is `keep`, the routing on the bulk request sent for each match is set to the routing on the match.
|
|
2427
2427
|
* If it is `discard`, the routing on the bulk request sent for each match is set to `null`.
|
|
2428
2428
|
* If it is `=value`, the routing on the bulk request sent for each match is set to all value specified after the equals sign (`=`). */
|
|
2429
|
-
routing?:
|
|
2429
|
+
routing?: string;
|
|
2430
2430
|
/** The versioning to use for the indexing operation. */
|
|
2431
2431
|
version_type?: VersionType;
|
|
2432
2432
|
}
|
|
@@ -3253,7 +3253,7 @@ export interface SearchCompletionSuggestOption<TDocument = unknown> {
|
|
|
3253
3253
|
fields?: Record<string, any>;
|
|
3254
3254
|
_id?: string;
|
|
3255
3255
|
_index?: IndexName;
|
|
3256
|
-
_routing?:
|
|
3256
|
+
_routing?: string;
|
|
3257
3257
|
_score?: double;
|
|
3258
3258
|
_source?: TDocument;
|
|
3259
3259
|
text: string;
|
|
@@ -5380,6 +5380,7 @@ export interface KnnSearch {
|
|
|
5380
5380
|
inner_hits?: SearchInnerHits;
|
|
5381
5381
|
/** Apply oversampling and rescoring to quantized vectors */
|
|
5382
5382
|
rescore_vector?: RescoreVector;
|
|
5383
|
+
_name?: string;
|
|
5383
5384
|
}
|
|
5384
5385
|
export interface LatLonGeoLocation {
|
|
5385
5386
|
/** Latitude */
|
|
@@ -7127,13 +7128,20 @@ export interface AggregationsMultiBucketAggregateBase<TBucket = unknown> extends
|
|
|
7127
7128
|
export interface AggregationsMultiBucketBase {
|
|
7128
7129
|
doc_count: long;
|
|
7129
7130
|
}
|
|
7130
|
-
|
|
7131
|
-
/** A fields from which to retrieve terms. */
|
|
7132
|
-
field: Field;
|
|
7131
|
+
interface AggregationsMultiTermLookupCommonProps {
|
|
7133
7132
|
/** The value to apply to documents that do not have a value.
|
|
7134
7133
|
* By default, documents without a value are ignored. */
|
|
7135
7134
|
missing?: AggregationsMissing;
|
|
7136
7135
|
}
|
|
7136
|
+
interface AggregationsMultiTermLookupExclusiveProps {
|
|
7137
|
+
/** A field from which to retrieve terms.
|
|
7138
|
+
* It is required if `script` is not provided. */
|
|
7139
|
+
field?: Field;
|
|
7140
|
+
/** A script to calculate terms to aggregate on.
|
|
7141
|
+
* It is required if `field` is not provided. */
|
|
7142
|
+
script?: Script | ScriptSource;
|
|
7143
|
+
}
|
|
7144
|
+
export type AggregationsMultiTermLookup = AggregationsMultiTermLookupCommonProps & ExactlyOne<AggregationsMultiTermLookupExclusiveProps>;
|
|
7137
7145
|
export interface AggregationsMultiTermsAggregate extends AggregationsTermsAggregateBase<AggregationsMultiTermsBucket> {
|
|
7138
7146
|
}
|
|
7139
7147
|
export interface AggregationsMultiTermsAggregation extends AggregationsBucketAggregationBase {
|
|
@@ -9569,7 +9577,7 @@ export interface QueryDslFieldLookup {
|
|
|
9569
9577
|
/** Name of the field. */
|
|
9570
9578
|
path?: Field;
|
|
9571
9579
|
/** Custom routing value. */
|
|
9572
|
-
routing?:
|
|
9580
|
+
routing?: string;
|
|
9573
9581
|
}
|
|
9574
9582
|
export type QueryDslFieldValueFactorModifier = 'none' | 'log' | 'log1p' | 'log2p' | 'ln' | 'ln1p' | 'ln2p' | 'square' | 'sqrt' | 'reciprocal';
|
|
9575
9583
|
export interface QueryDslFieldValueFactorScoreFunction {
|
|
@@ -10015,7 +10023,7 @@ export interface QueryDslMoreLikeThisQuery extends QueryDslQueryBase {
|
|
|
10015
10023
|
min_term_freq?: integer;
|
|
10016
10024
|
/** The minimum word length below which the terms are ignored. */
|
|
10017
10025
|
min_word_length?: integer;
|
|
10018
|
-
routing?:
|
|
10026
|
+
routing?: string;
|
|
10019
10027
|
/** An array of stop words.
|
|
10020
10028
|
* Any word in this set is ignored. */
|
|
10021
10029
|
stop_words?: AnalysisStopWords;
|
|
@@ -10106,7 +10114,7 @@ export interface QueryDslPercolateQuery extends QueryDslQueryBase {
|
|
|
10106
10114
|
/** Preference used to fetch document to percolate. */
|
|
10107
10115
|
preference?: string;
|
|
10108
10116
|
/** Routing used to fetch document to percolate. */
|
|
10109
|
-
routing?:
|
|
10117
|
+
routing?: string;
|
|
10110
10118
|
/** The expected version of a stored document to percolate. */
|
|
10111
10119
|
version?: VersionNumber;
|
|
10112
10120
|
}
|
|
@@ -10602,7 +10610,7 @@ export interface QueryDslTermsLookup {
|
|
|
10602
10610
|
index: IndexName;
|
|
10603
10611
|
id: Id;
|
|
10604
10612
|
path: Field;
|
|
10605
|
-
routing?:
|
|
10613
|
+
routing?: string;
|
|
10606
10614
|
}
|
|
10607
10615
|
export interface QueryDslTermsQueryKeys extends QueryDslQueryBase {
|
|
10608
10616
|
}
|
|
@@ -20270,6 +20278,15 @@ export interface EsqlAsyncQueryRequest extends RequestBase {
|
|
|
20270
20278
|
/** Indicates whether the query and its results are stored in the cluster.
|
|
20271
20279
|
* If false, the query and its results are stored in the cluster only if the request does not complete during the period set by the `wait_for_completion_timeout` parameter. */
|
|
20272
20280
|
keep_on_completion?: boolean;
|
|
20281
|
+
/** Specifies a subset of projects to target using project
|
|
20282
|
+
* metadata tags in a subset of Lucene query syntax.
|
|
20283
|
+
* Allowed Lucene queries: the _alias tag and a single value (possibly wildcarded).
|
|
20284
|
+
* Examples:
|
|
20285
|
+
* _alias:my-project
|
|
20286
|
+
* _alias:_origin
|
|
20287
|
+
* _alias:*pr*
|
|
20288
|
+
* Supported in serverless only. */
|
|
20289
|
+
project_routing?: ProjectRouting;
|
|
20273
20290
|
/** All values in `body` will be added to the request body. */
|
|
20274
20291
|
body?: string | ({
|
|
20275
20292
|
[key: string]: any;
|
|
@@ -20290,6 +20307,7 @@ export interface EsqlAsyncQueryRequest extends RequestBase {
|
|
|
20290
20307
|
wait_for_completion_timeout?: never;
|
|
20291
20308
|
keep_alive?: never;
|
|
20292
20309
|
keep_on_completion?: never;
|
|
20310
|
+
project_routing?: never;
|
|
20293
20311
|
});
|
|
20294
20312
|
/** All values in `querystring` will be added to the request querystring. */
|
|
20295
20313
|
querystring?: {
|
|
@@ -20311,6 +20329,7 @@ export interface EsqlAsyncQueryRequest extends RequestBase {
|
|
|
20311
20329
|
wait_for_completion_timeout?: never;
|
|
20312
20330
|
keep_alive?: never;
|
|
20313
20331
|
keep_on_completion?: never;
|
|
20332
|
+
project_routing?: never;
|
|
20314
20333
|
};
|
|
20315
20334
|
}
|
|
20316
20335
|
export type EsqlAsyncQueryResponse = EsqlAsyncEsqlResult;
|
|
@@ -20540,6 +20559,15 @@ export interface EsqlQueryRequest extends RequestBase {
|
|
|
20540
20559
|
* count.
|
|
20541
20560
|
* This is similar to `include_ccs_metadata`, but it also returns metadata when the query is not CCS/CPS */
|
|
20542
20561
|
include_execution_metadata?: boolean;
|
|
20562
|
+
/** Specifies a subset of projects to target using project
|
|
20563
|
+
* metadata tags in a subset of Lucene query syntax.
|
|
20564
|
+
* Allowed Lucene queries: the _alias tag and a single value (possibly wildcarded).
|
|
20565
|
+
* Examples:
|
|
20566
|
+
* _alias:my-project
|
|
20567
|
+
* _alias:_origin
|
|
20568
|
+
* _alias:*pr*
|
|
20569
|
+
* Supported in serverless only. */
|
|
20570
|
+
project_routing?: ProjectRouting;
|
|
20543
20571
|
/** All values in `body` will be added to the request body. */
|
|
20544
20572
|
body?: string | ({
|
|
20545
20573
|
[key: string]: any;
|
|
@@ -20557,6 +20585,7 @@ export interface EsqlQueryRequest extends RequestBase {
|
|
|
20557
20585
|
tables?: never;
|
|
20558
20586
|
include_ccs_metadata?: never;
|
|
20559
20587
|
include_execution_metadata?: never;
|
|
20588
|
+
project_routing?: never;
|
|
20560
20589
|
});
|
|
20561
20590
|
/** All values in `querystring` will be added to the request querystring. */
|
|
20562
20591
|
querystring?: {
|
|
@@ -20575,6 +20604,7 @@ export interface EsqlQueryRequest extends RequestBase {
|
|
|
20575
20604
|
tables?: never;
|
|
20576
20605
|
include_ccs_metadata?: never;
|
|
20577
20606
|
include_execution_metadata?: never;
|
|
20607
|
+
project_routing?: never;
|
|
20578
20608
|
};
|
|
20579
20609
|
}
|
|
20580
20610
|
export type EsqlQueryResponse = EsqlEsqlResult;
|
|
@@ -21597,17 +21627,17 @@ export interface IndicesAlias {
|
|
|
21597
21627
|
filter?: QueryDslQueryContainer;
|
|
21598
21628
|
/** Value used to route indexing operations to a specific shard.
|
|
21599
21629
|
* If specified, this overwrites the `routing` value for indexing operations. */
|
|
21600
|
-
index_routing?:
|
|
21630
|
+
index_routing?: string;
|
|
21601
21631
|
/** If `true`, the alias is hidden.
|
|
21602
21632
|
* All indices for the alias must have the same `is_hidden` value. */
|
|
21603
21633
|
is_hidden?: boolean;
|
|
21604
21634
|
/** If `true`, the index is the write index for the alias. */
|
|
21605
21635
|
is_write_index?: boolean;
|
|
21606
21636
|
/** Value used to route indexing and search operations to a specific shard. */
|
|
21607
|
-
routing?:
|
|
21637
|
+
routing?: string;
|
|
21608
21638
|
/** Value used to route search operations to a specific shard.
|
|
21609
21639
|
* If specified, this overwrites the `routing` value for search operations. */
|
|
21610
|
-
search_routing?:
|
|
21640
|
+
search_routing?: string;
|
|
21611
21641
|
}
|
|
21612
21642
|
export interface IndicesAliasDefinition {
|
|
21613
21643
|
/** Query used to limit documents the alias can access. */
|
|
@@ -24320,7 +24350,7 @@ export interface IndicesPutAliasRequest extends RequestBase {
|
|
|
24320
24350
|
/** Value used to route indexing operations to a specific shard.
|
|
24321
24351
|
* If specified, this overwrites the `routing` value for indexing operations.
|
|
24322
24352
|
* Data stream aliases don’t support this parameter. */
|
|
24323
|
-
index_routing?:
|
|
24353
|
+
index_routing?: string;
|
|
24324
24354
|
/** If `true`, sets the write index or data stream for the alias.
|
|
24325
24355
|
* If an alias points to multiple indices or data streams and `is_write_index` isn’t set, the alias rejects write requests.
|
|
24326
24356
|
* If an index alias points to one index and `is_write_index` isn’t set, the index automatically acts as the write index.
|
|
@@ -24328,11 +24358,11 @@ export interface IndicesPutAliasRequest extends RequestBase {
|
|
|
24328
24358
|
is_write_index?: boolean;
|
|
24329
24359
|
/** Value used to route indexing and search operations to a specific shard.
|
|
24330
24360
|
* Data stream aliases don’t support this parameter. */
|
|
24331
|
-
routing?:
|
|
24361
|
+
routing?: string;
|
|
24332
24362
|
/** Value used to route search operations to a specific shard.
|
|
24333
24363
|
* If specified, this overwrites the `routing` value for search operations.
|
|
24334
24364
|
* Data stream aliases don’t support this parameter. */
|
|
24335
|
-
search_routing?:
|
|
24365
|
+
search_routing?: string;
|
|
24336
24366
|
/** All values in `body` will be added to the request body. */
|
|
24337
24367
|
body?: string | ({
|
|
24338
24368
|
[key: string]: any;
|
|
@@ -26054,18 +26084,18 @@ export interface IndicesUpdateAliasesAddAction {
|
|
|
26054
26084
|
/** Value used to route indexing operations to a specific shard.
|
|
26055
26085
|
* If specified, this overwrites the `routing` value for indexing operations.
|
|
26056
26086
|
* Data stream aliases don’t support this parameter. */
|
|
26057
|
-
index_routing?:
|
|
26087
|
+
index_routing?: string;
|
|
26058
26088
|
/** If `true`, the alias is hidden. */
|
|
26059
26089
|
is_hidden?: boolean;
|
|
26060
26090
|
/** If `true`, sets the write index or data stream for the alias. */
|
|
26061
26091
|
is_write_index?: boolean;
|
|
26062
26092
|
/** Value used to route indexing and search operations to a specific shard.
|
|
26063
26093
|
* Data stream aliases don’t support this parameter. */
|
|
26064
|
-
routing?:
|
|
26094
|
+
routing?: string;
|
|
26065
26095
|
/** Value used to route search operations to a specific shard.
|
|
26066
26096
|
* If specified, this overwrites the `routing` value for search operations.
|
|
26067
26097
|
* Data stream aliases don’t support this parameter. */
|
|
26068
|
-
search_routing?:
|
|
26098
|
+
search_routing?: string;
|
|
26069
26099
|
/** If `true`, the alias must exist to perform the action. */
|
|
26070
26100
|
must_exist?: boolean;
|
|
26071
26101
|
}
|
|
@@ -27844,9 +27874,10 @@ export interface InferenceDeleteRequest extends RequestBase {
|
|
|
27844
27874
|
}
|
|
27845
27875
|
export type InferenceDeleteResponse = InferenceDeleteInferenceEndpointResult;
|
|
27846
27876
|
export interface InferenceGetRequest extends RequestBase {
|
|
27847
|
-
/** The task type */
|
|
27877
|
+
/** The task type of the endpoint to return */
|
|
27848
27878
|
task_type?: InferenceTaskType;
|
|
27849
|
-
/** The inference Id
|
|
27879
|
+
/** The inference Id of the endpoint to return. Using `_all` or `*` will return all endpoints with the specified
|
|
27880
|
+
* `task_type` if one is specified, or all endpoints for all task types if no `task_type` is specified */
|
|
27850
27881
|
inference_id?: Id;
|
|
27851
27882
|
/** All values in `body` will be added to the request body. */
|
|
27852
27883
|
body?: string | ({
|
|
@@ -29835,7 +29866,7 @@ interface IngestProcessorContainerExclusiveProps {
|
|
|
29835
29866
|
/** Joins each element of an array into a single string using a separator character between each element.
|
|
29836
29867
|
* Throws an error when the field is not an array. */
|
|
29837
29868
|
join?: IngestJoinProcessor;
|
|
29838
|
-
/**
|
|
29869
|
+
/** Parses a string containing JSON data into a structured object, string, or other value. */
|
|
29839
29870
|
json?: IngestJsonProcessor;
|
|
29840
29871
|
/** This processor helps automatically parse messages (or specific event fields) which are of the `foo=bar` variety. */
|
|
29841
29872
|
kv?: IngestKeyValueProcessor;
|
|
@@ -37568,9 +37599,14 @@ export interface NodesStatsResponseBase extends NodesNodesResponseBase {
|
|
|
37568
37599
|
nodes: Record<string, NodesStats>;
|
|
37569
37600
|
}
|
|
37570
37601
|
export interface NodesUsageNodeUsage {
|
|
37602
|
+
/** The total number of times each REST endpoint has been called on this node since the last restart.
|
|
37603
|
+
* Note that the REST endpoint names are not considered stable. */
|
|
37571
37604
|
rest_actions: Record<string, integer>;
|
|
37605
|
+
/** The timestamp for when the collection of these statistics started. */
|
|
37572
37606
|
since: EpochTime<UnitMillis>;
|
|
37607
|
+
/** The timestamp for when these statistics were collected. */
|
|
37573
37608
|
timestamp: EpochTime<UnitMillis>;
|
|
37609
|
+
/** The total number of times search aggregations have been called on this node since the last restart. */
|
|
37574
37610
|
aggregations: Record<string, any>;
|
|
37575
37611
|
}
|
|
37576
37612
|
export type NodesUsageNodesUsageMetric = '_all' | 'rest_actions' | 'aggregations';
|
package/lib/client.js
CHANGED
|
@@ -17,19 +17,16 @@ const helpers_1 = tslib_1.__importDefault(require("./helpers"));
|
|
|
17
17
|
const api_1 = tslib_1.__importDefault(require("./api"));
|
|
18
18
|
const symbols_1 = require("./symbols");
|
|
19
19
|
Object.defineProperty(exports, "kAcceptedParams", { enumerable: true, get: function () { return symbols_1.kAcceptedParams; } });
|
|
20
|
-
|
|
21
|
-
const packageJson = require('../package.json');
|
|
22
|
-
const transportPackageJson = require('@elastic/transport/package.json');
|
|
23
|
-
/* eslint-enable @typescript-eslint/no-var-requires */
|
|
20
|
+
const version_generated_1 = require("./version.generated");
|
|
24
21
|
const kChild = Symbol('elasticsearchjs-child');
|
|
25
22
|
const kInitialOptions = Symbol('elasticsearchjs-initial-options');
|
|
26
|
-
let clientVersion =
|
|
23
|
+
let clientVersion = version_generated_1.clientVersion;
|
|
27
24
|
/* istanbul ignore next */
|
|
28
25
|
if (clientVersion.includes('-')) {
|
|
29
26
|
// clean prerelease
|
|
30
27
|
clientVersion = clientVersion.slice(0, clientVersion.indexOf('-')) + 'p';
|
|
31
28
|
}
|
|
32
|
-
let transportVersion =
|
|
29
|
+
let transportVersion = version_generated_1.transportVersion;
|
|
33
30
|
/* istanbul ignore next */
|
|
34
31
|
if (transportVersion.includes('-')) {
|
|
35
32
|
// clean prerelease
|