elasticsearch 9.0.2__py3-none-any.whl → 9.0.4__py3-none-any.whl

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.
Files changed (61) hide show
  1. elasticsearch/_async/client/__init__.py +59 -202
  2. elasticsearch/_async/client/cat.py +1011 -59
  3. elasticsearch/_async/client/cluster.py +14 -4
  4. elasticsearch/_async/client/eql.py +10 -2
  5. elasticsearch/_async/client/esql.py +33 -10
  6. elasticsearch/_async/client/indices.py +88 -44
  7. elasticsearch/_async/client/inference.py +108 -3
  8. elasticsearch/_async/client/ingest.py +0 -7
  9. elasticsearch/_async/client/license.py +4 -4
  10. elasticsearch/_async/client/ml.py +6 -17
  11. elasticsearch/_async/client/monitoring.py +1 -1
  12. elasticsearch/_async/client/rollup.py +1 -22
  13. elasticsearch/_async/client/security.py +11 -17
  14. elasticsearch/_async/client/snapshot.py +6 -0
  15. elasticsearch/_async/client/sql.py +1 -1
  16. elasticsearch/_async/client/synonyms.py +1 -0
  17. elasticsearch/_async/client/transform.py +60 -0
  18. elasticsearch/_async/client/watcher.py +4 -2
  19. elasticsearch/_sync/client/__init__.py +59 -202
  20. elasticsearch/_sync/client/cat.py +1011 -59
  21. elasticsearch/_sync/client/cluster.py +14 -4
  22. elasticsearch/_sync/client/eql.py +10 -2
  23. elasticsearch/_sync/client/esql.py +33 -10
  24. elasticsearch/_sync/client/indices.py +88 -44
  25. elasticsearch/_sync/client/inference.py +108 -3
  26. elasticsearch/_sync/client/ingest.py +0 -7
  27. elasticsearch/_sync/client/license.py +4 -4
  28. elasticsearch/_sync/client/ml.py +6 -17
  29. elasticsearch/_sync/client/monitoring.py +1 -1
  30. elasticsearch/_sync/client/rollup.py +1 -22
  31. elasticsearch/_sync/client/security.py +11 -17
  32. elasticsearch/_sync/client/snapshot.py +6 -0
  33. elasticsearch/_sync/client/sql.py +1 -1
  34. elasticsearch/_sync/client/synonyms.py +1 -0
  35. elasticsearch/_sync/client/transform.py +60 -0
  36. elasticsearch/_sync/client/watcher.py +4 -2
  37. elasticsearch/_version.py +1 -1
  38. elasticsearch/compat.py +5 -0
  39. elasticsearch/dsl/__init__.py +2 -1
  40. elasticsearch/dsl/_async/document.py +84 -0
  41. elasticsearch/dsl/_sync/document.py +84 -0
  42. elasticsearch/dsl/document_base.py +219 -16
  43. elasticsearch/dsl/field.py +245 -57
  44. elasticsearch/dsl/query.py +7 -4
  45. elasticsearch/dsl/response/aggs.py +1 -1
  46. elasticsearch/dsl/types.py +125 -88
  47. elasticsearch/dsl/utils.py +2 -2
  48. elasticsearch/{dsl/_sync/_sync_check → esql}/__init__.py +3 -0
  49. elasticsearch/esql/esql.py +1156 -0
  50. elasticsearch/esql/functions.py +1750 -0
  51. {elasticsearch-9.0.2.dist-info → elasticsearch-9.0.4.dist-info}/METADATA +1 -3
  52. {elasticsearch-9.0.2.dist-info → elasticsearch-9.0.4.dist-info}/RECORD +55 -59
  53. elasticsearch/dsl/_sync/_sync_check/document.py +0 -514
  54. elasticsearch/dsl/_sync/_sync_check/faceted_search.py +0 -50
  55. elasticsearch/dsl/_sync/_sync_check/index.py +0 -597
  56. elasticsearch/dsl/_sync/_sync_check/mapping.py +0 -49
  57. elasticsearch/dsl/_sync/_sync_check/search.py +0 -230
  58. elasticsearch/dsl/_sync/_sync_check/update_by_query.py +0 -45
  59. {elasticsearch-9.0.2.dist-info → elasticsearch-9.0.4.dist-info}/WHEEL +0 -0
  60. {elasticsearch-9.0.2.dist-info → elasticsearch-9.0.4.dist-info}/licenses/LICENSE +0 -0
  61. {elasticsearch-9.0.2.dist-info → elasticsearch-9.0.4.dist-info}/licenses/NOTICE +0 -0
elasticsearch/_async/client/cat.py CHANGED
@@ -47,7 +47,34 @@ class CatClient(NamespacedClient):
47
47
  ] = None,
48
48
  filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
49
49
  format: t.Optional[str] = None,
50
- h: t.Optional[t.Union[str, t.Sequence[str]]] = None,
50
+ h: t.Optional[
51
+ t.Union[
52
+ t.Sequence[
53
+ t.Union[
54
+ str,
55
+ t.Literal[
56
+ "alias",
57
+ "filter",
58
+ "index",
59
+ "is_write_index",
60
+ "routing.index",
61
+ "routing.search",
62
+ ],
63
+ ]
64
+ ],
65
+ t.Union[
66
+ str,
67
+ t.Literal[
68
+ "alias",
69
+ "filter",
70
+ "index",
71
+ "is_write_index",
72
+ "routing.index",
73
+ "routing.search",
74
+ ],
75
+ ],
76
+ ]
77
+ ] = None,
51
78
  help: t.Optional[bool] = None,
52
79
  human: t.Optional[bool] = None,
53
80
  master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
@@ -74,7 +101,8 @@ class CatClient(NamespacedClient):
74
101
  values, such as `open,hidden`.
75
102
  :param format: Specifies the format to return the columnar data in, can be set
76
103
  to `text`, `json`, `cbor`, `yaml`, or `smile`.
77
- :param h: List of columns to appear in the response. Supports simple wildcards.
104
+ :param h: A comma-separated list of columns names to display. It supports simple
105
+ wildcards.
78
106
  :param help: When set to `true` will output available columns. This option can't
79
107
  be combined with any other query string option.
80
108
  :param master_timeout: The period to wait for a connection to the master node.
@@ -137,7 +165,48 @@ class CatClient(NamespacedClient):
137
165
  error_trace: t.Optional[bool] = None,
138
166
  filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
139
167
  format: t.Optional[str] = None,
140
- h: t.Optional[t.Union[str, t.Sequence[str]]] = None,
168
+ h: t.Optional[
169
+ t.Union[
170
+ t.Sequence[
171
+ t.Union[
172
+ str,
173
+ t.Literal[
174
+ "disk.avail",
175
+ "disk.indices",
176
+ "disk.indices.forecast",
177
+ "disk.percent",
178
+ "disk.total",
179
+ "disk.used",
180
+ "host",
181
+ "ip",
182
+ "node",
183
+ "node.role",
184
+ "shards",
185
+ "shards.undesired",
186
+ "write_load.forecast",
187
+ ],
188
+ ]
189
+ ],
190
+ t.Union[
191
+ str,
192
+ t.Literal[
193
+ "disk.avail",
194
+ "disk.indices",
195
+ "disk.indices.forecast",
196
+ "disk.percent",
197
+ "disk.total",
198
+ "disk.used",
199
+ "host",
200
+ "ip",
201
+ "node",
202
+ "node.role",
203
+ "shards",
204
+ "shards.undesired",
205
+ "write_load.forecast",
206
+ ],
207
+ ],
208
+ ]
209
+ ] = None,
141
210
  help: t.Optional[bool] = None,
