Skip to content

Commit f01ff38

Browse files
Auto-generated code for main (#2627)
1 parent 6f425a5 commit f01ff38

File tree

2 files changed

+30
-28
lines changed

2 files changed

+30
-28
lines changed

elasticsearch/_async/client/cat.py

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -54,8 +54,8 @@ async def aliases(
5454
Get aliases. Retrieves the cluster’s index aliases, including filter and routing
5555
information. The API does not return data stream aliases. CAT APIs are only intended
5656
for human consumption using the command line or the Kibana console. They are
57-
not intended for use by applications. For application consumption, use the /_alias
58-
endpoints.
57+
not intended for use by applications. For application consumption, use the aliases
58+
API.
5959
6060
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-alias.html>`_
6161
@@ -229,8 +229,8 @@ async def component_templates(
229229
Component templates are building blocks for constructing index templates that
230230
specify index mappings, settings, and aliases. CAT APIs are only intended for
231231
human consumption using the command line or Kibana console. They are not intended
232-
for use by applications. For application consumption, use the /_component_template
233-
endpoints.
232+
for use by applications. For application consumption, use the get component template
233+
API.
234234
235235
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-component-templates.html>`_
236236
@@ -314,7 +314,7 @@ async def count(
314314
not deleted documents which have not yet been removed by the merge process. CAT
315315
APIs are only intended for human consumption using the command line or Kibana
316316
console. They are not intended for use by applications. For application consumption,
317-
use /_count endpoints.
317+
use the count API.
318318
319319
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-count.html>`_
320320
@@ -668,9 +668,9 @@ async def indices(
668668
shard replicas These metrics are retrieved directly from Lucene, which Elasticsearch
669669
uses internally to power indexing and search. As a result, all document counts
670670
include hidden nested documents. To get an accurate count of Elasticsearch documents,
671-
use the /_cat/count or _count endpoints. CAT APIs are only intended for human
672-
consumption using the command line or Kibana console. They are not intended for
673-
use by applications. For application consumption, use an index endpoint.
671+
use the cat count or count APIs. CAT APIs are only intended for human consumption
672+
using the command line or Kibana console. They are not intended for use by applications.
673+
For application consumption, use an index endpoint.
674674
675675
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-indices.html>`_
676676
@@ -946,7 +946,8 @@ async def ml_data_frame_analytics(
946946
Get data frame analytics jobs. Returns configuration and usage information about
947947
data frame analytics jobs. CAT APIs are only intended for human consumption using
948948
the Kibana console or command line. They are not intended for use by applications.
949-
For application consumption, use the /_ml/data_frame/analytics endpoints.
949+
For application consumption, use the get data frame analytics jobs statistics
950+
API.
950951
951952
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-dfanalytics.html>`_
952953
@@ -1120,7 +1121,7 @@ async def ml_datafeeds(
11201121
are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage`
11211122
cluster privileges to use this API. CAT APIs are only intended for human consumption
11221123
using the Kibana console or command line. They are not intended for use by applications.
1123-
For application consumption, use the /_ml/datafeeds endpoints.
1124+
For application consumption, use the get datafeed statistics API.
11241125
11251126
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-datafeeds.html>`_
11261127
@@ -1492,8 +1493,8 @@ async def ml_jobs(
14921493
security features are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`,
14931494
or `manage` cluster privileges to use this API. CAT APIs are only intended for
14941495
human consumption using the Kibana console or command line. They are not intended
1495-
for use by applications. For application consumption, use the /_ml/anomaly_detectors
1496-
endpoints.
1496+
for use by applications. For application consumption, use the get anomaly detection
1497+
job statistics API.
14971498
14981499
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-anomaly-detectors.html>`_
14991500
@@ -1682,7 +1683,7 @@ async def ml_trained_models(
16821683
Get trained models. Returns configuration and usage information about inference
16831684
trained models. CAT APIs are only intended for human consumption using the Kibana
16841685
console or command line. They are not intended for use by applications. For application
1685-
consumption, use the /_ml/trained_models endpoints.
1686+
consumption, use the get trained models statistics API.
16861687
16871688
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-trained-model.html>`_
16881689
@@ -2970,7 +2971,7 @@ async def transforms(
29702971
Get transforms. Returns configuration and usage information about transforms.
29712972
CAT APIs are only intended for human consumption using the Kibana console or
29722973
command line. They are not intended for use by applications. For application
2973-
consumption, use the /_transform endpoints.
2974+
consumption, use the get transform statistics API.
29742975
29752976
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-transforms.html>`_
29762977

elasticsearch/_sync/client/cat.py

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -54,8 +54,8 @@ def aliases(
5454
Get aliases. Retrieves the cluster’s index aliases, including filter and routing
5555
information. The API does not return data stream aliases. CAT APIs are only intended
5656
for human consumption using the command line or the Kibana console. They are
57-
not intended for use by applications. For application consumption, use the /_alias
58-
endpoints.
57+
not intended for use by applications. For application consumption, use the aliases
58+
API.
5959
6060
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-alias.html>`_
6161
@@ -229,8 +229,8 @@ def component_templates(
229229
Component templates are building blocks for constructing index templates that
230230
specify index mappings, settings, and aliases. CAT APIs are only intended for
231231
human consumption using the command line or Kibana console. They are not intended
232-
for use by applications. For application consumption, use the /_component_template
233-
endpoints.
232+
for use by applications. For application consumption, use the get component template
233+
API.
234234
235235
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-component-templates.html>`_
236236
@@ -314,7 +314,7 @@ def count(
314314
not deleted documents which have not yet been removed by the merge process. CAT
315315
APIs are only intended for human consumption using the command line or Kibana
316316
console. They are not intended for use by applications. For application consumption,
317-
use /_count endpoints.
317+
use the count API.
318318
319319
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-count.html>`_
320320
@@ -668,9 +668,9 @@ def indices(
668668
shard replicas These metrics are retrieved directly from Lucene, which Elasticsearch
669669
uses internally to power indexing and search. As a result, all document counts
670670
include hidden nested documents. To get an accurate count of Elasticsearch documents,
671-
use the /_cat/count or _count endpoints. CAT APIs are only intended for human
672-
consumption using the command line or Kibana console. They are not intended for
673-
use by applications. For application consumption, use an index endpoint.
671+
use the cat count or count APIs. CAT APIs are only intended for human consumption
672+
using the command line or Kibana console. They are not intended for use by applications.
673+
For application consumption, use an index endpoint.
674674
675675
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-indices.html>`_
676676
@@ -946,7 +946,8 @@ def ml_data_frame_analytics(
946946
Get data frame analytics jobs. Returns configuration and usage information about
947947
data frame analytics jobs. CAT APIs are only intended for human consumption using
948948
the Kibana console or command line. They are not intended for use by applications.
949-
For application consumption, use the /_ml/data_frame/analytics endpoints.
949+
For application consumption, use the get data frame analytics jobs statistics
950+
API.
950951
951952
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-dfanalytics.html>`_
952953
@@ -1120,7 +1121,7 @@ def ml_datafeeds(
11201121
are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage`
11211122
cluster privileges to use this API. CAT APIs are only intended for human consumption
11221123
using the Kibana console or command line. They are not intended for use by applications.
1123-
For application consumption, use the /_ml/datafeeds endpoints.
1124+
For application consumption, use the get datafeed statistics API.
11241125
11251126
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-datafeeds.html>`_
11261127
@@ -1492,8 +1493,8 @@ def ml_jobs(
14921493
security features are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`,
14931494
or `manage` cluster privileges to use this API. CAT APIs are only intended for
14941495
human consumption using the Kibana console or command line. They are not intended
1495-
for use by applications. For application consumption, use the /_ml/anomaly_detectors
1496-
endpoints.
1496+
for use by applications. For application consumption, use the get anomaly detection
1497+
job statistics API.
14971498
14981499
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-anomaly-detectors.html>`_
14991500
@@ -1682,7 +1683,7 @@ def ml_trained_models(
16821683
Get trained models. Returns configuration and usage information about inference
16831684
trained models. CAT APIs are only intended for human consumption using the Kibana
16841685
console or command line. They are not intended for use by applications. For application
1685-
consumption, use the /_ml/trained_models endpoints.
1686+
consumption, use the get trained models statistics API.
16861687
16871688
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-trained-model.html>`_
16881689
@@ -2970,7 +2971,7 @@ def transforms(
29702971
Get transforms. Returns configuration and usage information about transforms.
29712972
CAT APIs are only intended for human consumption using the Kibana console or
29722973
command line. They are not intended for use by applications. For application
2973-
consumption, use the /_transform endpoints.
2974+
consumption, use the get transform statistics API.
29742975
29752976
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-transforms.html>`_
29762977

0 commit comments

Comments
 (0)