@@ -53,11 +53,11 @@ async def aliases(
53
53
v : t .Optional [bool ] = None ,
54
54
) -> t .Union [ObjectApiResponse [t .Any ], TextApiResponse ]:
55
55
"""
56
- Retrieves the cluster’s index aliases, including filter and routing information.
57
- The API does not return data stream aliases. IMPORTANT: cat APIs are only intended
56
+ Get aliases. Retrieves the cluster’s index aliases, including filter and routing
57
+ information. The API does not return data stream aliases. CAT APIs are only intended
58
58
for human consumption using the command line or the Kibana console. They are
59
- not intended for use by applications. For application consumption, use the aliases
60
- API .
59
+ not intended for use by applications. For application consumption, use the /_alias
60
+ endpoints .
61
61
62
62
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-alias.html>`_
63
63
@@ -142,11 +142,12 @@ async def component_templates(
142
142
v : t .Optional [bool ] = None ,
143
143
) -> t .Union [ObjectApiResponse [t .Any ], TextApiResponse ]:
144
144
"""
145
- Returns information about component templates in a cluster. Component templates
146
- are building blocks for constructing index templates that specify index mappings,
147
- settings, and aliases. IMPORTANT: cat APIs are only intended for human consumption
148
- using the command line or Kibana console. They are not intended for use by applications.
149
- For application consumption, use the get component template API.
145
+ Get component templates. Returns information about component templates in a cluster.
146
+ Component templates are building blocks for constructing index templates that
147
+ specify index mappings, settings, and aliases. CAT APIs are only intended for
148
+ human consumption using the command line or Kibana console. They are not intended
149
+ for use by applications. For application consumption, use the /_component_template
150
+ endpoints.
150
151
151
152
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-component-templates.html>`_
152
153
@@ -227,12 +228,12 @@ async def count(
227
228
v : t .Optional [bool ] = None ,
228
229
) -> t .Union [ObjectApiResponse [t .Any ], TextApiResponse ]:
229
230
"""
230
- Provides quick access to a document count for a data stream, an index, or an
231
- entire cluster. NOTE: The document count only includes live documents, not deleted
232
- documents which have not yet been removed by the merge process. IMPORTANT: cat
231
+ Get a document count. Provides quick access to a document count for a data stream,
232
+ an index, or an entire cluster.n/ The document count only includes live documents,
233
+ not deleted documents which have not yet been removed by the merge process. CAT
233
234
APIs are only intended for human consumption using the command line or Kibana
234
235
console. They are not intended for use by applications. For application consumption,
235
- use the count API .
236
+ use /_count endpoints .
236
237
237
238
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-count.html>`_
238
239
@@ -313,7 +314,7 @@ async def help(
313
314
v : t .Optional [bool ] = None ,
314
315
) -> TextApiResponse :
315
316
"""
316
- Returns help for the Cat APIs.
317
+ Get CAT help. Returns help for the CAT APIs.
317
318
318
319
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat.html>`_
319
320
@@ -404,16 +405,16 @@ async def indices(
404
405
v : t .Optional [bool ] = None ,
405
406
) -> t .Union [ObjectApiResponse [t .Any ], TextApiResponse ]:
406
407
"""
407
- Returns high-level information about indices in a cluster, including backing
408
- indices for data streams. IMPORTANT: cat APIs are only intended for human consumption
409
- using the command line or Kibana console. They are not intended for use by applications.
410
- For application consumption, use the get index API. Use the cat indices API to
411
- get the following information for each index in a cluster: shard count; document
412
- count; deleted document count; primary store size; total store size of all shards,
413
- including shard replicas. These metrics are retrieved directly from Lucene, which
414
- Elasticsearch uses internally to power indexing and search. As a result, all
415
- document counts include hidden nested documents. To get an accurate count of
416
- Elasticsearch documents, use the cat count or count APIs .
408
+ Get index information. Returns high-level information about indices in a cluster,
409
+ including backing indices for data streams. Use this request to get the following
410
+ information for each index in a cluster: - shard count - document count - deleted
411
+ document count - primary store size - total store size of all shards, including
412
+ shard replicas These metrics are retrieved directly from Lucene, which Elasticsearch
413
+ uses internally to power indexing and search. As a result, all document counts
414
+ include hidden nested documents. To get an accurate count of Elasticsearch documents,
415
+ use the /_cat/count or _count endpoints. CAT APIs are only intended for human
416
+ consumption using the command line or Kibana console. They are not intended for
417
+ use by applications. For application consumption, use an index endpoint .
417
418
418
419
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-indices.html>`_
419
420
@@ -546,10 +547,10 @@ async def ml_data_frame_analytics(
546
547
v : t .Optional [bool ] = None ,
547
548
) -> t .Union [ObjectApiResponse [t .Any ], TextApiResponse ]:
548
549
"""
549
- Returns configuration and usage information about data frame analytics jobs.
550
- IMPORTANT: cat APIs are only intended for human consumption using the Kibana
551
- console or command line. They are not intended for use by applications. For application
552
- consumption, use the get data frame analytics jobs statistics API .
550
+ Get data frame analytics jobs. Returns configuration and usage information about
551
+ data frame analytics jobs. CAT APIs are only intended for human consumption using
552
+ the Kibana console or command line. They are not intended for use by applications.
553
+ For application consumption, use the /_ml/data_frame/ analytics endpoints .
553
554
554
555
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-dfanalytics.html>`_
555
556
@@ -668,12 +669,12 @@ async def ml_datafeeds(
668
669
v : t .Optional [bool ] = None ,
669
670
) -> t .Union [ObjectApiResponse [t .Any ], TextApiResponse ]:
670
671
"""
671
- Returns configuration and usage information about datafeeds. This API returns
672
- a maximum of 10,000 datafeeds. If the Elasticsearch security features are enabled,
673
- you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage` cluster privileges
674
- to use this API. IMPORTANT: cat APIs are only intended for human consumption
672
+ Get datafeeds. Returns configuration and usage information about datafeeds. This
673
+ API returns a maximum of 10,000 datafeeds. If the Elasticsearch security features
674
+ are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage`
675
+ cluster privileges to use this API. CAT APIs are only intended for human consumption
675
676
using the Kibana console or command line. They are not intended for use by applications.
676
- For application consumption, use the get datafeed statistics API .
677
+ For application consumption, use the /_ml/datafeeds endpoints .
677
678
678
679
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-datafeeds.html>`_
679
680
@@ -798,13 +799,13 @@ async def ml_jobs(
798
799
v : t .Optional [bool ] = None ,
799
800
) -> t .Union [ObjectApiResponse [t .Any ], TextApiResponse ]:
800
801
"""
801
- Returns configuration and usage information for anomaly detection jobs. This
802
- API returns a maximum of 10,000 jobs. If the Elasticsearch security features
803
- are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage`
804
- cluster privileges to use this API. IMPORTANT: cat APIs are only intended for
802
+ Get anomaly detection jobs. Returns configuration and usage information for anomaly
803
+ detection jobs. This API returns a maximum of 10,000 jobs. If the Elasticsearch
804
+ security features are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`,
805
+ or `manage` cluster privileges to use this API. CAT APIs are only intended for
805
806
human consumption using the Kibana console or command line. They are not intended
806
- for use by applications. For application consumption, use the get anomaly detection
807
- job statistics API .
807
+ for use by applications. For application consumption, use the /_ml/anomaly_detectors
808
+ endpoints .
808
809
809
810
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-anomaly-detectors.html>`_
810
811
@@ -932,10 +933,10 @@ async def ml_trained_models(
932
933
v : t .Optional [bool ] = None ,
933
934
) -> t .Union [ObjectApiResponse [t .Any ], TextApiResponse ]:
934
935
"""
935
- Returns configuration and usage information about inference trained models. IMPORTANT:
936
- cat APIs are only intended for human consumption using the Kibana console or
937
- command line. They are not intended for use by applications. For application
938
- consumption, use the get trained models statistics API .
936
+ Get trained models. Returns configuration and usage information about inference
937
+ trained models. CAT APIs are only intended for human consumption using the Kibana
938
+ console or command line. They are not intended for use by applications. For application
939
+ consumption, use the /_ml/trained_models endpoints .
939
940
940
941
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-trained-model.html>`_
941
942
@@ -1066,10 +1067,10 @@ async def transforms(
1066
1067
v : t .Optional [bool ] = None ,
1067
1068
) -> t .Union [ObjectApiResponse [t .Any ], TextApiResponse ]:
1068
1069
"""
1069
- Returns configuration and usage information about transforms. IMPORTANT: cat
1070
- APIs are only intended for human consumption using the Kibana console or command
1071
- line. They are not intended for use by applications. For application consumption,
1072
- use the get transform statistics API .
1070
+ Get transforms. Returns configuration and usage information about transforms.
1071
+ CAT APIs are only intended for human consumption using the Kibana console or
1072
+ command line. They are not intended for use by applications. For application
1073
+ consumption, use the /_transform endpoints .
1073
1074
1074
1075
`<https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-transforms.html>`_
1075
1076
0 commit comments