142
211
  human: t.Optional[bool] = None,
143
212
  local: t.Optional[bool] = None,
@@ -161,7 +230,8 @@ class CatClient(NamespacedClient):
161
230
  :param bytes: The unit used to display byte values.
162
231
  :param format: Specifies the format to return the columnar data in, can be set
163
232
  to `text`, `json`, `cbor`, `yaml`, or `smile`.
164
- :param h: List of columns to appear in the response. Supports simple wildcards.
233
+ :param h: A comma-separated list of columns names to display. It supports simple
234
+ wildcards.
165
235
  :param help: When set to `true` will output available columns. This option can't
166
236
  be combined with any other query string option.
167
237
  :param local: If `true`, the request computes the list of selected nodes from
@@ -224,7 +294,36 @@ class CatClient(NamespacedClient):
224
294
  error_trace: t.Optional[bool] = None,
225
295
  filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
226
296
  format: t.Optional[str] = None,
227
- h: t.Optional[t.Union[str, t.Sequence[str]]] = None,
297
+ h: t.Optional[
298
+ t.Union[
299
+ t.Sequence[
300
+ t.Union[
301
+ str,
302
+ t.Literal[
303
+ "alias_count",
304
+ "included_in",
305
+ "mapping_count",
306
+ "metadata_count",
307
+ "name",
308
+ "settings_count",
309
+ "version",
310
+ ],
311
+ ]
312
+ ],
313
+ t.Union[
314
+ str,
315
+ t.Literal[
316
+ "alias_count",
317
+ "included_in",
318
+ "mapping_count",
319
+ "metadata_count",
320
+ "name",
321
+ "settings_count",
322
+ "version",
323
+ ],
324
+ ],
325
+ ]
326
+ ] = None,
228
327
  help: t.Optional[bool] = None,
229
328
  human: t.Optional[bool] = None,
230
329
  local: t.Optional[bool] = None,
@@ -249,7 +348,8 @@ class CatClient(NamespacedClient):
249
348
  If it is omitted, all component templates are returned.
250
349
  :param format: Specifies the format to return the columnar data in, can be set
251
350
  to `text`, `json`, `cbor`, `yaml`, or `smile`.
252
- :param h: List of columns to appear in the response. Supports simple wildcards.
351
+ :param h: A comma-separated list of columns names to display. It supports simple
352
+ wildcards.
253
353
  :param help: When set to `true` will output available columns. This option can't
254
354
  be combined with any other query string option.
255
355
  :param local: If `true`, the request computes the list of selected nodes from
@@ -310,7 +410,12 @@ class CatClient(NamespacedClient):
310
410
  error_trace: t.Optional[bool] = None,
311
411
  filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
312
412
  format: t.Optional[str] = None,
313
- h: t.Optional[t.Union[str, t.Sequence[str]]] = None,
413
+ h: t.Optional[
414
+ t.Union[
415
+ t.Sequence[t.Union[str, t.Literal["count", "epoch", "timestamp"]]],
416
+ t.Union[str, t.Literal["count", "epoch", "timestamp"]],
417
+ ]
418
+ ] = None,
314
419
  help: t.Optional[bool] = None,
315
420
  human: t.Optional[bool] = None,
316
421
  pretty: t.Optional[bool] = None,
@@ -334,7 +439,8 @@ class CatClient(NamespacedClient):
334
439
  and indices, omit this parameter or use `*` or `_all`.
335
440
  :param format: Specifies the format to return the columnar data in, can be set
336
441
  to `text`, `json`, `cbor`, `yaml`, or `smile`.
337
- :param h: List of columns to appear in the response. Supports simple wildcards.
442
+ :param h: A comma-separated list of columns names to display. It supports simple
443
+ wildcards.
338
444
  :param help: When set to `true` will output available columns. This option can't
339
445
  be combined with any other query string option.
340
446
  :param s: List of columns that determine how the table should be sorted. Sorting
@@ -389,7 +495,14 @@ class CatClient(NamespacedClient):
389
495
  error_trace: t.Optional[bool] = None,
390
496
  filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
391
497
  format: t.Optional[str] = None,
392
- h: t.Optional[t.Union[str, t.Sequence[str]]] = None,
498
+ h: t.Optional[
499
+ t.Union[
500
+ t.Sequence[
501
+ t.Union[str, t.Literal["field", "host", "id", "ip", "node", "size"]]
502
+ ],
503
+ t.Union[str, t.Literal["field", "host", "id", "ip", "node", "size"]],
504
+ ]
505
+ ] = None,
393
506
  help: t.Optional[bool] = None,
394
507
  human: t.Optional[bool] = None,
395
508
  pretty: t.Optional[bool] = None,
@@ -412,7 +525,8 @@ class CatClient(NamespacedClient):
412
525
  :param bytes: The unit used to display byte values.
413
526
  :param format: Specifies the format to return the columnar data in, can be set
414
527
  to `text`, `json`, `cbor`, `yaml`, or `smile`.
415
- :param h: List of columns to appear in the response. Supports simple wildcards.
528
+ :param h: A comma-separated list of columns names to display. It supports simple
529
+ wildcards.
416
530
  :param help: When set to `true` will output available columns. This option can't
417
531
  be combined with any other query string option.
418
532
  :param s: List of columns that determine how the table should be sorted. Sorting
@@ -465,7 +579,52 @@ class CatClient(NamespacedClient):
465
579
  error_trace: t.Optional[bool] = None,
466
580
  filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
467
581
  format: t.Optional[str] = None,
468
- h: t.Optional[t.Union[str, t.Sequence[str]]] = None,
582
+ h: t.Optional[
583
+ t.Union[
584
+ t.Sequence[
585
+ t.Union[
586
+ str,
587
+ t.Literal[
588
+ "active_shards_percent",
589
+ "cluster",
590
+ "epoch",
591
+ "init",
592
+ "max_task_wait_time",
593
+ "node.data",
594
+ "node.total",
595
+ "pending_tasks",
596
+ "pri",
597
+ "relo",
598
+ "shards",
599
+ "status",
600
+ "timestamp",
601
+ "unassign",
602
+ "unassign.pri",
603
+ ],
604
+ ]
605
+ ],
606
+ t.Union[
607
+ str,
608
+ t.Literal[
609
+ "active_shards_percent",
610
+ "cluster",
611
+ "epoch",
612
+ "init",
613
+ "max_task_wait_time",
614
+ "node.data",
615
+ "node.total",
616
+ "pending_tasks",
617
+ "pri",
618
+ "relo",
619
+ "shards",
620
+ "status",
621
+ "timestamp",
622
+ "unassign",
623
+ "unassign.pri",
624
+ ],
625
+ ],
626
+ ]
627
+ ] = None,
469
628
  help: t.Optional[bool] = None,
