habsi/elasticsearch-js
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Auto-generated API code (#2808)

Browse Source
This commit is contained in:
Elastic Machine
2025-04-28 17:41:15 +02:00
committed by GitHub
parent e8b4183b8b
commit acdb0d6162
7 changed files with 48 additions and 48 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
docs/reference.asciidoc
View File

@ -3782,7 +3782,7 @@ If no response is received before the timeout expires, the request fails and ret
Clear cluster voting config exclusions. Clear cluster voting config exclusions.
Remove master-eligible nodes from the voting configuration exclusion list. Remove master-eligible nodes from the voting configuration exclusion list.
{ref}/voting-config-exclusions.html[Endpoint documentation] https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-cluster-post-voting-config-exclusions[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.cluster.deleteVotingConfigExclusions({ ... }) client.cluster.deleteVotingConfigExclusions({ ... })
@ -3967,7 +3967,7 @@ 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. 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. They are not required when removing master-ineligible nodes or when removing fewer than half of the master-eligible nodes.
{ref}/voting-config-exclusions.html[Endpoint documentation] https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-cluster-post-voting-config-exclusions[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.cluster.postVotingConfigExclusions({ ... }) client.cluster.postVotingConfigExclusions({ ... })
@ -9069,7 +9069,7 @@ You must then re-submit the API request with the acknowledge parameter set to tr
NOTE: If Elasticsearch security features are enabled and you are installing a gold or higher license, you must enable TLS on the transport networking layer before you install the license. NOTE: If Elasticsearch security features are enabled and you are installing a gold or higher license, you must enable TLS on the transport networking layer before you install the license.
If the operator privileges feature is enabled, only operator users can use this API. If the operator privileges feature is enabled, only operator users can use this API.
{ref}/update-license.html[Endpoint documentation] https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-license-post[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.license.post({ ... }) client.license.post({ ... })
@ -9852,7 +9852,7 @@ be retrieved and then added to another cluster.
[discrete] [discrete]
==== get_data_frame_analytics_stats ==== get_data_frame_analytics_stats
Get data frame analytics jobs usage info. Get data frame analytics job stats.
{ref}/get-dfanalytics-stats.html[Endpoint documentation] {ref}/get-dfanalytics-stats.html[Endpoint documentation]
[source,ts] [source,ts]
@ -9884,7 +9884,7 @@ there are no matches or only partial matches.
[discrete] [discrete]
==== get_datafeed_stats ==== get_datafeed_stats
Get datafeeds usage info. Get datafeed stats.
You can get statistics for multiple datafeeds in a single API request by You can get statistics for multiple datafeeds in a single API request by
using a list of datafeeds or a wildcard expression. You can using a list of datafeeds or a wildcard expression. You can
get statistics for all datafeeds by using `_all`, by specifying `*` as the get statistics for all datafeeds by using `_all`, by specifying `*` as the
@ -10008,7 +10008,7 @@ means it is unset and results are not limited to specific timestamps.
[discrete] [discrete]
==== get_job_stats ==== get_job_stats
Get anomaly detection jobs usage info. Get anomaly detection job stats.
{ref}/ml-get-job-stats.html[Endpoint documentation] {ref}/ml-get-job-stats.html[Endpoint documentation]
[source,ts] [source,ts]
@ -11103,7 +11103,7 @@ restart the model deployment.
==== update_data_frame_analytics ==== update_data_frame_analytics
Update a data frame analytics job. Update a data frame analytics job.
{ref}/update-dfanalytics.html[Endpoint documentation] https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-ml-update-data-frame-analytics[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.ml.updateDataFrameAnalytics({ id }) client.ml.updateDataFrameAnalytics({ id })
@ -11314,7 +11314,7 @@ snapshot will be deleted when the job is deleted.
==== update_trained_model_deployment ==== update_trained_model_deployment
Update a trained model deployment. Update a trained model deployment.
{ref}/update-trained-model-deployment.html[Endpoint documentation] https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-ml-update-trained-model-deployment[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.ml.updateTrainedModelDeployment({ model_id }) client.ml.updateTrainedModelDeployment({ model_id })
@ -16060,7 +16060,7 @@ privileges for the source indices. You must also have `index` and `read` privile
Elasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the 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. time of update and runs with those privileges.
{ref}/update-transform.html[Endpoint documentation] https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-transform-update-transform[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.transform.updateTransform({ transform_id }) client.transform.updateTransform({ transform_id })
@ -16107,7 +16107,7 @@ 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. 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. You may want to perform a recent cluster backup prior to the upgrade.
{ref}/upgrade-transforms.html[Endpoint documentation] https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-transform-upgrade-transforms[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.transform.upgradeTransforms({ ... }) client.transform.upgradeTransforms({ ... })
@ -16136,7 +16136,7 @@ The reason for this behavior is to prevent overwriting the watch status from a w
Acknowledging an action throttles further executions of that action until its `ack.state` is reset to `awaits_successful_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). This happens when the condition of the watch is not met (the condition evaluates to false).
{ref}/watcher-api-ack-watch.html[Endpoint documentation] https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-ack-watch[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.watcher.ackWatch({ watch_id }) client.watcher.ackWatch({ watch_id })
@ -16155,7 +16155,7 @@ If you omit this parameter, all of the actions of the watch are acknowledged.
Activate a watch. Activate a watch.
A watch can be either active or inactive. A watch can be either active or inactive.
{ref}/watcher-api-activate-watch.html[Endpoint documentation] https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-activate-watch[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.watcher.activateWatch({ watch_id }) client.watcher.activateWatch({ watch_id })
@ -16172,7 +16172,7 @@ client.watcher.activateWatch({ watch_id })
Deactivate a watch. Deactivate a watch.
A watch can be either active or inactive. A watch can be either active or inactive.
{ref}/watcher-api-deactivate-watch.html[Endpoint documentation] https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-deactivate-watch[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.watcher.deactivateWatch({ watch_id }) client.watcher.deactivateWatch({ watch_id })
@ -16195,7 +16195,7 @@ 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 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. When Elasticsearch security features are enabled, make sure no write privileges are granted to anyone for the `.watches` index.
{ref}/watcher-api-delete-watch.html[Endpoint documentation] https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-delete-watch[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.watcher.deleteWatch({ id }) client.watcher.deleteWatch({ id })
@ -16224,7 +16224,7 @@ If your user is allowed to read index `a`, but not index `b`, then the exact sam
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. 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.
{ref}/watcher-api-execute-watch.html[Endpoint documentation] https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-execute-watch[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.watcher.executeWatch({ ... }) client.watcher.executeWatch({ ... })
@ -16253,7 +16253,7 @@ Get Watcher index settings.
Get settings for the Watcher internal index (`.watches`). 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`. Only a subset of settings are shown, for example `index.auto_expand_replicas` and `index.number_of_replicas`.
{ref}/watcher-api-get-settings.html[Endpoint documentation] https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-get-settings[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.watcher.getSettings({ ... }) client.watcher.getSettings({ ... })
@ -16270,7 +16270,7 @@ If no response is received before the timeout expires, the request fails and ret
==== get_watch ==== get_watch
Get a watch. Get a watch.
{ref}/watcher-api-get-watch.html[Endpoint documentation] https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-get-watch[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.watcher.getWatch({ id }) client.watcher.getWatch({ id })
@ -16297,7 +16297,7 @@ When you add a watch you can also define its initial active state by setting the
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. 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. If the user is able to read index `a`, but not index `b`, the same will apply when the watch runs.
{ref}/watcher-api-put-watch.html[Endpoint documentation] https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-put-watch[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.watcher.putWatch({ id }) client.watcher.putWatch({ id })
@ -16332,7 +16332,7 @@ Get all registered watches in a paginated manner and optionally filter watches b
Note that only the `_id` and `metadata.*` fields are queryable or sortable. Note that only the `_id` and `metadata.*` fields are queryable or sortable.
{ref}/watcher-api-query-watches.html[Endpoint documentation] https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-query-watches[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.watcher.queryWatches({ ... }) client.watcher.queryWatches({ ... })
@ -16355,7 +16355,7 @@ It must be non-negative.
Start the watch service. Start the watch service.
Start the Watcher service if it is not already running. Start the Watcher service if it is not already running.
{ref}/watcher-api-start.html[Endpoint documentation] https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-start[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.watcher.start({ ... }) client.watcher.start({ ... })
@ -16373,7 +16373,7 @@ Get Watcher statistics.
This API always returns basic metrics. This API always returns basic metrics.
You retrieve more metrics by using the metric parameter. You retrieve more metrics by using the metric parameter.
{ref}/watcher-api-stats.html[Endpoint documentation] https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-stats[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.watcher.stats({ ... }) client.watcher.stats({ ... })
@ -16391,7 +16391,7 @@ client.watcher.stats({ ... })
Stop the watch service. Stop the watch service.
Stop the Watcher service if it is running. Stop the Watcher service if it is running.
{ref}/watcher-api-stop.html[Endpoint documentation] https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-stop[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.watcher.stop({ ... }) client.watcher.stop({ ... })
@ -16415,7 +16415,7 @@ This includes `index.auto_expand_replicas`, `index.number_of_replicas`, `index.r
Modification of `index.routing.allocation.include._tier_preference` is an exception and is not allowed as the 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. Watcher shards must always be in the `data_content` tier.
{ref}/watcher-api-update-settings.html[Endpoint documentation] https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-update-settings[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.watcher.updateSettings({ ... }) client.watcher.updateSettings({ ... })
@ -16465,7 +16465,7 @@ Get usage information.
Get information about the features that are currently enabled and available under the current license. Get information about the features that are currently enabled and available under the current license.
The API also provides some usage statistics. The API also provides some usage statistics.
{ref}/usage-api.html[Endpoint documentation] https://www.elastic.co/docs/api/doc/elasticsearch/v8/group/endpoint-xpack[Endpoint documentation]
[source,ts] [source,ts]
---- ----
client.xpack.usage({ ... }) client.xpack.usage({ ... })

4
src/api/api/cluster.ts
View File

@ -120,7 +120,7 @@ export default class Cluster {
/** /**
* Clear cluster voting config exclusions. Remove master-eligible nodes from the voting configuration exclusion list. * Clear cluster voting config exclusions. Remove master-eligible nodes from the voting configuration exclusion list.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.18/voting-config-exclusions.html | Elasticsearch API documentation} * @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-cluster-post-voting-config-exclusions | Elasticsearch API documentation}
*/ */
async deleteVotingConfigExclusions (this: That, params?: T.ClusterDeleteVotingConfigExclusionsRequest | TB.ClusterDeleteVotingConfigExclusionsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ClusterDeleteVotingConfigExclusionsResponse> async deleteVotingConfigExclusions (this: That, params?: T.ClusterDeleteVotingConfigExclusionsRequest | TB.ClusterDeleteVotingConfigExclusionsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ClusterDeleteVotingConfigExclusionsResponse>
async deleteVotingConfigExclusions (this: That, params?: T.ClusterDeleteVotingConfigExclusionsRequest | TB.ClusterDeleteVotingConfigExclusionsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.ClusterDeleteVotingConfigExclusionsResponse, unknown>> async deleteVotingConfigExclusions (this: That, params?: T.ClusterDeleteVotingConfigExclusionsRequest | TB.ClusterDeleteVotingConfigExclusionsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.ClusterDeleteVotingConfigExclusionsResponse, unknown>>
@ -354,7 +354,7 @@ export default class Cluster {
/** /**
* 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. * 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.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.18/voting-config-exclusions.html | Elasticsearch API documentation} * @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-cluster-post-voting-config-exclusions | Elasticsearch API documentation}
*/ */
async postVotingConfigExclusions (this: That, params?: T.ClusterPostVotingConfigExclusionsRequest | TB.ClusterPostVotingConfigExclusionsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ClusterPostVotingConfigExclusionsResponse> async postVotingConfigExclusions (this: That, params?: T.ClusterPostVotingConfigExclusionsRequest | TB.ClusterPostVotingConfigExclusionsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ClusterPostVotingConfigExclusionsResponse>
async postVotingConfigExclusions (this: That, params?: T.ClusterPostVotingConfigExclusionsRequest | TB.ClusterPostVotingConfigExclusionsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.ClusterPostVotingConfigExclusionsResponse, unknown>> async postVotingConfigExclusions (this: That, params?: T.ClusterPostVotingConfigExclusionsRequest | TB.ClusterPostVotingConfigExclusionsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.ClusterPostVotingConfigExclusionsResponse, unknown>>

2
src/api/api/license.ts
View File

@ -166,7 +166,7 @@ export default class License {
/** /**
* Update the license. You can update your license at runtime without shutting down your nodes. License updates take effect immediately. If the license you are installing does not support all of the features that were available with your previous license, however, you are notified in the response. You must then re-submit the API request with the acknowledge parameter set to true. NOTE: If Elasticsearch security features are enabled and you are installing a gold or higher license, you must enable TLS on the transport networking layer before you install the license. If the operator privileges feature is enabled, only operator users can use this API. * Update the license. You can update your license at runtime without shutting down your nodes. License updates take effect immediately. If the license you are installing does not support all of the features that were available with your previous license, however, you are notified in the response. You must then re-submit the API request with the acknowledge parameter set to true. NOTE: If Elasticsearch security features are enabled and you are installing a gold or higher license, you must enable TLS on the transport networking layer before you install the license. If the operator privileges feature is enabled, only operator users can use this API.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.18/update-license.html | Elasticsearch API documentation} * @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-license-post | Elasticsearch API documentation}
*/ */
async post (this: That, params?: T.LicensePostRequest | TB.LicensePostRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.LicensePostResponse> async post (this: That, params?: T.LicensePostRequest | TB.LicensePostRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.LicensePostResponse>
async post (this: That, params?: T.LicensePostRequest | TB.LicensePostRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.LicensePostResponse, unknown>> async post (this: That, params?: T.LicensePostRequest | TB.LicensePostRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.LicensePostResponse, unknown>>

10
src/api/api/ml.ts
View File

@ -988,7 +988,7 @@ export default class Ml {
} }
/** /**
* Get data frame analytics jobs usage info. * Get data frame analytics job stats.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.18/get-dfanalytics-stats.html | Elasticsearch API documentation} * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.18/get-dfanalytics-stats.html | Elasticsearch API documentation}
*/ */
async getDataFrameAnalyticsStats (this: That, params?: T.MlGetDataFrameAnalyticsStatsRequest | TB.MlGetDataFrameAnalyticsStatsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlGetDataFrameAnalyticsStatsResponse> async getDataFrameAnalyticsStats (this: That, params?: T.MlGetDataFrameAnalyticsStatsRequest | TB.MlGetDataFrameAnalyticsStatsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlGetDataFrameAnalyticsStatsResponse>
@ -1028,7 +1028,7 @@ export default class Ml {
} }
/** /**
* Get datafeeds usage info. You can get statistics for multiple datafeeds in a single API request by using a comma-separated list of datafeeds or a wildcard expression. You can get statistics for all datafeeds by using `_all`, by specifying `*` as the `<feed_id>`, or by omitting the `<feed_id>`. If the datafeed is stopped, the only information you receive is the `datafeed_id` and the `state`. This API returns a maximum of 10,000 datafeeds. * Get datafeed stats. You can get statistics for multiple datafeeds in a single API request by using a comma-separated list of datafeeds or a wildcard expression. You can get statistics for all datafeeds by using `_all`, by specifying `*` as the `<feed_id>`, or by omitting the `<feed_id>`. If the datafeed is stopped, the only information you receive is the `datafeed_id` and the `state`. This API returns a maximum of 10,000 datafeeds.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.18/ml-get-datafeed-stats.html | Elasticsearch API documentation} * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.18/ml-get-datafeed-stats.html | Elasticsearch API documentation}
*/ */
async getDatafeedStats (this: That, params?: T.MlGetDatafeedStatsRequest | TB.MlGetDatafeedStatsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlGetDatafeedStatsResponse> async getDatafeedStats (this: That, params?: T.MlGetDatafeedStatsRequest | TB.MlGetDatafeedStatsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlGetDatafeedStatsResponse>
@ -1192,7 +1192,7 @@ export default class Ml {
} }
/** /**
* Get anomaly detection jobs usage info. * Get anomaly detection job stats.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.18/ml-get-job-stats.html | Elasticsearch API documentation} * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.18/ml-get-job-stats.html | Elasticsearch API documentation}
*/ */
async getJobStats (this: That, params?: T.MlGetJobStatsRequest | TB.MlGetJobStatsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlGetJobStatsResponse> async getJobStats (this: That, params?: T.MlGetJobStatsRequest | TB.MlGetJobStatsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlGetJobStatsResponse>
@ -2623,7 +2623,7 @@ export default class Ml {
/** /**
* Update a data frame analytics job. * Update a data frame analytics job.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.18/update-dfanalytics.html | Elasticsearch API documentation} * @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-ml-update-data-frame-analytics | Elasticsearch API documentation}
*/ */
async updateDataFrameAnalytics (this: That, params: T.MlUpdateDataFrameAnalyticsRequest | TB.MlUpdateDataFrameAnalyticsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlUpdateDataFrameAnalyticsResponse> async updateDataFrameAnalytics (this: That, params: T.MlUpdateDataFrameAnalyticsRequest | TB.MlUpdateDataFrameAnalyticsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlUpdateDataFrameAnalyticsResponse>
async updateDataFrameAnalytics (this: That, params: T.MlUpdateDataFrameAnalyticsRequest | TB.MlUpdateDataFrameAnalyticsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MlUpdateDataFrameAnalyticsResponse, unknown>> async updateDataFrameAnalytics (this: That, params: T.MlUpdateDataFrameAnalyticsRequest | TB.MlUpdateDataFrameAnalyticsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MlUpdateDataFrameAnalyticsResponse, unknown>>
@ -2844,7 +2844,7 @@ export default class Ml {
/** /**
* Update a trained model deployment. * Update a trained model deployment.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.18/update-trained-model-deployment.html | Elasticsearch API documentation} * @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-ml-update-trained-model-deployment | Elasticsearch API documentation}
*/ */
async updateTrainedModelDeployment (this: That, params: T.MlUpdateTrainedModelDeploymentRequest | TB.MlUpdateTrainedModelDeploymentRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlUpdateTrainedModelDeploymentResponse> async updateTrainedModelDeployment (this: That, params: T.MlUpdateTrainedModelDeploymentRequest | TB.MlUpdateTrainedModelDeploymentRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlUpdateTrainedModelDeploymentResponse>
async updateTrainedModelDeployment (this: That, params: T.MlUpdateTrainedModelDeploymentRequest | TB.MlUpdateTrainedModelDeploymentRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MlUpdateTrainedModelDeploymentResponse, unknown>> async updateTrainedModelDeployment (this: That, params: T.MlUpdateTrainedModelDeploymentRequest | TB.MlUpdateTrainedModelDeploymentRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MlUpdateTrainedModelDeploymentResponse, unknown>>

4
src/api/api/transform.ts
View File

@ -403,7 +403,7 @@ export default class Transform {
/** /**
* 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. * 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.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.18/update-transform.html | Elasticsearch API documentation} * @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-transform-update-transform | Elasticsearch API documentation}
*/ */
async updateTransform (this: That, params: T.TransformUpdateTransformRequest | TB.TransformUpdateTransformRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.TransformUpdateTransformResponse> async updateTransform (this: That, params: T.TransformUpdateTransformRequest | TB.TransformUpdateTransformRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.TransformUpdateTransformResponse>
async updateTransform (this: That, params: T.TransformUpdateTransformRequest | TB.TransformUpdateTransformRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TransformUpdateTransformResponse, unknown>> async updateTransform (this: That, params: T.TransformUpdateTransformRequest | TB.TransformUpdateTransformRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TransformUpdateTransformResponse, unknown>>
@ -447,7 +447,7 @@ export default class Transform {
/** /**
* 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. * 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.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.18/upgrade-transforms.html | Elasticsearch API documentation} * @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-transform-upgrade-transforms | Elasticsearch API documentation}
*/ */
async upgradeTransforms (this: That, params?: T.TransformUpgradeTransformsRequest | TB.TransformUpgradeTransformsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.TransformUpgradeTransformsResponse> async upgradeTransforms (this: That, params?: T.TransformUpgradeTransformsRequest | TB.TransformUpgradeTransformsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.TransformUpgradeTransformsResponse>
async upgradeTransforms (this: That, params?: T.TransformUpgradeTransformsRequest | TB.TransformUpgradeTransformsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TransformUpgradeTransformsResponse, unknown>> async upgradeTransforms (this: That, params?: T.TransformUpgradeTransformsRequest | TB.TransformUpgradeTransformsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TransformUpgradeTransformsResponse, unknown>>

26
src/api/api/watcher.ts
View File

@ -46,7 +46,7 @@ export default class Watcher {
/** /**
* 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). * 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).
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.18/watcher-api-ack-watch.html | Elasticsearch API documentation} * @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-ack-watch | Elasticsearch API documentation}
*/ */
async ackWatch (this: That, params: T.WatcherAckWatchRequest | TB.WatcherAckWatchRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.WatcherAckWatchResponse> async ackWatch (this: That, params: T.WatcherAckWatchRequest | TB.WatcherAckWatchRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.WatcherAckWatchResponse>
async ackWatch (this: That, params: T.WatcherAckWatchRequest | TB.WatcherAckWatchRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.WatcherAckWatchResponse, unknown>> async ackWatch (this: That, params: T.WatcherAckWatchRequest | TB.WatcherAckWatchRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.WatcherAckWatchResponse, unknown>>
@ -86,7 +86,7 @@ export default class Watcher {
/** /**
* Activate a watch. A watch can be either active or inactive. * Activate a watch. A watch can be either active or inactive.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.18/watcher-api-activate-watch.html | Elasticsearch API documentation} * @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-activate-watch | Elasticsearch API documentation}
*/ */
async activateWatch (this: That, params: T.WatcherActivateWatchRequest | TB.WatcherActivateWatchRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.WatcherActivateWatchResponse> async activateWatch (this: That, params: T.WatcherActivateWatchRequest | TB.WatcherActivateWatchRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.WatcherActivateWatchResponse>
async activateWatch (this: That, params: T.WatcherActivateWatchRequest | TB.WatcherActivateWatchRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.WatcherActivateWatchResponse, unknown>> async activateWatch (this: That, params: T.WatcherActivateWatchRequest | TB.WatcherActivateWatchRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.WatcherActivateWatchResponse, unknown>>
@ -118,7 +118,7 @@ export default class Watcher {
/** /**
* Deactivate a watch. A watch can be either active or inactive. * Deactivate a watch. A watch can be either active or inactive.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.18/watcher-api-deactivate-watch.html | Elasticsearch API documentation} * @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-deactivate-watch | Elasticsearch API documentation}
*/ */
async deactivateWatch (this: That, params: T.WatcherDeactivateWatchRequest | TB.WatcherDeactivateWatchRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.WatcherDeactivateWatchResponse> async deactivateWatch (this: That, params: T.WatcherDeactivateWatchRequest | TB.WatcherDeactivateWatchRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.WatcherDeactivateWatchResponse>
async deactivateWatch (this: That, params: T.WatcherDeactivateWatchRequest | TB.WatcherDeactivateWatchRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.WatcherDeactivateWatchResponse, unknown>> async deactivateWatch (this: That, params: T.WatcherDeactivateWatchRequest | TB.WatcherDeactivateWatchRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.WatcherDeactivateWatchResponse, unknown>>
@ -150,7 +150,7 @@ export default class Watcher {
/** /**
* 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. * 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.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.18/watcher-api-delete-watch.html | Elasticsearch API documentation} * @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-delete-watch | Elasticsearch API documentation}
*/ */
async deleteWatch (this: That, params: T.WatcherDeleteWatchRequest | TB.WatcherDeleteWatchRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.WatcherDeleteWatchResponse> async deleteWatch (this: That, params: T.WatcherDeleteWatchRequest | TB.WatcherDeleteWatchRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.WatcherDeleteWatchResponse>
async deleteWatch (this: That, params: T.WatcherDeleteWatchRequest | TB.WatcherDeleteWatchRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.WatcherDeleteWatchResponse, unknown>> async deleteWatch (this: That, params: T.WatcherDeleteWatchRequest | TB.WatcherDeleteWatchRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.WatcherDeleteWatchResponse, unknown>>
@ -182,7 +182,7 @@ export default class Watcher {
/** /**
* 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. * 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.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.18/watcher-api-execute-watch.html | Elasticsearch API documentation} * @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-execute-watch | Elasticsearch API documentation}
*/ */
async executeWatch (this: That, params?: T.WatcherExecuteWatchRequest | TB.WatcherExecuteWatchRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.WatcherExecuteWatchResponse> async executeWatch (this: That, params?: T.WatcherExecuteWatchRequest | TB.WatcherExecuteWatchRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.WatcherExecuteWatchResponse>
async executeWatch (this: That, params?: T.WatcherExecuteWatchRequest | TB.WatcherExecuteWatchRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.WatcherExecuteWatchResponse, unknown>> async executeWatch (this: That, params?: T.WatcherExecuteWatchRequest | TB.WatcherExecuteWatchRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.WatcherExecuteWatchResponse, unknown>>
@ -234,7 +234,7 @@ export default class Watcher {
/** /**
* 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`. * 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`.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.18/watcher-api-get-settings.html | Elasticsearch API documentation} * @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-get-settings | Elasticsearch API documentation}
*/ */
async getSettings (this: That, params?: T.WatcherGetSettingsRequest | TB.WatcherGetSettingsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.WatcherGetSettingsResponse> async getSettings (this: That, params?: T.WatcherGetSettingsRequest | TB.WatcherGetSettingsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.WatcherGetSettingsResponse>
async getSettings (this: That, params?: T.WatcherGetSettingsRequest | TB.WatcherGetSettingsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.WatcherGetSettingsResponse, unknown>> async getSettings (this: That, params?: T.WatcherGetSettingsRequest | TB.WatcherGetSettingsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.WatcherGetSettingsResponse, unknown>>
@ -264,7 +264,7 @@ export default class Watcher {
/** /**
* Get a watch. * Get a watch.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.18/watcher-api-get-watch.html | Elasticsearch API documentation} * @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-get-watch | Elasticsearch API documentation}
*/ */
async getWatch (this: That, params: T.WatcherGetWatchRequest | TB.WatcherGetWatchRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.WatcherGetWatchResponse> async getWatch (this: That, params: T.WatcherGetWatchRequest | TB.WatcherGetWatchRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.WatcherGetWatchResponse>
async getWatch (this: That, params: T.WatcherGetWatchRequest | TB.WatcherGetWatchRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.WatcherGetWatchResponse, unknown>> async getWatch (this: That, params: T.WatcherGetWatchRequest | TB.WatcherGetWatchRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.WatcherGetWatchResponse, unknown>>
@ -296,7 +296,7 @@ export default class Watcher {
/** /**
* 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. * 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.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.18/watcher-api-put-watch.html | Elasticsearch API documentation} * @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-put-watch | Elasticsearch API documentation}
*/ */
async putWatch (this: That, params: T.WatcherPutWatchRequest | TB.WatcherPutWatchRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.WatcherPutWatchResponse> async putWatch (this: That, params: T.WatcherPutWatchRequest | TB.WatcherPutWatchRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.WatcherPutWatchResponse>
async putWatch (this: That, params: T.WatcherPutWatchRequest | TB.WatcherPutWatchRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.WatcherPutWatchResponse, unknown>> async putWatch (this: That, params: T.WatcherPutWatchRequest | TB.WatcherPutWatchRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.WatcherPutWatchResponse, unknown>>
@ -340,7 +340,7 @@ export default class Watcher {
/** /**
* 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. * 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.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.18/watcher-api-query-watches.html | Elasticsearch API documentation} * @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-query-watches | Elasticsearch API documentation}
*/ */
async queryWatches (this: That, params?: T.WatcherQueryWatchesRequest | TB.WatcherQueryWatchesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.WatcherQueryWatchesResponse> async queryWatches (this: That, params?: T.WatcherQueryWatchesRequest | TB.WatcherQueryWatchesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.WatcherQueryWatchesResponse>
async queryWatches (this: That, params?: T.WatcherQueryWatchesRequest | TB.WatcherQueryWatchesRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.WatcherQueryWatchesResponse, unknown>> async queryWatches (this: That, params?: T.WatcherQueryWatchesRequest | TB.WatcherQueryWatchesRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.WatcherQueryWatchesResponse, unknown>>
@ -382,7 +382,7 @@ export default class Watcher {
/** /**
* Start the watch service. Start the Watcher service if it is not already running. * Start the watch service. Start the Watcher service if it is not already running.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.18/watcher-api-start.html | Elasticsearch API documentation} * @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-start | Elasticsearch API documentation}
*/ */
async start (this: That, params?: T.WatcherStartRequest | TB.WatcherStartRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.WatcherStartResponse> async start (this: That, params?: T.WatcherStartRequest | TB.WatcherStartRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.WatcherStartResponse>
async start (this: That, params?: T.WatcherStartRequest | TB.WatcherStartRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.WatcherStartResponse, unknown>> async start (this: That, params?: T.WatcherStartRequest | TB.WatcherStartRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.WatcherStartResponse, unknown>>
@ -412,7 +412,7 @@ export default class Watcher {
/** /**
* Get Watcher statistics. This API always returns basic metrics. You retrieve more metrics by using the metric parameter. * Get Watcher statistics. This API always returns basic metrics. You retrieve more metrics by using the metric parameter.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.18/watcher-api-stats.html | Elasticsearch API documentation} * @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-stats | Elasticsearch API documentation}
*/ */
async stats (this: That, params?: T.WatcherStatsRequest | TB.WatcherStatsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.WatcherStatsResponse> async stats (this: That, params?: T.WatcherStatsRequest | TB.WatcherStatsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.WatcherStatsResponse>
async stats (this: That, params?: T.WatcherStatsRequest | TB.WatcherStatsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.WatcherStatsResponse, unknown>> async stats (this: That, params?: T.WatcherStatsRequest | TB.WatcherStatsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.WatcherStatsResponse, unknown>>
@ -452,7 +452,7 @@ export default class Watcher {
/** /**
* Stop the watch service. Stop the Watcher service if it is running. * Stop the watch service. Stop the Watcher service if it is running.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.18/watcher-api-stop.html | Elasticsearch API documentation} * @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-stop | Elasticsearch API documentation}
*/ */
async stop (this: That, params?: T.WatcherStopRequest | TB.WatcherStopRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.WatcherStopResponse> async stop (this: That, params?: T.WatcherStopRequest | TB.WatcherStopRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.WatcherStopResponse>
async stop (this: That, params?: T.WatcherStopRequest | TB.WatcherStopRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.WatcherStopResponse, unknown>> async stop (this: That, params?: T.WatcherStopRequest | TB.WatcherStopRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.WatcherStopResponse, unknown>>
@ -482,7 +482,7 @@ export default class Watcher {
/** /**
* 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. * 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.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.18/watcher-api-update-settings.html | Elasticsearch API documentation} * @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-update-settings | Elasticsearch API documentation}
*/ */
async updateSettings (this: That, params?: T.WatcherUpdateSettingsRequest | TB.WatcherUpdateSettingsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.WatcherUpdateSettingsResponse> async updateSettings (this: That, params?: T.WatcherUpdateSettingsRequest | TB.WatcherUpdateSettingsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.WatcherUpdateSettingsResponse>
async updateSettings (this: That, params?: T.WatcherUpdateSettingsRequest | TB.WatcherUpdateSettingsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.WatcherUpdateSettingsResponse, unknown>> async updateSettings (this: That, params?: T.WatcherUpdateSettingsRequest | TB.WatcherUpdateSettingsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.WatcherUpdateSettingsResponse, unknown>>

2
src/api/api/xpack.ts
View File

@ -76,7 +76,7 @@ export default class Xpack {
/** /**
* 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. * 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.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.18/usage-api.html | Elasticsearch API documentation} * @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/v8/group/endpoint-xpack | Elasticsearch API documentation}
*/ */
async usage (this: That, params?: T.XpackUsageRequest | TB.XpackUsageRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.XpackUsageResponse> async usage (this: That, params?: T.XpackUsageRequest | TB.XpackUsageRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.XpackUsageResponse>
async usage (this: That, params?: T.XpackUsageRequest | TB.XpackUsageRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.XpackUsageResponse, unknown>> async usage (this: That, params?: T.XpackUsageRequest | TB.XpackUsageRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.XpackUsageResponse, unknown>>