@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
package/lib/api/api/ccr.d.ts
CHANGED
|
@@ -19,91 +19,91 @@ export default class Ccr {
|
|
|
19
19
|
constructor(transport: Transport);
|
|
20
20
|
/**
|
|
21
21
|
* Delete auto-follow patterns. Delete a collection of cross-cluster replication auto-follow patterns.
|
|
22
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-delete-auto-follow-pattern | Elasticsearch API documentation}
|
|
22
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ccr-delete-auto-follow-pattern | Elasticsearch API documentation}
|
|
23
23
|
*/
|
|
24
24
|
deleteAutoFollowPattern(this: That, params: T.CcrDeleteAutoFollowPatternRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CcrDeleteAutoFollowPatternResponse>;
|
|
25
25
|
deleteAutoFollowPattern(this: That, params: T.CcrDeleteAutoFollowPatternRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CcrDeleteAutoFollowPatternResponse, unknown>>;
|
|
26
26
|
deleteAutoFollowPattern(this: That, params: T.CcrDeleteAutoFollowPatternRequest, options?: TransportRequestOptions): Promise<T.CcrDeleteAutoFollowPatternResponse>;
|
|
27
27
|
/**
|
|
28
28
|
* Create a follower. Create a cross-cluster replication follower index that follows a specific leader index. When the API returns, the follower index exists and cross-cluster replication starts replicating operations from the leader index to the follower index.
|
|
29
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-follow | Elasticsearch API documentation}
|
|
29
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ccr-follow | Elasticsearch API documentation}
|
|
30
30
|
*/
|
|
31
31
|
follow(this: That, params: T.CcrFollowRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CcrFollowResponse>;
|
|
32
32
|
follow(this: That, params: T.CcrFollowRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CcrFollowResponse, unknown>>;
|
|
33
33
|
follow(this: That, params: T.CcrFollowRequest, options?: TransportRequestOptions): Promise<T.CcrFollowResponse>;
|
|
34
34
|
/**
|
|
35
35
|
* Get follower information. Get information about all cross-cluster replication follower indices. For example, the results include follower index names, leader index names, replication options, and whether the follower indices are active or paused.
|
|
36
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-follow-info | Elasticsearch API documentation}
|
|
36
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ccr-follow-info | Elasticsearch API documentation}
|
|
37
37
|
*/
|
|
38
38
|
followInfo(this: That, params: T.CcrFollowInfoRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CcrFollowInfoResponse>;
|
|
39
39
|
followInfo(this: That, params: T.CcrFollowInfoRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CcrFollowInfoResponse, unknown>>;
|
|
40
40
|
followInfo(this: That, params: T.CcrFollowInfoRequest, options?: TransportRequestOptions): Promise<T.CcrFollowInfoResponse>;
|
|
41
41
|
/**
|
|
42
42
|
* Get follower stats. Get cross-cluster replication follower stats. The API returns shard-level stats about the "following tasks" associated with each shard for the specified indices.
|
|
43
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-follow-stats | Elasticsearch API documentation}
|
|
43
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ccr-follow-stats | Elasticsearch API documentation}
|
|
44
44
|
*/
|
|
45
45
|
followStats(this: That, params: T.CcrFollowStatsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CcrFollowStatsResponse>;
|
|
46
46
|
followStats(this: That, params: T.CcrFollowStatsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CcrFollowStatsResponse, unknown>>;
|
|
47
47
|
followStats(this: That, params: T.CcrFollowStatsRequest, options?: TransportRequestOptions): Promise<T.CcrFollowStatsResponse>;
|
|
48
48
|
/**
|
|
49
49
|
* Forget a follower. Remove the cross-cluster replication follower retention leases from the leader. A following index takes out retention leases on its leader index. These leases are used to increase the likelihood that the shards of the leader index retain the history of operations that the shards of the following index need to run replication. When a follower index is converted to a regular index by the unfollow API (either by directly calling the API or by index lifecycle management tasks), these leases are removed. However, removal of the leases can fail, for example when the remote cluster containing the leader index is unavailable. While the leases will eventually expire on their own, their extended existence can cause the leader index to hold more history than necessary and prevent index lifecycle management from performing some operations on the leader index. This API exists to enable manually removing the leases when the unfollow API is unable to do so. NOTE: This API does not stop replication by a following index. If you use this API with a follower index that is still actively following, the following index will add back retention leases on the leader. The only purpose of this API is to handle the case of failure to remove the following retention leases after the unfollow API is invoked.
|
|
50
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-forget-follower | Elasticsearch API documentation}
|
|
50
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ccr-forget-follower | Elasticsearch API documentation}
|
|
51
51
|
*/
|
|
52
52
|
forgetFollower(this: That, params: T.CcrForgetFollowerRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CcrForgetFollowerResponse>;
|
|
53
53
|
forgetFollower(this: That, params: T.CcrForgetFollowerRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CcrForgetFollowerResponse, unknown>>;
|
|
54
54
|
forgetFollower(this: That, params: T.CcrForgetFollowerRequest, options?: TransportRequestOptions): Promise<T.CcrForgetFollowerResponse>;
|
|
55
55
|
/**
|
|
56
56
|
* Get auto-follow patterns. Get cross-cluster replication auto-follow patterns.
|
|
57
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-get-auto-follow-pattern-1 | Elasticsearch API documentation}
|
|
57
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ccr-get-auto-follow-pattern-1 | Elasticsearch API documentation}
|
|
58
58
|
*/
|
|
59
59
|
getAutoFollowPattern(this: That, params?: T.CcrGetAutoFollowPatternRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CcrGetAutoFollowPatternResponse>;
|
|
60
60
|
getAutoFollowPattern(this: That, params?: T.CcrGetAutoFollowPatternRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CcrGetAutoFollowPatternResponse, unknown>>;
|
|
61
61
|
getAutoFollowPattern(this: That, params?: T.CcrGetAutoFollowPatternRequest, options?: TransportRequestOptions): Promise<T.CcrGetAutoFollowPatternResponse>;
|
|
62
62
|
/**
|
|
63
63
|
* Pause an auto-follow pattern. Pause a cross-cluster replication auto-follow pattern. When the API returns, the auto-follow pattern is inactive. New indices that are created on the remote cluster and match the auto-follow patterns are ignored. You can resume auto-following with the resume auto-follow pattern API. When it resumes, the auto-follow pattern is active again and automatically configures follower indices for newly created indices on the remote cluster that match its patterns. Remote indices that were created while the pattern was paused will also be followed, unless they have been deleted or closed in the interim.
|
|
64
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-pause-auto-follow-pattern | Elasticsearch API documentation}
|
|
64
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ccr-pause-auto-follow-pattern | Elasticsearch API documentation}
|
|
65
65
|
*/
|
|
66
66
|
pauseAutoFollowPattern(this: That, params: T.CcrPauseAutoFollowPatternRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CcrPauseAutoFollowPatternResponse>;
|
|
67
67
|
pauseAutoFollowPattern(this: That, params: T.CcrPauseAutoFollowPatternRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CcrPauseAutoFollowPatternResponse, unknown>>;
|
|
68
68
|
pauseAutoFollowPattern(this: That, params: T.CcrPauseAutoFollowPatternRequest, options?: TransportRequestOptions): Promise<T.CcrPauseAutoFollowPatternResponse>;
|
|
69
69
|
/**
|
|
70
70
|
* Pause a follower. Pause a cross-cluster replication follower index. The follower index will not fetch any additional operations from the leader index. You can resume following with the resume follower API. You can pause and resume a follower index to change the configuration of the following task.
|
|
71
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-pause-follow | Elasticsearch API documentation}
|
|
71
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ccr-pause-follow | Elasticsearch API documentation}
|
|
72
72
|
*/
|
|
73
73
|
pauseFollow(this: That, params: T.CcrPauseFollowRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CcrPauseFollowResponse>;
|
|
74
74
|
pauseFollow(this: That, params: T.CcrPauseFollowRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CcrPauseFollowResponse, unknown>>;
|
|
75
75
|
pauseFollow(this: That, params: T.CcrPauseFollowRequest, options?: TransportRequestOptions): Promise<T.CcrPauseFollowResponse>;
|
|
76
76
|
/**
|
|
77
77
|
* Create or update auto-follow patterns. Create a collection of cross-cluster replication auto-follow patterns for a remote cluster. Newly created indices on the remote cluster that match any of the patterns are automatically configured as follower indices. Indices on the remote cluster that were created before the auto-follow pattern was created will not be auto-followed even if they match the pattern. This API can also be used to update auto-follow patterns. NOTE: Follower indices that were configured automatically before updating an auto-follow pattern will remain unchanged even if they do not match against the new patterns.
|
|
78
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-put-auto-follow-pattern | Elasticsearch API documentation}
|
|
78
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ccr-put-auto-follow-pattern | Elasticsearch API documentation}
|
|
79
79
|
*/
|
|
80
80
|
putAutoFollowPattern(this: That, params: T.CcrPutAutoFollowPatternRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CcrPutAutoFollowPatternResponse>;
|
|
81
81
|
putAutoFollowPattern(this: That, params: T.CcrPutAutoFollowPatternRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CcrPutAutoFollowPatternResponse, unknown>>;
|
|
82
82
|
putAutoFollowPattern(this: That, params: T.CcrPutAutoFollowPatternRequest, options?: TransportRequestOptions): Promise<T.CcrPutAutoFollowPatternResponse>;
|
|
83
83
|
/**
|
|
84
84
|
* Resume an auto-follow pattern. Resume a cross-cluster replication auto-follow pattern that was paused. The auto-follow pattern will resume configuring following indices for newly created indices that match its patterns on the remote cluster. Remote indices created while the pattern was paused will also be followed unless they have been deleted or closed in the interim.
|
|
85
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-resume-auto-follow-pattern | Elasticsearch API documentation}
|
|
85
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ccr-resume-auto-follow-pattern | Elasticsearch API documentation}
|
|
86
86
|
*/
|
|
87
87
|
resumeAutoFollowPattern(this: That, params: T.CcrResumeAutoFollowPatternRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CcrResumeAutoFollowPatternResponse>;
|
|
88
88
|
resumeAutoFollowPattern(this: That, params: T.CcrResumeAutoFollowPatternRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CcrResumeAutoFollowPatternResponse, unknown>>;
|
|
89
89
|
resumeAutoFollowPattern(this: That, params: T.CcrResumeAutoFollowPatternRequest, options?: TransportRequestOptions): Promise<T.CcrResumeAutoFollowPatternResponse>;
|
|
90
90
|
/**
|
|
91
91
|
* Resume a follower. Resume a cross-cluster replication follower index that was paused. The follower index could have been paused with the pause follower API. Alternatively it could be paused due to replication that cannot be retried due to failures during following tasks. When this API returns, the follower index will resume fetching operations from the leader index.
|
|
92
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-resume-follow | Elasticsearch API documentation}
|
|
92
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ccr-resume-follow | Elasticsearch API documentation}
|
|
93
93
|
*/
|
|
94
94
|
resumeFollow(this: That, params: T.CcrResumeFollowRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CcrResumeFollowResponse>;
|
|
95
95
|
resumeFollow(this: That, params: T.CcrResumeFollowRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CcrResumeFollowResponse, unknown>>;
|
|
96
96
|
resumeFollow(this: That, params: T.CcrResumeFollowRequest, options?: TransportRequestOptions): Promise<T.CcrResumeFollowResponse>;
|
|
97
97
|
/**
|
|
98
98
|
* Get cross-cluster replication stats. This API returns stats about auto-following and the same shard-level stats as the get follower stats API.
|
|
99
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-stats | Elasticsearch API documentation}
|
|
99
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ccr-stats | Elasticsearch API documentation}
|
|
100
100
|
*/
|
|
101
101
|
stats(this: That, params?: T.CcrStatsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CcrStatsResponse>;
|
|
102
102
|
stats(this: That, params?: T.CcrStatsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CcrStatsResponse, unknown>>;
|
|
103
103
|
stats(this: That, params?: T.CcrStatsRequest, options?: TransportRequestOptions): Promise<T.CcrStatsResponse>;
|
|
104
104
|
/**
|
|
105
105
|
* Unfollow an index. Convert a cross-cluster replication follower index to a regular index. The API stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. The follower index must be paused and closed before you call the unfollow API. > info > Currently cross-cluster replication does not support converting an existing regular index to a follower index. Converting a follower index to a regular index is an irreversible operation.
|
|
106
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-unfollow | Elasticsearch API documentation}
|
|
106
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ccr-unfollow | Elasticsearch API documentation}
|
|
107
107
|
*/
|
|
108
108
|
unfollow(this: That, params: T.CcrUnfollowRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CcrUnfollowResponse>;
|
|
109
109
|
unfollow(this: That, params: T.CcrUnfollowRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CcrUnfollowResponse, unknown>>;
|
|
@@ -5,7 +5,7 @@ interface That {
|
|
|
5
5
|
}
|
|
6
6
|
/**
|
|
7
7
|
* Clear a scrolling search. Clear the search context and results for a scrolling search.
|
|
8
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-clear-scroll | Elasticsearch API documentation}
|
|
8
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-clear-scroll | Elasticsearch API documentation}
|
|
9
9
|
*/
|
|
10
10
|
export default function ClearScrollApi(this: That, params?: T.ClearScrollRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ClearScrollResponse>;
|
|
11
11
|
export default function ClearScrollApi(this: That, params?: T.ClearScrollRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.ClearScrollResponse, unknown>>;
|
|
@@ -5,7 +5,7 @@ interface That {
|
|
|
5
5
|
}
|
|
6
6
|
/**
|
|
7
7
|
* Close a point in time. A point in time must be opened explicitly before being used in search requests. The `keep_alive` parameter tells Elasticsearch how long it should persist. A point in time is automatically closed when the `keep_alive` period has elapsed. However, keeping points in time has a cost; close them as soon as they are no longer required for search requests.
|
|
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 ClosePointInTimeApi(this: That, params: T.ClosePointInTimeRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ClosePointInTimeResponse>;
|
|
11
11
|
export default function ClosePointInTimeApi(this: That, params: T.ClosePointInTimeRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.ClosePointInTimeResponse, unknown>>;
|
package/lib/api/api/cluster.d.ts
CHANGED
|
@@ -19,112 +19,112 @@ export default class Cluster {
|
|
|
19
19
|
constructor(transport: Transport);
|
|
20
20
|
/**
|
|
21
21
|
* Explain the shard allocations. Get explanations for shard allocations in the cluster. This API accepts the current_node, index, primary and shard parameters in the request body or in query parameters, but not in both at the same time. For unassigned shards, it provides an explanation for why the shard is unassigned. For assigned shards, it provides an explanation for why the shard is remaining on its current node and has not moved or rebalanced to another node. This API can be very useful when attempting to diagnose why a shard is unassigned or why a shard continues to remain on its current node when you might expect otherwise. Refer to the linked documentation for examples of how to troubleshoot allocation issues using this API.
|
|
22
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-allocation-explain | Elasticsearch API documentation}
|
|
22
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cluster-allocation-explain | Elasticsearch API documentation}
|
|
23
23
|
*/
|
|
24
24
|
allocationExplain(this: That, params?: T.ClusterAllocationExplainRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ClusterAllocationExplainResponse>;
|
|
25
25
|
allocationExplain(this: That, params?: T.ClusterAllocationExplainRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.ClusterAllocationExplainResponse, unknown>>;
|
|
26
26
|
allocationExplain(this: That, params?: T.ClusterAllocationExplainRequest, options?: TransportRequestOptions): Promise<T.ClusterAllocationExplainResponse>;
|
|
27
27
|
/**
|
|
28
28
|
* Delete component templates. Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.
|
|
29
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-component-template | Elasticsearch API documentation}
|
|
29
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cluster-put-component-template | Elasticsearch API documentation}
|
|
30
30
|
*/
|
|
31
31
|
deleteComponentTemplate(this: That, params: T.ClusterDeleteComponentTemplateRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ClusterDeleteComponentTemplateResponse>;
|
|
32
32
|
deleteComponentTemplate(this: That, params: T.ClusterDeleteComponentTemplateRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.ClusterDeleteComponentTemplateResponse, unknown>>;
|
|
33
33
|
deleteComponentTemplate(this: That, params: T.ClusterDeleteComponentTemplateRequest, options?: TransportRequestOptions): Promise<T.ClusterDeleteComponentTemplateResponse>;
|
|
34
34
|
/**
|
|
35
35
|
* Clear cluster voting config exclusions. Remove master-eligible nodes from the voting configuration exclusion list.
|
|
36
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-post-voting-config-exclusions | Elasticsearch API documentation}
|
|
36
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cluster-post-voting-config-exclusions | Elasticsearch API documentation}
|
|
37
37
|
*/
|
|
38
38
|
deleteVotingConfigExclusions(this: That, params?: T.ClusterDeleteVotingConfigExclusionsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ClusterDeleteVotingConfigExclusionsResponse>;
|
|
39
39
|
deleteVotingConfigExclusions(this: That, params?: T.ClusterDeleteVotingConfigExclusionsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.ClusterDeleteVotingConfigExclusionsResponse, unknown>>;
|
|
40
40
|
deleteVotingConfigExclusions(this: That, params?: T.ClusterDeleteVotingConfigExclusionsRequest, options?: TransportRequestOptions): Promise<T.ClusterDeleteVotingConfigExclusionsResponse>;
|
|
41
41
|
/**
|
|
42
42
|
* Check component templates. Returns information about whether a particular component template exists.
|
|
43
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-component-template | Elasticsearch API documentation}
|
|
43
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cluster-put-component-template | Elasticsearch API documentation}
|
|
44
44
|
*/
|
|
45
45
|
existsComponentTemplate(this: That, params: T.ClusterExistsComponentTemplateRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ClusterExistsComponentTemplateResponse>;
|
|
46
46
|
existsComponentTemplate(this: That, params: T.ClusterExistsComponentTemplateRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.ClusterExistsComponentTemplateResponse, unknown>>;
|
|
47
47
|
existsComponentTemplate(this: That, params: T.ClusterExistsComponentTemplateRequest, options?: TransportRequestOptions): Promise<T.ClusterExistsComponentTemplateResponse>;
|
|
48
48
|
/**
|
|
49
49
|
* Get component templates. Get information about component templates.
|
|
50
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-component-template | Elasticsearch API documentation}
|
|
50
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cluster-put-component-template | Elasticsearch API documentation}
|
|
51
51
|
*/
|
|
52
52
|
getComponentTemplate(this: That, params?: T.ClusterGetComponentTemplateRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ClusterGetComponentTemplateResponse>;
|
|
53
53
|
getComponentTemplate(this: That, params?: T.ClusterGetComponentTemplateRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.ClusterGetComponentTemplateResponse, unknown>>;
|
|
54
54
|
getComponentTemplate(this: That, params?: T.ClusterGetComponentTemplateRequest, options?: TransportRequestOptions): Promise<T.ClusterGetComponentTemplateResponse>;
|
|
55
55
|
/**
|
|
56
56
|
* Get cluster-wide settings. By default, it returns only settings that have been explicitly defined.
|
|
57
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-get-settings | Elasticsearch API documentation}
|
|
57
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cluster-get-settings | Elasticsearch API documentation}
|
|
58
58
|
*/
|
|
59
59
|
getSettings(this: That, params?: T.ClusterGetSettingsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ClusterGetSettingsResponse>;
|
|
60
60
|
getSettings(this: That, params?: T.ClusterGetSettingsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.ClusterGetSettingsResponse, unknown>>;
|
|
61
61
|
getSettings(this: That, params?: T.ClusterGetSettingsRequest, options?: TransportRequestOptions): Promise<T.ClusterGetSettingsResponse>;
|
|
62
62
|
/**
|
|
63
63
|
* Get the cluster health status. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster. Yellow means that the primary shard is allocated but replicas are not. Green means that all shards are allocated. The index level status is controlled by the worst shard status. One of the main benefits of the API is the ability to wait until the cluster reaches a certain high watermark health level. The cluster status is controlled by the worst index status.
|
|
64
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-health | Elasticsearch API documentation}
|
|
64
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cluster-health | Elasticsearch API documentation}
|
|
65
65
|
*/
|
|
66
66
|
health(this: That, params?: T.ClusterHealthRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ClusterHealthResponse>;
|
|
67
67
|
health(this: That, params?: T.ClusterHealthRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.ClusterHealthResponse, unknown>>;
|
|
68
68
|
health(this: That, params?: T.ClusterHealthRequest, options?: TransportRequestOptions): Promise<T.ClusterHealthResponse>;
|
|
69
69
|
/**
|
|
70
70
|
* Get cluster info. Returns basic information about the cluster.
|
|
71
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-info | Elasticsearch API documentation}
|
|
71
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cluster-info | Elasticsearch API documentation}
|
|
72
72
|
*/
|
|
73
73
|
info(this: That, params: T.ClusterInfoRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ClusterInfoResponse>;
|
|
74
74
|
info(this: That, params: T.ClusterInfoRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.ClusterInfoResponse, unknown>>;
|
|
75
75
|
info(this: That, params: T.ClusterInfoRequest, options?: TransportRequestOptions): Promise<T.ClusterInfoResponse>;
|
|
76
76
|
/**
|
|
77
77
|
* Get the pending cluster tasks. Get information about cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet taken effect. NOTE: This API returns a list of any pending updates to the cluster state. These are distinct from the tasks reported by the task management API which include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests. However, if a user-initiated task such as a create index command causes a cluster state update, the activity of this task might be reported by both task api and pending cluster tasks API.
|
|
78
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-pending-tasks | Elasticsearch API documentation}
|
|
78
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cluster-pending-tasks | Elasticsearch API documentation}
|
|
79
79
|
*/
|
|
80
80
|
pendingTasks(this: That, params?: T.ClusterPendingTasksRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ClusterPendingTasksResponse>;
|
|
81
81
|
pendingTasks(this: That, params?: T.ClusterPendingTasksRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.ClusterPendingTasksResponse, unknown>>;
|
|
82
82
|
pendingTasks(this: That, params?: T.ClusterPendingTasksRequest, options?: TransportRequestOptions): Promise<T.ClusterPendingTasksResponse>;
|
|
83
83
|
/**
|
|
84
84
|
* Update voting configuration exclusions. Update the cluster voting config exclusions by node IDs or node names. By default, if there are more than three master-eligible nodes in the cluster and you remove fewer than half of the master-eligible nodes in the cluster at once, the voting configuration automatically shrinks. If you want to shrink the voting configuration to contain fewer than three nodes or to remove half or more of the master-eligible nodes in the cluster at once, use this API to remove departing nodes from the voting configuration manually. The API adds an entry for each specified node to the cluster’s voting configuration exclusions list. It then waits until the cluster has reconfigured its voting configuration to exclude the specified nodes. Clusters should have no voting configuration exclusions in normal operation. Once the excluded nodes have stopped, clear the voting configuration exclusions with `DELETE /_cluster/voting_config_exclusions`. This API waits for the nodes to be fully removed from the cluster before it returns. If your cluster has voting configuration exclusions for nodes that you no longer intend to remove, use `DELETE /_cluster/voting_config_exclusions?wait_for_removal=false` to clear the voting configuration exclusions without waiting for the nodes to leave the cluster. A response to `POST /_cluster/voting_config_exclusions` with an HTTP status code of 200 OK guarantees that the node has been removed from the voting configuration and will not be reinstated until the voting configuration exclusions are cleared by calling `DELETE /_cluster/voting_config_exclusions`. If the call to `POST /_cluster/voting_config_exclusions` fails or returns a response with an HTTP status code other than 200 OK then the node may not have been removed from the voting configuration. In that case, you may safely retry the call. NOTE: Voting exclusions are required only when you remove at least half of the master-eligible nodes from a cluster in a short time period. They are not required when removing master-ineligible nodes or when removing fewer than half of the master-eligible nodes.
|
|
85
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-post-voting-config-exclusions | Elasticsearch API documentation}
|
|
85
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cluster-post-voting-config-exclusions | Elasticsearch API documentation}
|
|
86
86
|
*/
|
|
87
87
|
postVotingConfigExclusions(this: That, params?: T.ClusterPostVotingConfigExclusionsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ClusterPostVotingConfigExclusionsResponse>;
|
|
88
88
|
postVotingConfigExclusions(this: That, params?: T.ClusterPostVotingConfigExclusionsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.ClusterPostVotingConfigExclusionsResponse, unknown>>;
|
|
89
89
|
postVotingConfigExclusions(this: That, params?: T.ClusterPostVotingConfigExclusionsRequest, options?: TransportRequestOptions): Promise<T.ClusterPostVotingConfigExclusionsResponse>;
|
|
90
90
|
/**
|
|
91
91
|
* Create or update a component template. Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. An index template can be composed of multiple component templates. To use a component template, specify it in an index template’s `composed_of` list. Component templates are only applied to new data streams and indices as part of a matching index template. Settings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template. Component templates are only used during index creation. For data streams, this includes data stream creation and the creation of a stream’s backing indices. Changes to component templates do not affect existing indices, including a stream’s backing indices. You can use C-style `/* *\/` block comments in component templates. You can include comments anywhere in the request body except before the opening curly bracket. **Applying component templates** You cannot directly apply a component template to a data stream or index. To be applied, a component template must be included in an index template's `composed_of` list.
|
|
92
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-component-template | Elasticsearch API documentation}
|
|
92
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cluster-put-component-template | Elasticsearch API documentation}
|
|
93
93
|
*/
|
|
94
94
|
putComponentTemplate(this: That, params: T.ClusterPutComponentTemplateRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ClusterPutComponentTemplateResponse>;
|
|
95
95
|
putComponentTemplate(this: That, params: T.ClusterPutComponentTemplateRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.ClusterPutComponentTemplateResponse, unknown>>;
|
|
96
96
|
putComponentTemplate(this: That, params: T.ClusterPutComponentTemplateRequest, options?: TransportRequestOptions): Promise<T.ClusterPutComponentTemplateResponse>;
|
|
97
97
|
/**
|
|
98
98
|
* Update the cluster settings. Configure and update dynamic settings on a running cluster. You can also configure dynamic settings locally on an unstarted or shut down node in `elasticsearch.yml`. Updates made with this API can be persistent, which apply across cluster restarts, or transient, which reset after a cluster restart. You can also reset transient or persistent settings by assigning them a null value. If you configure the same setting using multiple methods, Elasticsearch applies the settings in following order of precedence: 1) Transient setting; 2) Persistent setting; 3) `elasticsearch.yml` setting; 4) Default setting value. For example, you can apply a transient setting to override a persistent setting or `elasticsearch.yml` setting. However, a change to an `elasticsearch.yml` setting will not override a defined transient or persistent setting. TIP: In Elastic Cloud, use the user settings feature to configure all cluster settings. This method automatically rejects unsafe settings that could break your cluster. If you run Elasticsearch on your own hardware, use this API to configure dynamic cluster settings. Only use `elasticsearch.yml` for static cluster settings and node settings. The API doesn’t require a restart and ensures a setting’s value is the same on all nodes. WARNING: Transient cluster settings are no longer recommended. Use persistent cluster settings instead. If a cluster becomes unstable, transient settings can clear unexpectedly, resulting in a potentially undesired cluster configuration.
|
|
99
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-settings | Elasticsearch API documentation}
|
|
99
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cluster-put-settings | Elasticsearch API documentation}
|
|
100
100
|
*/
|
|
101
101
|
putSettings(this: That, params?: T.ClusterPutSettingsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ClusterPutSettingsResponse>;
|
|
102
102
|
putSettings(this: That, params?: T.ClusterPutSettingsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.ClusterPutSettingsResponse, unknown>>;
|
|
103
103
|
putSettings(this: That, params?: T.ClusterPutSettingsRequest, options?: TransportRequestOptions): Promise<T.ClusterPutSettingsResponse>;
|
|
104
104
|
/**
|
|
105
105
|
* Get remote cluster information. Get information about configured remote clusters. The API returns connection and endpoint information keyed by the configured remote cluster alias. > info > This API returns information that reflects current state on the local cluster. > The `connected` field does not necessarily reflect whether a remote cluster is down or unavailable, only whether there is currently an open connection to it. > Elasticsearch does not spontaneously try to reconnect to a disconnected remote cluster. > To trigger a reconnection, attempt a cross-cluster search, ES|QL cross-cluster search, or try the [resolve cluster endpoint](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-resolve-cluster).
|
|
106
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-remote-info | Elasticsearch API documentation}
|
|
106
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cluster-remote-info | Elasticsearch API documentation}
|
|
107
107
|
*/
|
|
108
108
|
remoteInfo(this: That, params?: T.ClusterRemoteInfoRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ClusterRemoteInfoResponse>;
|
|
109
109
|
remoteInfo(this: That, params?: T.ClusterRemoteInfoRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.ClusterRemoteInfoResponse, unknown>>;
|
|
110
110
|
remoteInfo(this: That, params?: T.ClusterRemoteInfoRequest, options?: TransportRequestOptions): Promise<T.ClusterRemoteInfoResponse>;
|
|
111
111
|
/**
|
|
112
112
|
* Reroute the cluster. Manually change the allocation of individual shards in the cluster. For example, a shard can be moved from one node to another explicitly, an allocation can be canceled, and an unassigned shard can be explicitly allocated to a specific node. It is important to note that after processing any reroute commands Elasticsearch will perform rebalancing as normal (respecting the values of settings such as `cluster.routing.rebalance.enable`) in order to remain in a balanced state. For example, if the requested allocation includes moving a shard from node1 to node2 then this may cause a shard to be moved from node2 back to node1 to even things out. The cluster can be set to disable allocations using the `cluster.routing.allocation.enable` setting. If allocations are disabled then the only allocations that will be performed are explicit ones given using the reroute command, and consequent allocations due to rebalancing. The cluster will attempt to allocate a shard a maximum of `index.allocation.max_retries` times in a row (defaults to `5`), before giving up and leaving the shard unallocated. This scenario can be caused by structural problems such as having an analyzer which refers to a stopwords file which doesn’t exist on all nodes. Once the problem has been corrected, allocation can be manually retried by calling the reroute API with the `?retry_failed` URI query parameter, which will attempt a single retry round for these shards.
|
|
113
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-reroute | Elasticsearch API documentation}
|
|
113
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cluster-reroute | Elasticsearch API documentation}
|
|
114
114
|
*/
|
|
115
115
|
reroute(this: That, params?: T.ClusterRerouteRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ClusterRerouteResponse>;
|
|
116
116
|
reroute(this: That, params?: T.ClusterRerouteRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.ClusterRerouteResponse, unknown>>;
|
|
117
117
|
reroute(this: That, params?: T.ClusterRerouteRequest, options?: TransportRequestOptions): Promise<T.ClusterRerouteResponse>;
|
|
118
118
|
/**
|
|
119
119
|
* Get the cluster state. Get comprehensive information about the state of the cluster. The cluster state is an internal data structure which keeps track of a variety of information needed by every node, including the identity and attributes of the other nodes in the cluster; cluster-wide settings; index metadata, including the mapping and settings for each index; the location and status of every shard copy in the cluster. The elected master node ensures that every node in the cluster has a copy of the same cluster state. This API lets you retrieve a representation of this internal state for debugging or diagnostic purposes. You may need to consult the Elasticsearch source code to determine the precise meaning of the response. By default the API will route requests to the elected master node since this node is the authoritative source of cluster states. You can also retrieve the cluster state held on the node handling the API request by adding the `?local=true` query parameter. Elasticsearch may need to expend significant effort to compute a response to this API in larger clusters, and the response may comprise a very large quantity of data. If you use this API repeatedly, your cluster may become unstable. WARNING: The response is a representation of an internal data structure. Its format is not subject to the same compatibility guarantees as other more stable APIs and may change from version to version. Do not query this API using external monitoring tools. Instead, obtain the information you require using other more stable cluster APIs.
|
|
120
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-state | Elasticsearch API documentation}
|
|
120
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cluster-state | Elasticsearch API documentation}
|
|
121
121
|
*/
|
|
122
122
|
state(this: That, params?: T.ClusterStateRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ClusterStateResponse>;
|
|
123
123
|
state(this: That, params?: T.ClusterStateRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.ClusterStateResponse, unknown>>;
|
|
124
124
|
state(this: That, params?: T.ClusterStateRequest, options?: TransportRequestOptions): Promise<T.ClusterStateResponse>;
|
|
125
125
|
/**
|
|
126
126
|
* Get cluster statistics. Get basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins).
|
|
127
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-stats | Elasticsearch API documentation}
|
|
127
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cluster-stats | Elasticsearch API documentation}
|
|
128
128
|
*/
|
|
129
129
|
stats(this: That, params?: T.ClusterStatsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ClusterStatsResponse>;
|
|
130
130
|
stats(this: That, params?: T.ClusterStatsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.ClusterStatsResponse, unknown>>;
|
|
@@ -19,49 +19,49 @@ export default class Connector {
|
|
|
19
19
|
constructor(transport: Transport);
|
|
20
20
|
/**
|
|
21
21
|
* Check in a connector. Update the `last_seen` field in the connector and set it to the current timestamp.
|
|
22
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-check-in | Elasticsearch API documentation}
|
|
22
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-check-in | Elasticsearch API documentation}
|
|
23
23
|
*/
|
|
24
24
|
checkIn(this: That, params: T.ConnectorCheckInRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ConnectorCheckInResponse>;
|
|
25
25
|
checkIn(this: That, params: T.ConnectorCheckInRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.ConnectorCheckInResponse, unknown>>;
|
|
26
26
|
checkIn(this: That, params: T.ConnectorCheckInRequest, options?: TransportRequestOptions): Promise<T.ConnectorCheckInResponse>;
|
|
27
27
|
/**
|
|
28
28
|
* Delete a connector. Removes a connector and associated sync jobs. This is a destructive action that is not recoverable. NOTE: This action doesn’t delete any API keys, ingest pipelines, or data indices associated with the connector. These need to be removed manually.
|
|
29
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-delete | Elasticsearch API documentation}
|
|
29
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-delete | Elasticsearch API documentation}
|
|
30
30
|
*/
|
|
31
31
|
delete(this: That, params: T.ConnectorDeleteRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ConnectorDeleteResponse>;
|
|
32
32
|
delete(this: That, params: T.ConnectorDeleteRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.ConnectorDeleteResponse, unknown>>;
|
|
33
33
|
delete(this: That, params: T.ConnectorDeleteRequest, options?: TransportRequestOptions): Promise<T.ConnectorDeleteResponse>;
|
|
34
34
|
/**
|
|
35
35
|
* Get a connector. Get the details about a connector.
|
|
36
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-get | Elasticsearch API documentation}
|
|
36
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-get | Elasticsearch API documentation}
|
|
37
37
|
*/
|
|
38
38
|
get(this: That, params: T.ConnectorGetRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ConnectorGetResponse>;
|
|
39
39
|
get(this: That, params: T.ConnectorGetRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.ConnectorGetResponse, unknown>>;
|
|
40
40
|
get(this: That, params: T.ConnectorGetRequest, options?: TransportRequestOptions): Promise<T.ConnectorGetResponse>;
|
|
41
41
|
/**
|
|
42
42
|
* Update the connector last sync stats. Update the fields related to the last sync of a connector. This action is used for analytics and monitoring.
|
|
43
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-last-sync | Elasticsearch API documentation}
|
|
43
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-last-sync | Elasticsearch API documentation}
|
|
44
44
|
*/
|
|
45
45
|
lastSync(this: That, params: T.ConnectorLastSyncRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ConnectorLastSyncResponse>;
|
|
46
46
|
lastSync(this: That, params: T.ConnectorLastSyncRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.ConnectorLastSyncResponse, unknown>>;
|
|
47
47
|
lastSync(this: That, params: T.ConnectorLastSyncRequest, options?: TransportRequestOptions): Promise<T.ConnectorLastSyncResponse>;
|
|
48
48
|
/**
|
|
49
49
|
* Get all connectors. Get information about all connectors.
|
|
50
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-list | Elasticsearch API documentation}
|
|
50
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-list | Elasticsearch API documentation}
|
|
51
51
|
*/
|
|
52
52
|
list(this: That, params?: T.ConnectorListRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ConnectorListResponse>;
|
|
53
53
|
list(this: That, params?: T.ConnectorListRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.ConnectorListResponse, unknown>>;
|
|
54
54
|
list(this: That, params?: T.ConnectorListRequest, options?: TransportRequestOptions): Promise<T.ConnectorListResponse>;
|
|
55
55
|
/**
|
|
56
56
|
* Create a connector. Connectors are Elasticsearch integrations that bring content from third-party data sources, which can be deployed on Elastic Cloud or hosted on your own infrastructure. Elastic managed connectors (Native connectors) are a managed service on Elastic Cloud. Self-managed connectors (Connector clients) are self-managed on your infrastructure.
|
|
57
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-put | Elasticsearch API documentation}
|
|
57
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-put | Elasticsearch API documentation}
|
|
58
58
|
*/
|
|
59
59
|
post(this: That, params?: T.ConnectorPostRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ConnectorPostResponse>;
|
|
60
60
|
post(this: That, params?: T.ConnectorPostRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.ConnectorPostResponse, unknown>>;
|
|
61
61
|
post(this: That, params?: T.ConnectorPostRequest, options?: TransportRequestOptions): Promise<T.ConnectorPostResponse>;
|
|
62
62
|
/**
|
|
63
63
|
* Create or update a connector.
|
|
64
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-put | Elasticsearch API documentation}
|
|
64
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-put | Elasticsearch API documentation}
|
|
65
65
|
*/
|
|
66
66
|
put(this: That, params?: T.ConnectorPutRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ConnectorPutResponse>;
|
|
67
67
|
put(this: That, params?: T.ConnectorPutRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.ConnectorPutResponse, unknown>>;
|
|
@@ -92,161 +92,161 @@ export default class Connector {
|
|
|
92
92
|
secretPut(this: That, params: T.ConnectorSecretPutRequest, options?: TransportRequestOptions): Promise<T.ConnectorSecretPutResponse>;
|
|
93
93
|
/**
|
|
94
94
|
* Cancel a connector sync job. Cancel a connector sync job, which sets the status to cancelling and updates `cancellation_requested_at` to the current time. The connector service is then responsible for setting the status of connector sync jobs to cancelled.
|
|
95
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-cancel | Elasticsearch API documentation}
|
|
95
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-sync-job-cancel | Elasticsearch API documentation}
|
|
96
96
|
*/
|
|
97
97
|
syncJobCancel(this: That, params: T.ConnectorSyncJobCancelRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ConnectorSyncJobCancelResponse>;
|
|
98
98
|
syncJobCancel(this: That, params: T.ConnectorSyncJobCancelRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.ConnectorSyncJobCancelResponse, unknown>>;
|
|
99
99
|
syncJobCancel(this: That, params: T.ConnectorSyncJobCancelRequest, options?: TransportRequestOptions): Promise<T.ConnectorSyncJobCancelResponse>;
|
|
100
100
|
/**
|
|
101
101
|
* Check in a connector sync job. Check in a connector sync job and set the `last_seen` field to the current time before updating it in the internal index. To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure. This service runs automatically on Elastic Cloud for Elastic managed connectors.
|
|
102
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-check-in | Elasticsearch API documentation}
|
|
102
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-sync-job-check-in | Elasticsearch API documentation}
|
|
103
103
|
*/
|
|
104
104
|
syncJobCheckIn(this: That, params: T.ConnectorSyncJobCheckInRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ConnectorSyncJobCheckInResponse>;
|
|
105
105
|
syncJobCheckIn(this: That, params: T.ConnectorSyncJobCheckInRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.ConnectorSyncJobCheckInResponse, unknown>>;
|
|
106
106
|
syncJobCheckIn(this: That, params: T.ConnectorSyncJobCheckInRequest, options?: TransportRequestOptions): Promise<T.ConnectorSyncJobCheckInResponse>;
|
|
107
107
|
/**
|
|
108
108
|
* Claim a connector sync job. This action updates the job status to `in_progress` and sets the `last_seen` and `started_at` timestamps to the current time. Additionally, it can set the `sync_cursor` property for the sync job. This API is not intended for direct connector management by users. It supports the implementation of services that utilize the connector protocol to communicate with Elasticsearch. To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure. This service runs automatically on Elastic Cloud for Elastic managed connectors.
|
|
109
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-claim | Elasticsearch API documentation}
|
|
109
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-sync-job-claim | Elasticsearch API documentation}
|
|
110
110
|
*/
|
|
111
111
|
syncJobClaim(this: That, params: T.ConnectorSyncJobClaimRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ConnectorSyncJobClaimResponse>;
|
|
112
112
|
syncJobClaim(this: That, params: T.ConnectorSyncJobClaimRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.ConnectorSyncJobClaimResponse, unknown>>;
|
|
113
113
|
syncJobClaim(this: That, params: T.ConnectorSyncJobClaimRequest, options?: TransportRequestOptions): Promise<T.ConnectorSyncJobClaimResponse>;
|
|
114
114
|
/**
|
|
115
115
|
* Delete a connector sync job. Remove a connector sync job and its associated data. This is a destructive action that is not recoverable.
|
|
116
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-delete | Elasticsearch API documentation}
|
|
116
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-sync-job-delete | Elasticsearch API documentation}
|
|
117
117
|
*/
|
|
118
118
|
syncJobDelete(this: That, params: T.ConnectorSyncJobDeleteRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ConnectorSyncJobDeleteResponse>;
|
|
119
119
|
syncJobDelete(this: That, params: T.ConnectorSyncJobDeleteRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.ConnectorSyncJobDeleteResponse, unknown>>;
|
|
120
120
|
syncJobDelete(this: That, params: T.ConnectorSyncJobDeleteRequest, options?: TransportRequestOptions): Promise<T.ConnectorSyncJobDeleteResponse>;
|
|
121
121
|
/**
|
|
122
122
|
* Set a connector sync job error. Set the `error` field for a connector sync job and set its `status` to `error`. To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure. This service runs automatically on Elastic Cloud for Elastic managed connectors.
|
|
123
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-error | Elasticsearch API documentation}
|
|
123
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-sync-job-error | Elasticsearch API documentation}
|
|
124
124
|
*/
|
|
125
125
|
syncJobError(this: That, params: T.ConnectorSyncJobErrorRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ConnectorSyncJobErrorResponse>;
|
|
126
126
|
syncJobError(this: That, params: T.ConnectorSyncJobErrorRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.ConnectorSyncJobErrorResponse, unknown>>;
|
|
127
127
|
syncJobError(this: That, params: T.ConnectorSyncJobErrorRequest, options?: TransportRequestOptions): Promise<T.ConnectorSyncJobErrorResponse>;
|
|
128
128
|
/**
|
|
129
129
|
* Get a connector sync job.
|
|
130
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-get | Elasticsearch API documentation}
|
|
130
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-sync-job-get | Elasticsearch API documentation}
|
|
131
131
|
*/
|
|
132
132
|
syncJobGet(this: That, params: T.ConnectorSyncJobGetRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ConnectorSyncJobGetResponse>;
|
|
133
133
|
syncJobGet(this: That, params: T.ConnectorSyncJobGetRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.ConnectorSyncJobGetResponse, unknown>>;
|
|
134
134
|
syncJobGet(this: That, params: T.ConnectorSyncJobGetRequest, options?: TransportRequestOptions): Promise<T.ConnectorSyncJobGetResponse>;
|
|
135
135
|
/**
|
|
136
136
|
* Get all connector sync jobs. Get information about all stored connector sync jobs listed by their creation date in ascending order.
|
|
137
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-list | Elasticsearch API documentation}
|
|
137
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-sync-job-list | Elasticsearch API documentation}
|
|
138
138
|
*/
|
|
139
139
|
syncJobList(this: That, params?: T.ConnectorSyncJobListRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ConnectorSyncJobListResponse>;
|
|
140
140
|
syncJobList(this: That, params?: T.ConnectorSyncJobListRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.ConnectorSyncJobListResponse, unknown>>;
|
|
141
141
|
syncJobList(this: That, params?: T.ConnectorSyncJobListRequest, options?: TransportRequestOptions): Promise<T.ConnectorSyncJobListResponse>;
|
|
142
142
|
/**
|
|
143
143
|
* Create a connector sync job. Create a connector sync job document in the internal index and initialize its counters and timestamps with default values.
|
|
144
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-post | Elasticsearch API documentation}
|
|
144
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-sync-job-post | Elasticsearch API documentation}
|
|
145
145
|
*/
|
|
146
146
|
syncJobPost(this: That, params: T.ConnectorSyncJobPostRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ConnectorSyncJobPostResponse>;
|
|
147
147
|
syncJobPost(this: That, params: T.ConnectorSyncJobPostRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.ConnectorSyncJobPostResponse, unknown>>;
|
|
148
148
|
syncJobPost(this: That, params: T.ConnectorSyncJobPostRequest, options?: TransportRequestOptions): Promise<T.ConnectorSyncJobPostResponse>;
|
|
149
149
|
/**
|
|
150
150
|
* Set the connector sync job stats. Stats include: `deleted_document_count`, `indexed_document_count`, `indexed_document_volume`, and `total_document_count`. You can also update `last_seen`. This API is mainly used by the connector service for updating sync job information. To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure. This service runs automatically on Elastic Cloud for Elastic managed connectors.
|
|
151
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-update-stats | Elasticsearch API documentation}
|
|
151
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-sync-job-update-stats | Elasticsearch API documentation}
|
|
152
152
|
*/
|
|
153
153
|
syncJobUpdateStats(this: That, params: T.ConnectorSyncJobUpdateStatsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ConnectorSyncJobUpdateStatsResponse>;
|
|
154
154
|
syncJobUpdateStats(this: That, params: T.ConnectorSyncJobUpdateStatsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.ConnectorSyncJobUpdateStatsResponse, unknown>>;
|
|
155
155
|
syncJobUpdateStats(this: That, params: T.ConnectorSyncJobUpdateStatsRequest, options?: TransportRequestOptions): Promise<T.ConnectorSyncJobUpdateStatsResponse>;
|
|
156
156
|
/**
|
|
157
157
|
* Activate the connector draft filter. Activates the valid draft filtering for a connector.
|
|
158
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-filtering | Elasticsearch API documentation}
|
|
158
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-filtering | Elasticsearch API documentation}
|
|
159
159
|
*/
|
|
160
160
|
updateActiveFiltering(this: That, params: T.ConnectorUpdateActiveFilteringRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ConnectorUpdateActiveFilteringResponse>;
|
|
161
161
|
updateActiveFiltering(this: That, params: T.ConnectorUpdateActiveFilteringRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.ConnectorUpdateActiveFilteringResponse, unknown>>;
|
|
162
162
|
updateActiveFiltering(this: That, params: T.ConnectorUpdateActiveFilteringRequest, options?: TransportRequestOptions): Promise<T.ConnectorUpdateActiveFilteringResponse>;
|
|
163
163
|
/**
|
|
164
164
|
* Update the connector API key ID. Update the `api_key_id` and `api_key_secret_id` fields of a connector. You can specify the ID of the API key used for authorization and the ID of the connector secret where the API key is stored. The connector secret ID is required only for Elastic managed (native) connectors. Self-managed connectors (connector clients) do not use this field.
|
|
165
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-api-key-id | Elasticsearch API documentation}
|
|
165
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-api-key-id | Elasticsearch API documentation}
|
|
166
166
|
*/
|
|
167
167
|
updateApiKeyId(this: That, params: T.ConnectorUpdateApiKeyIdRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ConnectorUpdateApiKeyIdResponse>;
|
|
168
168
|
updateApiKeyId(this: That, params: T.ConnectorUpdateApiKeyIdRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.ConnectorUpdateApiKeyIdResponse, unknown>>;
|
|
169
169
|
updateApiKeyId(this: That, params: T.ConnectorUpdateApiKeyIdRequest, options?: TransportRequestOptions): Promise<T.ConnectorUpdateApiKeyIdResponse>;
|
|
170
170
|
/**
|
|
171
171
|
* Update the connector configuration. Update the configuration field in the connector document.
|
|
172
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-configuration | Elasticsearch API documentation}
|
|
172
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-configuration | Elasticsearch API documentation}
|
|
173
173
|
*/
|
|
174
174
|
updateConfiguration(this: That, params: T.ConnectorUpdateConfigurationRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ConnectorUpdateConfigurationResponse>;
|
|
175
175
|
updateConfiguration(this: That, params: T.ConnectorUpdateConfigurationRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.ConnectorUpdateConfigurationResponse, unknown>>;
|
|
176
176
|
updateConfiguration(this: That, params: T.ConnectorUpdateConfigurationRequest, options?: TransportRequestOptions): Promise<T.ConnectorUpdateConfigurationResponse>;
|
|
177
177
|
/**
|
|
178
178
|
* Update the connector error field. Set the error field for the connector. If the error provided in the request body is non-null, the connector’s status is updated to error. Otherwise, if the error is reset to null, the connector status is updated to connected.
|
|
179
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-error | Elasticsearch API documentation}
|
|
179
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-error | Elasticsearch API documentation}
|
|
180
180
|
*/
|
|
181
181
|
updateError(this: That, params: T.ConnectorUpdateErrorRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ConnectorUpdateErrorResponse>;
|
|
182
182
|
updateError(this: That, params: T.ConnectorUpdateErrorRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.ConnectorUpdateErrorResponse, unknown>>;
|
|
183
183
|
updateError(this: That, params: T.ConnectorUpdateErrorRequest, options?: TransportRequestOptions): Promise<T.ConnectorUpdateErrorResponse>;
|
|
184
184
|
/**
|
|
185
185
|
* Update the connector features. Update the connector features in the connector document. This API can be used to control the following aspects of a connector: * document-level security * incremental syncs * advanced sync rules * basic sync rules Normally, the running connector service automatically manages these features. However, you can use this API to override the default behavior. To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure. This service runs automatically on Elastic Cloud for Elastic managed connectors.
|
|
186
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-features | Elasticsearch API documentation}
|
|
186
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-features | Elasticsearch API documentation}
|
|
187
187
|
*/
|
|
188
188
|
updateFeatures(this: That, params: T.ConnectorUpdateFeaturesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ConnectorUpdateFeaturesResponse>;
|
|
189
189
|
updateFeatures(this: That, params: T.ConnectorUpdateFeaturesRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.ConnectorUpdateFeaturesResponse, unknown>>;
|
|
190
190
|
updateFeatures(this: That, params: T.ConnectorUpdateFeaturesRequest, options?: TransportRequestOptions): Promise<T.ConnectorUpdateFeaturesResponse>;
|
|
191
191
|
/**
|
|
192
192
|
* Update the connector filtering. Update the draft filtering configuration of a connector and marks the draft validation state as edited. The filtering draft is activated once validated by the running Elastic connector service. The filtering property is used to configure sync rules (both basic and advanced) for a connector.
|
|
193
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-filtering | Elasticsearch API documentation}
|
|
193
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-filtering | Elasticsearch API documentation}
|
|
194
194
|
*/
|
|
195
195
|
updateFiltering(this: That, params: T.ConnectorUpdateFilteringRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ConnectorUpdateFilteringResponse>;
|
|
196
196
|
updateFiltering(this: That, params: T.ConnectorUpdateFilteringRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.ConnectorUpdateFilteringResponse, unknown>>;
|
|
197
197
|
updateFiltering(this: That, params: T.ConnectorUpdateFilteringRequest, options?: TransportRequestOptions): Promise<T.ConnectorUpdateFilteringResponse>;
|
|
198
198
|
/**
|
|
199
199
|
* Update the connector draft filtering validation. Update the draft filtering validation info for a connector.
|
|
200
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-filtering-validation | Elasticsearch API documentation}
|
|
200
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-filtering-validation | Elasticsearch API documentation}
|
|
201
201
|
*/
|
|
202
202
|
updateFilteringValidation(this: That, params: T.ConnectorUpdateFilteringValidationRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ConnectorUpdateFilteringValidationResponse>;
|
|
203
203
|
updateFilteringValidation(this: That, params: T.ConnectorUpdateFilteringValidationRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.ConnectorUpdateFilteringValidationResponse, unknown>>;
|
|
204
204
|
updateFilteringValidation(this: That, params: T.ConnectorUpdateFilteringValidationRequest, options?: TransportRequestOptions): Promise<T.ConnectorUpdateFilteringValidationResponse>;
|
|
205
205
|
/**
|
|
206
206
|
* Update the connector index name. Update the `index_name` field of a connector, specifying the index where the data ingested by the connector is stored.
|
|
207
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-index-name | Elasticsearch API documentation}
|
|
207
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-index-name | Elasticsearch API documentation}
|
|
208
208
|
*/
|
|
209
209
|
updateIndexName(this: That, params: T.ConnectorUpdateIndexNameRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ConnectorUpdateIndexNameResponse>;
|
|
210
210
|
updateIndexName(this: That, params: T.ConnectorUpdateIndexNameRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.ConnectorUpdateIndexNameResponse, unknown>>;
|
|
211
211
|
updateIndexName(this: That, params: T.ConnectorUpdateIndexNameRequest, options?: TransportRequestOptions): Promise<T.ConnectorUpdateIndexNameResponse>;
|
|
212
212
|
/**
|
|
213
213
|
* Update the connector name and description.
|
|
214
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-name | Elasticsearch API documentation}
|
|
214
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-name | Elasticsearch API documentation}
|
|
215
215
|
*/
|
|
216
216
|
updateName(this: That, params: T.ConnectorUpdateNameRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ConnectorUpdateNameResponse>;
|
|
217
217
|
updateName(this: That, params: T.ConnectorUpdateNameRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.ConnectorUpdateNameResponse, unknown>>;
|
|
218
218
|
updateName(this: That, params: T.ConnectorUpdateNameRequest, options?: TransportRequestOptions): Promise<T.ConnectorUpdateNameResponse>;
|
|
219
219
|
/**
|
|
220
220
|
* Update the connector is_native flag.
|
|
221
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-native | Elasticsearch API documentation}
|
|
221
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-native | Elasticsearch API documentation}
|
|
222
222
|
*/
|
|
223
223
|
updateNative(this: That, params: T.ConnectorUpdateNativeRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ConnectorUpdateNativeResponse>;
|
|
224
224
|
updateNative(this: That, params: T.ConnectorUpdateNativeRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.ConnectorUpdateNativeResponse, unknown>>;
|
|
225
225
|
updateNative(this: That, params: T.ConnectorUpdateNativeRequest, options?: TransportRequestOptions): Promise<T.ConnectorUpdateNativeResponse>;
|
|
226
226
|
/**
|
|
227
227
|
* Update the connector pipeline. When you create a new connector, the configuration of an ingest pipeline is populated with default settings.
|
|
228
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-pipeline | Elasticsearch API documentation}
|
|
228
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-pipeline | Elasticsearch API documentation}
|
|
229
229
|
*/
|
|
230
230
|
updatePipeline(this: That, params: T.ConnectorUpdatePipelineRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ConnectorUpdatePipelineResponse>;
|
|
231
231
|
updatePipeline(this: That, params: T.ConnectorUpdatePipelineRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.ConnectorUpdatePipelineResponse, unknown>>;
|
|
232
232
|
updatePipeline(this: That, params: T.ConnectorUpdatePipelineRequest, options?: TransportRequestOptions): Promise<T.ConnectorUpdatePipelineResponse>;
|
|
233
233
|
/**
|
|
234
234
|
* Update the connector scheduling.
|
|
235
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-scheduling | Elasticsearch API documentation}
|
|
235
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-scheduling | Elasticsearch API documentation}
|
|
236
236
|
*/
|
|
237
237
|
updateScheduling(this: That, params: T.ConnectorUpdateSchedulingRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ConnectorUpdateSchedulingResponse>;
|
|
238
238
|
updateScheduling(this: That, params: T.ConnectorUpdateSchedulingRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.ConnectorUpdateSchedulingResponse, unknown>>;
|
|
239
239
|
updateScheduling(this: That, params: T.ConnectorUpdateSchedulingRequest, options?: TransportRequestOptions): Promise<T.ConnectorUpdateSchedulingResponse>;
|
|
240
240
|
/**
|
|
241
241
|
* Update the connector service type.
|
|
242
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-service-type | Elasticsearch API documentation}
|
|
242
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-service-type | Elasticsearch API documentation}
|
|
243
243
|
*/
|
|
244
244
|
updateServiceType(this: That, params: T.ConnectorUpdateServiceTypeRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ConnectorUpdateServiceTypeResponse>;
|
|
245
245
|
updateServiceType(this: That, params: T.ConnectorUpdateServiceTypeRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.ConnectorUpdateServiceTypeResponse, unknown>>;
|
|
246
246
|
updateServiceType(this: That, params: T.ConnectorUpdateServiceTypeRequest, options?: TransportRequestOptions): Promise<T.ConnectorUpdateServiceTypeResponse>;
|
|
247
247
|
/**
|
|
248
248
|
* Update the connector status.
|
|
249
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-status | Elasticsearch API documentation}
|
|
249
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-status | Elasticsearch API documentation}
|
|
250
250
|
*/
|
|
251
251
|
updateStatus(this: That, params: T.ConnectorUpdateStatusRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ConnectorUpdateStatusResponse>;
|
|
252
252
|
updateStatus(this: That, params: T.ConnectorUpdateStatusRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.ConnectorUpdateStatusResponse, unknown>>;
|
package/lib/api/api/count.d.ts
CHANGED
|
@@ -5,7 +5,7 @@ interface That {
|
|
|
5
5
|
}
|
|
6
6
|
/**
|
|
7
7
|
* Count search results. Get the number of documents matching a query. The query can be provided either by using a simple query string as a parameter, or by defining Query DSL within the request body. The query is optional. When no query is provided, the API uses `match_all` to count all the documents. The count API supports multi-target syntax. You can run a single count API search across multiple data streams and indices. The operation is broadcast across all shards. For each shard ID group, a replica is chosen and the search is run against it. This means that replicas increase the scalability of the count.
|
|
8
|
-
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-count | Elasticsearch API documentation}
|
|
8
|
+
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-count | Elasticsearch API documentation}
|
|
9
9
|
*/
|
|
10
10
|
export default function CountApi(this: That, params?: T.CountRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CountResponse>;
|
|
11
11
|
export default function CountApi(this: That, params?: T.CountRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.CountResponse, unknown>>;
|