470
629
  human: t.Optional[bool] = None,
471
630
  pretty: t.Optional[bool] = None,
@@ -495,7 +654,8 @@ class CatClient(NamespacedClient):
495
654
 
496
655
  :param format: Specifies the format to return the columnar data in, can be set
497
656
  to `text`, `json`, `cbor`, `yaml`, or `smile`.
498
- :param h: List of columns to appear in the response. Supports simple wildcards.
657
+ :param h: A comma-separated list of columns names to display. It supports simple
658
+ wildcards.
499
659
  :param help: When set to `true` will output available columns. This option can't
500
660
  be combined with any other query string option.
501
661
  :param s: List of columns that determine how the table should be sorted. Sorting
@@ -583,8 +743,319 @@ class CatClient(NamespacedClient):
583
743
  ] = None,
584
744
  filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
585
745
  format: t.Optional[str] = None,
586
- h: t.Optional[t.Union[str, t.Sequence[str]]] = None,
587
- health: t.Optional[t.Union[str, t.Literal["green", "red", "yellow"]]] = None,
746
+ h: t.Optional[
747
+ t.Union[
748
+ t.Sequence[
749
+ t.Union[
750
+ str,
751
+ t.Literal[
752
+ "bulk.avg_size_in_bytes",
753
+ "bulk.avg_time",
754
+ "bulk.total_operations",
755
+ "bulk.total_size_in_bytes",
756
+ "bulk.total_time",
757
+ "completion.size",
758
+ "creation.date",
759
+ "creation.date.string",
760
+ "dataset.size",
761
+ "dense_vector.value_count",
762
+ "docs.count",
763
+ "docs.deleted",
764
+ "fielddata.evictions",
765
+ "fielddata.memory_size",
766
+ "flush.total",
767
+ "flush.total_time",
768
+ "get.current",
769
+ "get.exists_time",
770
+ "get.exists_total",
771
+ "get.missing_time",
772
+ "get.missing_total",
773
+ "get.time",
774
+ "get.total",
775
+ "health",
776
+ "index",
777
+ "indexing.delete_current",
778
+ "indexing.delete_time",
779
+ "indexing.delete_total",
780
+ "indexing.index_current",
781
+ "indexing.index_failed",
782
+ "indexing.index_failed_due_to_version_conflict",
783
+ "indexing.index_time",
784
+ "indexing.index_total",
785
+ "memory.total",
786
+ "merges.current",
787
+ "merges.current_docs",
788
+ "merges.current_size",
789
+ "merges.total",
790
+ "merges.total_docs",
791
+ "merges.total_size",
792
+ "merges.total_time",
793
+ "pri",
794
+ "pri.bulk.avg_size_in_bytes",
795
+ "pri.bulk.avg_time",
796
+ "pri.bulk.total_operations",
797
+ "pri.bulk.total_size_in_bytes",
798
+ "pri.bulk.total_time",
799
+ "pri.completion.size",
800
+ "pri.dense_vector.value_count",
801
+ "pri.fielddata.evictions",
802
+ "pri.fielddata.memory_size",
803
+ "pri.flush.total",
804
+ "pri.flush.total_time",
805
+ "pri.get.current",
806
+ "pri.get.exists_time",
807
+ "pri.get.exists_total",
808
+ "pri.get.missing_time",
809
+ "pri.get.missing_total",
810
+ "pri.get.time",
811
+ "pri.get.total",
812
+ "pri.indexing.delete_current",
813
+ "pri.indexing.delete_time",
814
+ "pri.indexing.delete_total",
815
+ "pri.indexing.index_current",
816
+ "pri.indexing.index_failed",
817
+ "pri.indexing.index_failed_due_to_version_conflict",
818
+ "pri.indexing.index_time",
819
+ "pri.indexing.index_total",
820
+ "pri.memory.total",
821
+ "pri.merges.current",
822
+ "pri.merges.current_docs",
823
+ "pri.merges.current_size",
824
+ "pri.merges.total",
825
+ "pri.merges.total_docs",
826
+ "pri.merges.total_size",
827
+ "pri.merges.total_time",
828
+ "pri.query_cache.evictions",
829
+ "pri.query_cache.memory_size",
830
+ "pri.refresh.external_time",
831
+ "pri.refresh.external_total",
832
+ "pri.refresh.listeners",
833
+ "pri.refresh.time",
834
+ "pri.refresh.total",
835
+ "pri.request_cache.evictions",
836
+ "pri.request_cache.hit_count",
837
+ "pri.request_cache.memory_size",
838
+ "pri.request_cache.miss_count",
839
+ "pri.search.fetch_current",
840
+ "pri.search.fetch_time",
841
+ "pri.search.fetch_total",
842
+ "pri.search.open_contexts",
843
+ "pri.search.query_current",
844
+ "pri.search.query_time",
845
+ "pri.search.query_total",
846
+ "pri.search.scroll_current",
847
+ "pri.search.scroll_time",
848
+ "pri.search.scroll_total",
849
+ "pri.segments.count",
850
+ "pri.segments.fixed_bitset_memory",
851
+ "pri.segments.index_writer_memory",
852
+ "pri.segments.memory",
853
+ "pri.segments.version_map_memory",
854
+ "pri.sparse_vector.value_count",
855
+ "pri.store.size",
856
+ "pri.suggest.current",
857
+ "pri.suggest.time",
858
+ "pri.suggest.total",
859
+ "pri.warmer.current",
860
+ "pri.warmer.total",
861
+ "pri.warmer.total_time",
862
+ "query_cache.evictions",
863
+ "query_cache.memory_size",
864
+ "refresh.external_time",
865
+ "refresh.external_total",
866
+ "refresh.listeners",
867
+ "refresh.time",
868
+ "refresh.total",
869
+ "rep",
870
+ "request_cache.evictions",
871
+ "request_cache.hit_count",
872
+ "request_cache.memory_size",
873
+ "request_cache.miss_count",
874
+ "search.fetch_current",
875
+ "search.fetch_time",
876
+ "search.fetch_total",
877
+ "search.open_contexts",
878
+ "search.query_current",
879
+ "search.query_time",
880
+ "search.query_total",
881
+ "search.scroll_current",
882
+ "search.scroll_time",
883
+ "search.scroll_total",
884
+ "segments.count",
885
+ "segments.fixed_bitset_memory",
886
+ "segments.index_writer_memory",
887
+ "segments.memory",
888
+ "segments.version_map_memory",
889
+ "sparse_vector.value_count",
890
+ "status",
891
+ "store.size",
892
+ "suggest.current",
893
+ "suggest.time",
894
+ "suggest.total",
895
+ "uuid",
896
+ "warmer.current",
897
+ "warmer.total",
898
+ "warmer.total_time",
899
+ ],
900
+ ]
901
+ ],
902
+ t.Union[
903
+ str,
904
+ t.Literal[
905
+ "bulk.avg_size_in_bytes",
906
+ "bulk.avg_time",
907
+ "bulk.total_operations",
908
+ "bulk.total_size_in_bytes",
909
+ "bulk.total_time",
910
+ "completion.size",
911
+ "creation.date",
912
+ "creation.date.string",
913
+ "dataset.size",
914
+ "dense_vector.value_count",
915
+ "docs.count",
916
+ "docs.deleted",
917
+ "fielddata.evictions",
918
+ "fielddata.memory_size",
919
+ "flush.total",
920
+ "flush.total_time",
921
+ "get.current",
922
+ "get.exists_time",
923
+ "get.exists_total",
924
+ "get.missing_time",
925
+ "get.missing_total",
926
+ "get.time",
927
+ "get.total",
928
+ "health",
929
+ "index",
930
+ "indexing.delete_current",
931
+ "indexing.delete_time",
932
+ "indexing.delete_total",
933
+ "indexing.index_current",
934
+ "indexing.index_failed",
935
+ "indexing.index_failed_due_to_version_conflict",
936
+ "indexing.index_time",
937
+ "indexing.index_total",
938
+ "memory.total",
939
+ "merges.current",
940
+ "merges.current_docs",
941
+ "merges.current_size",
942
+ "merges.total",
943
+ "merges.total_docs",
944
+ "merges.total_size",
945
+ "merges.total_time",
946
+ "pri",
947
+ "pri.bulk.avg_size_in_bytes",
948
+ "pri.bulk.avg_time",
949
+ "pri.bulk.total_operations",
950
+ "pri.bulk.total_size_in_bytes",
951
+ "pri.bulk.total_time",
952
+ "pri.completion.size",
953
+ "pri.dense_vector.value_count",
954
+ "pri.fielddata.evictions",
955
+ "pri.fielddata.memory_size",
956
+ "pri.flush.total",
957
+ "pri.flush.total_time",
958
+ "pri.get.current",
959
+ "pri.get.exists_time",
960
+ "pri.get.exists_total",
961
+ "pri.get.missing_time",
962
+ "pri.get.missing_total",
963
+ "pri.get.time",
964
+ "pri.get.total",
965
+ "pri.indexing.delete_current",
966
+ "pri.indexing.delete_time",
967
+ "pri.indexing.delete_total",
968
+ "pri.indexing.index_current",
969
+ "pri.indexing.index_failed",
970
+ "pri.indexing.index_failed_due_to_version_conflict",
971
+ "pri.indexing.index_time",
972
+ "pri.indexing.index_total",
973
+ "pri.memory.total",
974
+ "pri.merges.current",
975
+ "pri.merges.current_docs",
976
+ "pri.merges.current_size",
977
+ "pri.merges.total",
978
+ "pri.merges.total_docs",
979
+ "pri.merges.total_size",
980
+ "pri.merges.total_time",
981
+ "pri.query_cache.evictions",
982
+ "pri.query_cache.memory_size",
983
+ "pri.refresh.external_time",
984
+ "pri.refresh.external_total",
985
+ "pri.refresh.listeners",
986
+ "pri.refresh.time",
987
+ "pri.refresh.total",
988
+ "pri.request_cache.evictions",
989
+ "pri.request_cache.hit_count",
990
+ "pri.request_cache.memory_size",
991
+ "pri.request_cache.miss_count",
992
+ "pri.search.fetch_current",
993
+ "pri.search.fetch_time",
994
+ "pri.search.fetch_total",
995
+ "pri.search.open_contexts",
996
+ "pri.search.query_current",
997
+ "pri.search.query_time",
998
+ "pri.search.query_total",
999
+ "pri.search.scroll_current",
1000
+ "pri.search.scroll_time",
1001
+ "pri.search.scroll_total",
1002
+ "pri.segments.count",
1003
+ "pri.segments.fixed_bitset_memory",
1004
+ "pri.segments.index_writer_memory",
1005
+ "pri.segments.memory",
1006
+ "pri.segments.version_map_memory",
1007
+ "pri.sparse_vector.value_count",
1008
+ "pri.store.size",
1009
+ "pri.suggest.current",
1010
+ "pri.suggest.time",
1011
+ "pri.suggest.total",
1012
+ "pri.warmer.current",
1013
+ "pri.warmer.total",
1014
+ "pri.warmer.total_time",
1015
+ "query_cache.evictions",
1016
+ "query_cache.memory_size",
1017
+ "refresh.external_time",
1018
+ "refresh.external_total",
1019
+ "refresh.listeners",
1020
+ "refresh.time",
1021
+ "refresh.total",
1022
+ "rep",
1023
+ "request_cache.evictions",
1024
+ "request_cache.hit_count",
1025
+ "request_cache.memory_size",
1026
+ "request_cache.miss_count",
1027
+ "search.fetch_current",
1028
+ "search.fetch_time",
1029
+ "search.fetch_total",
1030
+ "search.open_contexts",
1031
+ "search.query_current",
1032
+ "search.query_time",
1033
+ "search.query_total",
1034
+ "search.scroll_current",
1035
+ "search.scroll_time",
1036
+ "search.scroll_total",
1037
+ "segments.count",
1038
+ "segments.fixed_bitset_memory",
1039
+ "segments.index_writer_memory",
1040
+ "segments.memory",
1041
+ "segments.version_map_memory",
1042
+ "sparse_vector.value_count",
1043
+ "status",
1044
+ "store.size",
1045
+ "suggest.current",
1046
+ "suggest.time",
1047
+ "suggest.total",
1048
+ "uuid",
1049
+ "warmer.current",
1050
+ "warmer.total",
1051
+ "warmer.total_time",
1052
+ ],
1053
+ ],
1054
+ ]
1055
+ ] = None,
1056
+ health: t.Optional[
1057
+ t.Union[str, t.Literal["green", "red", "unavailable", "unknown", "yellow"]]
1058
+ ] = None,
588
1059
  help: t.Optional[bool] = None,
589
1060
  human: t.Optional[bool] = None,
590
1061
  include_unloaded_segments: t.Optional[bool] = None,
@@ -625,7 +1096,8 @@ class CatClient(NamespacedClient):
625
1096
  :param expand_wildcards: The type of index that wildcard patterns can match.
626
1097
  :param format: Specifies the format to return the columnar data in, can be set
627
1098
  to `text`, `json`, `cbor`, `yaml`, or `smile`.
628
- :param h: List of columns to appear in the response. Supports simple wildcards.
1099
+ :param h: A comma-separated list of columns names to display. It supports simple
1100
+ wildcards.
629
1101
  :param health: The health status used to limit returned indices. By default,
630
1102
  the response includes indices of any health status.
631
1103
  :param help: When set to `true` will output available columns. This option can't
@@ -697,7 +1169,12 @@ class CatClient(NamespacedClient):
697
1169
  error_trace: t.Optional[bool] = None,
698
1170
  filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
699
1171
  format: t.Optional[str] = None,
700
- h: t.Optional[t.Union[str, t.Sequence[str]]] = None,
1172
+ h: t.Optional[
1173
+ t.Union[
1174
+ t.Sequence[t.Union[str, t.Literal["host", "id", "ip", "node"]]],
1175
+ t.Union[str, t.Literal["host", "id", "ip", "node"]],
1176
+ ]
1177
+ ] = None,
701
1178
  help: t.Optional[bool] = None,
702
1179
  human: t.Optional[bool] = None,
703
1180
  local: t.Optional[bool] = None,
@@ -718,7 +1195,8 @@ class CatClient(NamespacedClient):
718
1195
 
719
1196
  :param format: Specifies the format to return the columnar data in, can be set
720
1197
  to `text`, `json`, `cbor`, `yaml`, or `smile`.
721
- :param h: List of columns to appear in the response. Supports simple wildcards.
1198
+ :param h: A comma-separated list of columns names to display. It supports simple
1199
+ wildcards.
722
1200
  :param help: When set to `true` will output available columns. This option can't
723
1201
  be combined with any other query string option.
724
1202
  :param local: If `true`, the request computes the list of selected nodes from
@@ -1687,15 +2165,32 @@ class CatClient(NamespacedClient):
1687
2165
  error_trace: t.Optional[bool] = None,
1688
2166
  filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
1689
2167
  format: t.Optional[str] = None,
1690
- h: t.Optional[t.Union[str, t.Sequence[str]]] = None,
1691
- help: t.Optional[bool] = None,
1692
- human: t.Optional[bool] = None,
1693
- local: t.Optional[bool] = None,
1694
- master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
1695
- pretty: t.Optional[bool] = None,
1696
- s: t.Optional[t.Union[str, t.Sequence[str]]] = None,
1697
- v: t.Optional[bool] = None,
1698
- ) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
2168
+ h: t.Optional[
2169
+ t.Union[
2170
+ t.Sequence[
2171
+ t.Union[
2172
+ str,
2173
+ t.Literal[
2174
+ "attr", "host", "id", "ip", "node", "pid", "port", "value"
2175
+ ],
2176
+ ]
2177
+ ],
2178
+ t.Union[
2179
+ str,
2180
+ t.Literal[
2181
+ "attr", "host", "id", "ip", "node", "pid", "port", "value"
2182
+ ],
2183
+ ],
2184
+ ]
2185
+ ] = None,
2186
+ help: t.Optional[bool] = None,
2187
+ human: t.Optional[bool] = None,
2188
+ local: t.Optional[bool] = None,
2189
+ master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
2190
+ pretty: t.Optional[bool] = None,
2191
+ s: t.Optional[t.Union[str, t.Sequence[str]]] = None,
2192
+ v: t.Optional[bool] = None,
2193
+ ) -> t.Union[ObjectApiResponse[t.Any], TextApiResponse]:
1699
2194
  """
1700
2195
  .. raw:: html
1701
2196
 
@@ -1708,7 +2203,8 @@ class CatClient(NamespacedClient):
1708
2203
 
1709
2204
  :param format: Specifies the format to return the columnar data in, can be set
1710
2205
  to `text`, `json`, `cbor`, `yaml`, or `smile`.
1711
- :param h: List of columns to appear in the response. Supports simple wildcards.
2206
+ :param h: A comma-separated list of columns names to display. It supports simple
2207
+ wildcards.
1712
2208
  :param help: When set to `true` will output available columns. This option can't
1713
2209
  be combined with any other query string option.
1714
2210
  :param local: If `true`, the request computes the list of selected nodes from
@@ -2048,7 +2544,19 @@ class CatClient(NamespacedClient):
2048
2544
  error_trace: t.Optional[bool] = None,
2049
2545
  filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
2050
2546
  format: t.Optional[str] = None,
2051
- h: t.Optional[t.Union[str, t.Sequence[str]]] = None,
2547
+ h: t.Optional[
2548
+ t.Union[
2549
+ t.Sequence[
2550
+ t.Union[
2551
+ str,
2552
+ t.Literal["insertOrder", "priority", "source", "timeInQueue"],
2553
+ ]
2554
+ ],
2555
+ t.Union[
2556
+ str, t.Literal["insertOrder", "priority", "source", "timeInQueue"]
2557
+ ],
2558
+ ]
2559
+ ] = None,
2052
2560
  help: t.Optional[bool] = None,
2053
2561
  human: t.Optional[bool] = None,
2054
2562
  local: t.Optional[bool] = None,
@@ -2072,7 +2580,8 @@ class CatClient(NamespacedClient):
2072
2580
 
2073
2581
  :param format: Specifies the format to return the columnar data in, can be set
2074
2582
  to `text`, `json`, `cbor`, `yaml`, or `smile`.
2075
- :param h: List of columns to appear in the response. Supports simple wildcards.
2583
+ :param h: A comma-separated list of columns names to display. It supports simple
2584
+ wildcards.
2076
2585
  :param help: When set to `true` will output available columns. This option can't
2077
2586
  be combined with any other query string option.
2078
2587
  :param local: If `true`, the request computes the list of selected nodes from
@@ -2130,7 +2639,19 @@ class CatClient(NamespacedClient):
2130
2639
  error_trace: t.Optional[bool] = None,
2131
2640
  filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
2132
2641
  format: t.Optional[str] = None,
2133
- h: t.Optional[t.Union[str, t.Sequence[str]]] = None,
2642
+ h: t.Optional[
2643
+ t.Union[
2644
+ t.Sequence[
2645
+ t.Union[
2646
+ str,
2647
+ t.Literal["component", "description", "id", "name", "version"],
2648
+ ]
2649
+ ],
2650
+ t.Union[
2651
+ str, t.Literal["component", "description", "id", "name", "version"]
2652
+ ],
2653
+ ]
2654
+ ] = None,
2134
2655
  help: t.Optional[bool] = None,
2135
2656
  human: t.Optional[bool] = None,
2136
2657
  include_bootstrap: t.Optional[bool] = None,
@@ -2152,7 +2673,8 @@ class CatClient(NamespacedClient):
2152
2673
 
2153
2674
  :param format: Specifies the format to return the columnar data in, can be set
2154
2675
  to `text`, `json`, `cbor`, `yaml`, or `smile`.
2155
- :param h: List of columns to appear in the response. Supports simple wildcards.
2676
+ :param h: A comma-separated list of columns names to display. It supports simple
2677
+ wildcards.
2156
2678
  :param help: When set to `true` will output available columns. This option can't
2157
2679
  be combined with any other query string option.
2158
2680
  :param include_bootstrap: Include bootstrap plugins in the response
@@ -2216,7 +2738,74 @@ class CatClient(NamespacedClient):
2216
2738
  error_trace: t.Optional[bool] = None,
2217
2739
  filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
2218
2740
  format: t.Optional[str] = None,
2219
- h: t.Optional[t.Union[str, t.Sequence[str]]] = None,
2741
+ h: t.Optional[
2742
+ t.Union[
2743
+ t.Sequence[
2744
+ t.Union[
2745
+ str,
2746
+ t.Literal[
2747
+ "bytes",
2748
+ "bytes_percent",
2749
+ "bytes_recovered",
2750
+ "bytes_total",
2751
+ "files",
2752
+ "files_percent",
2753
+ "files_recovered",
2754
+ "files_total",
2755
+ "index",
2756
+ "repository",
2757
+ "shard",
2758
+ "snapshot",
2759
+ "source_host",
2760
+ "source_node",
2761
+ "stage",
2762
+ "start_time",
2763
+ "start_time_millis",
2764
+ "stop_time",
2765
+ "stop_time_millis",
2766
+ "target_host",
2767
+ "target_node",
2768
+ "time",
2769
+ "translog_ops",
2770
+ "translog_ops_percent",
2771
+ "translog_ops_recovered",
2772
+ "type",
2773
+ ],
2774
+ ]
2775
+ ],
2776
+ t.Union[
2777
+ str,
2778
+ t.Literal[
2779
+ "bytes",
2780
+ "bytes_percent",
2781
+ "bytes_recovered",
2782
+ "bytes_total",
2783
+ "files",
2784
+ "files_percent",
2785
+ "files_recovered",
2786
+ "files_total",
2787
+ "index",
2788
+ "repository",
2789
+ "shard",
2790
+ "snapshot",
2791
+ "source_host",
2792
+ "source_node",
2793
+ "stage",
2794
+ "start_time",
2795
+ "start_time_millis",
2796
+ "stop_time",
2797
+ "stop_time_millis",
2798
+ "target_host",
2799
+ "target_node",
2800
+ "time",
2801
+ "translog_ops",
2802
+ "translog_ops_percent",
2803
+ "translog_ops_recovered",
2804
+ "type",
2805
+ ],
2806
+ ],
2807
+ ]
2808
+ ] = None,
2220
2809
  help: t.Optional[bool] = None,
2221
2810
  human: t.Optional[bool] = None,
2222
2811
  pretty: t.Optional[bool] = None,
@@ -2247,13 +2836,14 @@ class CatClient(NamespacedClient):
2247
2836
  shard recoveries.
2248
2837
  :param format: Specifies the format to return the columnar data in, can be set
2249
2838
  to `text`, `json`, `cbor`, `yaml`, or `smile`.
2250
- :param h: List of columns to appear in the response. Supports simple wildcards.
2839
+ :param h: A comma-separated list of columns names to display. It supports simple
2840
+ wildcards.
2251
2841
  :param help: When set to `true` will output available columns. This option can't
2252
2842
  be combined with any other query string option.
2253
- :param s: List of columns that determine how the table should be sorted. Sorting
2254
- defaults to ascending and can be changed by setting `:asc` or `:desc` as
2255
- a suffix to the column name.
2256
- :param time: Unit used to display time values.
2843
+ :param s: A comma-separated list of column names or aliases that determines the
2844
+ sort order. Sorting defaults to ascending and can be changed by setting `:asc`
2845
+ or `:desc` as a suffix to the column name.
2846
+ :param time: The unit used to display time values.
2257
2847
  :param v: When set to `true` will enable verbose output.
2258
2848
  """
2259
2849
  __path_parts: t.Dict[str, str]
@@ -2387,7 +2977,52 @@ class CatClient(NamespacedClient):
2387
2977
  error_trace: t.Optional[bool] = None,
2388
2978
  filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
2389
2979
  format: t.Optional[str] = None,
2390
- h: t.Optional[t.Union[str, t.Sequence[str]]] = None,
2980
+ h: t.Optional[
2981
+ t.Union[
2982
+ t.Sequence[
2983
+ t.Union[
2984
+ str,
2985
+ t.Literal[
2986
+ "committed",
2987
+ "compound",
2988
+ "docs.count",
2989
+ "docs.deleted",
2990
+ "generation",
2991
+ "id",
2992
+ "index",
2993
+ "ip",
2994
+ "prirep",
2995
+ "searchable",
2996
+ "segment",
2997
+ "shard",
2998
+ "size",
2999
+ "size.memory",
3000
+ "version",
3001
+ ],
3002
+ ]
3003
+ ],
3004
+ t.Union[
3005
+ str,
3006
+ t.Literal[
3007
+ "committed",
3008
+ "compound",
3009
+ "docs.count",
3010
+ "docs.deleted",
3011
+ "generation",
3012
+ "id",
3013
+ "index",
3014
+ "ip",
3015
+ "prirep",
3016
+ "searchable",
3017
+ "segment",
3018
+ "shard",
3019
+ "size",
3020
+ "size.memory",
3021
+ "version",
3022
+ ],
3023
+ ],
3024
+ ]
3025
+ ] = None,
2391
3026
  help: t.Optional[bool] = None,
2392
3027
  human: t.Optional[bool] = None,
2393
3028
  local: t.Optional[bool] = None,
@@ -2413,7 +3048,8 @@ class CatClient(NamespacedClient):
2413
3048
  :param bytes: The unit used to display byte values.
2414
3049
  :param format: Specifies the format to return the columnar data in, can be set
2415
3050
  to `text`, `json`, `cbor`, `yaml`, or `smile`.
2416
- :param h: List of columns to appear in the response. Supports simple wildcards.
3051
+ :param h: A comma-separated list of columns names to display. It supports simple
3052
+ wildcards.
2417
3053
  :param help: When set to `true` will output available columns. This option can't
2418
3054
  be combined with any other query string option.
2419
3055
  :param local: If `true`, the request computes the list of selected nodes from
@@ -2421,9 +3057,9 @@ class CatClient(NamespacedClient):
2421
3057
  from the cluster state of the master node. In both cases the coordinating
2422
3058
  node will send requests for further information to each selected node.
2423
3059
  :param master_timeout: Period to wait for a connection to the master node.
2424
- :param s: List of columns that determine how the table should be sorted. Sorting
2425
- defaults to ascending and can be changed by setting `:asc` or `:desc` as
2426
- a suffix to the column name.
3060
+ :param s: A comma-separated list of column names or aliases that determines the
3061
+ sort order. Sorting defaults to ascending and can be changed by setting `:asc`
3062
+ or `:desc` as a suffix to the column name.
2427
3063
  :param v: When set to `true` will enable verbose output.
2428
3064
  """
2429
3065
  __path_parts: t.Dict[str, str]
@@ -2479,7 +3115,162 @@ class CatClient(NamespacedClient):
2479
3115
  error_trace: t.Optional[bool] = None,
2480
3116
  filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
2481
3117
  format: t.Optional[str] = None,
2482
- h: t.Optional[t.Union[str, t.Sequence[str]]] = None,
3118
+ h: t.Optional[
3119
+ t.Union[
3120
+ t.Sequence[
3121
+ t.Union[
3122
+ str,
3123
+ t.Literal[
3124
+ "completion.size",
3125
+ "dataset.size",
3126
+ "dense_vector.value_count",
3127
+ "docs",
3128
+ "dsparse_vector.value_count",
3129
+ "fielddata.evictions",
3130
+ "fielddata.memory_size",
3131
+ "flush.total",
3132
+ "flush.total_time",
3133
+ "get.current",
3134
+ "get.exists_time",
3135
+ "get.exists_total",
3136
+ "get.missing_time",
3137
+ "get.missing_total",
3138
+ "get.time",
3139
+ "get.total",
3140
+ "id",
3141
+ "index",
3142
+ "indexing.delete_current",
3143
+ "indexing.delete_time",
3144
+ "indexing.delete_total",
3145
+ "indexing.index_current",
3146
+ "indexing.index_failed",
3147
+ "indexing.index_failed_due_to_version_conflict",
3148
+ "indexing.index_time",
3149
+ "indexing.index_total",
3150
+ "ip",
3151
+ "merges.current",
3152
+ "merges.current_docs",
3153
+ "merges.current_size",
3154
+ "merges.total",
3155
+ "merges.total_docs",
3156
+ "merges.total_size",
3157
+ "merges.total_time",
3158
+ "node",
3159
+ "prirep",
3160
+ "query_cache.evictions",
3161
+ "query_cache.memory_size",
3162
+ "recoverysource.type",
3163
+ "refresh.time",
3164
+ "refresh.total",
3165
+ "search.fetch_current",
3166
+ "search.fetch_time",
3167
+ "search.fetch_total",
3168
+ "search.open_contexts",
3169
+ "search.query_current",
3170
+ "search.query_time",
3171
+ "search.query_total",
3172
+ "search.scroll_current",
3173
+ "search.scroll_time",
3174
+ "search.scroll_total",
3175
+ "segments.count",
3176
+ "segments.fixed_bitset_memory",
3177
+ "segments.index_writer_memory",
3178
+ "segments.memory",
3179
+ "segments.version_map_memory",
3180
+ "seq_no.global_checkpoint",
3181
+ "seq_no.local_checkpoint",
3182
+ "seq_no.max",
3183
+ "shard",
3184
+ "state",
3185
+ "store",
3186
+ "suggest.current",
3187
+ "suggest.time",
3188
+ "suggest.total",
3189
+ "sync_id",
3190
+ "unassigned.at",
3191
+ "unassigned.details",
3192
+ "unassigned.for",
3193
+ "unassigned.reason",
3194
+ ],
3195
+ ]
3196
+ ],
3197
+ t.Union[
3198
+ str,
3199
+ t.Literal[
3200
+ "completion.size",
3201
+ "dataset.size",
3202
+ "dense_vector.value_count",
3203
+ "docs",
3204
+ "dsparse_vector.value_count",
3205
+ "fielddata.evictions",
3206
+ "fielddata.memory_size",
3207
+ "flush.total",
3208
+ "flush.total_time",
3209
+ "get.current",
3210
+ "get.exists_time",
3211
+ "get.exists_total",
3212
+ "get.missing_time",
3213
+ "get.missing_total",
3214
+ "get.time",
3215
+ "get.total",
3216
+ "id",
3217
+ "index",
3218
+ "indexing.delete_current",
3219
+ "indexing.delete_time",
3220
+ "indexing.delete_total",
3221
+ "indexing.index_current",
3222
+ "indexing.index_failed",
3223
+ "indexing.index_failed_due_to_version_conflict",
3224
+ "indexing.index_time",
3225
+ "indexing.index_total",
3226
+ "ip",
3227
+ "merges.current",
3228
+ "merges.current_docs",
3229
+ "merges.current_size",
3230
+ "merges.total",
3231
+ "merges.total_docs",
3232
+ "merges.total_size",
3233
+ "merges.total_time",
3234
+ "node",
3235
+ "prirep",
3236
+ "query_cache.evictions",
3237
+ "query_cache.memory_size",
3238
+ "recoverysource.type",
3239
+ "refresh.time",
3240
+ "refresh.total",
3241
+ "search.fetch_current",
3242
+ "search.fetch_time",
3243
+ "search.fetch_total",
3244
+ "search.open_contexts",
3245
+ "search.query_current",
3246
+ "search.query_time",
3247
+ "search.query_total",
3248
+ "search.scroll_current",
3249
+ "search.scroll_time",
3250
+ "search.scroll_total",
3251
+ "segments.count",
3252
+ "segments.fixed_bitset_memory",
3253
+ "segments.index_writer_memory",
3254
+ "segments.memory",
3255
+ "segments.version_map_memory",
3256
+ "seq_no.global_checkpoint",
3257
+ "seq_no.local_checkpoint",
3258
+ "seq_no.max",
3259
+ "shard",
3260
+ "state",
3261
+ "store",
3262
+ "suggest.current",
3263
+ "suggest.time",
3264
+ "suggest.total",
3265
+ "sync_id",
3266
+ "unassigned.at",
3267
+ "unassigned.details",
3268
+ "unassigned.for",
3269
+ "unassigned.reason",
3270
+ ],
3271
+ ],
3272
+ ]
3273
+ ] = None,
2483
3274
  help: t.Optional[bool] = None,
2484
3275
  human: t.Optional[bool] = None,
2485
3276
  master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
@@ -2510,11 +3301,11 @@ class CatClient(NamespacedClient):
2510
3301
  :param h: List of columns to appear in the response. Supports simple wildcards.
2511
3302
  :param help: When set to `true` will output available columns. This option can't
2512
3303
  be combined with any other query string option.
2513
- :param master_timeout: Period to wait for a connection to the master node.
2514
- :param s: List of columns that determine how the table should be sorted. Sorting
2515
- defaults to ascending and can be changed by setting `:asc` or `:desc` as
2516
- a suffix to the column name.
2517
- :param time: Unit used to display time values.
3304
+ :param master_timeout: The period to wait for a connection to the master node.
3305
+ :param s: A comma-separated list of column names or aliases that determines the
3306
+ sort order. Sorting defaults to ascending and can be changed by setting `:asc`
3307
+ or `:desc` as a suffix to the column name.
3308
+ :param time: The unit used to display time values.
2518
3309
  :param v: When set to `true` will enable verbose output.
2519
3310
  """
2520
3311
  __path_parts: t.Dict[str, str]
@@ -2567,7 +3358,48 @@ class CatClient(NamespacedClient):
2567
3358
  error_trace: t.Optional[bool] = None,
2568
3359
  filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
2569
3360
  format: t.Optional[str] = None,
2570
- h: t.Optional[t.Union[str, t.Sequence[str]]] = None,
3361
+ h: t.Optional[
3362
+ t.Union[
3363
+ t.Sequence[
3364
+ t.Union[
3365
+ str,
3366
+ t.Literal[
3367
+ "duration",
3368
+ "end_epoch",
3369
+ "end_time",
3370
+ "failed_shards",
3371
+ "id",
3372
+ "indices",
3373
+ "reason",
3374
+ "repository",
3375
+ "start_epoch",
3376
+ "start_time",
3377
+ "status",
3378
+ "successful_shards",
3379
+ "total_shards",
3380
+ ],
3381
+ ]
3382
+ ],
3383
+ t.Union[
3384
+ str,
3385
+ t.Literal[
3386
+ "duration",
3387
+ "end_epoch",
3388
+ "end_time",
3389
+ "failed_shards",
3390
+ "id",
3391
+ "indices",
3392
+ "reason",
3393
+ "repository",
3394
+ "start_epoch",
3395
+ "start_time",
3396
+ "status",
3397
+ "successful_shards",
3398
+ "total_shards",
3399
+ ],
3400
+ ],
3401
+ ]
3402
+ ] = None,
2571
3403
  help: t.Optional[bool] = None,
2572
3404
  human: t.Optional[bool] = None,
2573
3405
  ignore_unavailable: t.Optional[bool] = None,
@@ -2595,7 +3427,8 @@ class CatClient(NamespacedClient):
2595
3427
  If any repository fails during the request, Elasticsearch returns an error.
2596
3428
  :param format: Specifies the format to return the columnar data in, can be set
2597
3429
  to `text`, `json`, `cbor`, `yaml`, or `smile`.
2598
- :param h: List of columns to appear in the response. Supports simple wildcards.
3430
+ :param h: A comma-separated list of columns names to display. It supports simple
3431
+ wildcards.
2599
3432
  :param help: When set to `true` will output available columns. This option can't
2600
3433
  be combined with any other query string option.
2601
3434
  :param ignore_unavailable: If `true`, the response does not include information
@@ -2659,7 +3492,52 @@ class CatClient(NamespacedClient):
2659
3492
  error_trace: t.Optional[bool] = None,
2660
3493
  filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
2661
3494
  format: t.Optional[str] = None,
2662
- h: t.Optional[t.Union[str, t.Sequence[str]]] = None,
3495
+ h: t.Optional[
3496
+ t.Union[
3497
+ t.Sequence[
3498
+ t.Union[
3499
+ str,
3500
+ t.Literal[
3501
+ "action",
3502
+ "id",
3503
+ "ip",
3504
+ "node",
3505
+ "node_id",
3506
+ "parent_task_id",
3507
+ "port",
3508
+ "running_time",
3509
+ "running_time_ns",
3510
+ "start_time",
3511
+ "task_id",
3512
+ "timestamp",
3513
+ "type",
3514
+ "version",
3515
+ "x_opaque_id",
3516
+ ],
3517
+ ]
3518
+ ],
3519
+ t.Union[
3520
+ str,
3521
+ t.Literal[
3522
+ "action",
3523
+ "id",
3524
+ "ip",
3525
+ "node",
3526
+ "node_id",
3527
+ "parent_task_id",
3528
+ "port",
3529
+ "running_time",
3530
+ "running_time_ns",
3531
+ "start_time",
3532
+ "task_id",
3533
+ "timestamp",
3534
+ "type",
3535
+ "version",
3536
+ "x_opaque_id",
3537
+ ],
3538
+ ],
3539
+ ]
3540
+ ] = None,
2663
3541
  help: t.Optional[bool] = None,
2664
3542
  human: t.Optional[bool] = None,
2665
3543
  nodes: t.Optional[t.Sequence[str]] = None,
@@ -2688,7 +3566,8 @@ class CatClient(NamespacedClient):
2688
3566
  shard recoveries.
2689
3567
  :param format: Specifies the format to return the columnar data in, can be set
2690
3568
  to `text`, `json`, `cbor`, `yaml`, or `smile`.
2691
- :param h: List of columns to appear in the response. Supports simple wildcards.
3569
+ :param h: A comma-separated list of columns names to display. It supports simple
3570
+ wildcards.
2692
3571
  :param help: When set to `true` will output available columns. This option can't
2693
3572
  be combined with any other query string option.
2694
3573
  :param nodes: Unique node identifiers, which are used to limit the response.
@@ -2757,7 +3636,24 @@ class CatClient(NamespacedClient):
2757
3636
  error_trace: t.Optional[bool] = None,
2758
3637
  filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
2759
3638
  format: t.Optional[str] = None,
2760
- h: t.Optional[t.Union[str, t.Sequence[str]]] = None,
3639
+ h: t.Optional[
3640
+ t.Union[
3641
+ t.Sequence[
3642
+ t.Union[
3643
+ str,
3644
+ t.Literal[
3645
+ "composed_of", "index_patterns", "name", "order", "version"
3646
+ ],
3647
+ ]
3648
+ ],
3649
+ t.Union[
3650
+ str,
3651
+ t.Literal[
3652
+ "composed_of", "index_patterns", "name", "order", "version"
3653
+ ],
3654
+ ],
3655
+ ]
3656
+ ] = None,
2761
3657
  help: t.Optional[bool] = None,
2762
3658
  human: t.Optional[bool] = None,
2763
3659
  local: t.Optional[bool] = None,
@@ -2781,7 +3677,8 @@ class CatClient(NamespacedClient):
2781
3677
  If omitted, all templates are returned.
2782
3678
  :param format: Specifies the format to return the columnar data in, can be set
2783
3679
  to `text`, `json`, `cbor`, `yaml`, or `smile`.
2784
- :param h: List of columns to appear in the response. Supports simple wildcards.
3680
+ :param h: A comma-separated list of columns names to display. It supports simple
3681
+ wildcards.
2785
3682
  :param help: When set to `true` will output available columns. This option can't
2786
3683
  be combined with any other query string option.
2787
3684
  :param local: If `true`, the request computes the list of selected nodes from
@@ -2842,7 +3739,62 @@ class CatClient(NamespacedClient):
2842
3739
  error_trace: t.Optional[bool] = None,
2843
3740
  filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
2844
3741
  format: t.Optional[str] = None,
2845
- h: t.Optional[t.Union[str, t.Sequence[str]]] = None,
3742
+ h: t.Optional[
3743
+ t.Union[
3744
+ t.Sequence[
3745
+ t.Union[
3746
+ str,
3747
+ t.Literal[
3748
+ "active",
3749
+ "completed",
3750
+ "core",
3751
+ "ephemeral_id",
3752
+ "host",
3753
+ "ip",
3754
+ "keep_alive",
3755
+ "largest",
3756
+ "max",
3757
+ "name",
3758
+ "node_id",
3759
+ "node_name",
3760
+ "pid",
3761
+ "pool_size",
3762
+ "port",
3763
+ "queue",
3764
+ "queue_size",
3765
+ "rejected",
3766
+ "size",
3767
+ "type",
3768
+ ],
3769
+ ]
3770
+ ],
3771
+ t.Union[
3772
+ str,
3773
+ t.Literal[
3774
+ "active",
3775
+ "completed",
3776
+ "core",
3777
+ "ephemeral_id",
3778
+ "host",
3779
+ "ip",
3780
+ "keep_alive",
3781
+ "largest",
3782
+ "max",
3783
+ "name",
3784
+ "node_id",
3785
+ "node_name",
3786
+ "pid",
3787
+ "pool_size",
3788
+ "port",
3789
+ "queue",
3790
+ "queue_size",
3791
+ "rejected",
3792
+ "size",
3793
+ "type",
3794
+ ],
3795
+ ],
3796
+ ]
3797
+ ] = None,
2846
3798
  help: t.Optional[bool] = None,
2847
3799
  human: t.Optional[bool] = None,
2848
3800
  local: t.Optional[bool] = None,
@@ -2876,10 +3828,10 @@ class CatClient(NamespacedClient):
2876
3828
  the local cluster state. If `false` the list of selected nodes are computed
2877
3829
  from the cluster state of the master node. In both cases the coordinating
2878
3830
  node will send requests for further information to each selected node.
2879
- :param master_timeout: Period to wait for a connection to the master node.
2880
- :param s: List of columns that determine how the table should be sorted. Sorting
2881
- defaults to ascending and can be changed by setting `:asc` or `:desc` as
2882
- a suffix to the column name.
3831
+ :param master_timeout: The period to wait for a connection to the master node.
3832
+ :param s: A comma-separated list of column names or aliases that determines the
3833
+ sort order. Sorting defaults to ascending and can be changed by setting `:asc`
3834
+ or `:desc` as a suffix to the column name.
2883
3835
  :param time: The unit used to display time values.
2884
3836
  :param v: When set to `true` will enable verbose output.
2885
3837
  """