elasticsearch9 9.0.2__py3-none-any.whl → 9.1.0__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 (110) hide show
  1. elasticsearch9/__init__.py +3 -3
  2. elasticsearch9/_async/client/__init__.py +88 -244
  3. elasticsearch9/_async/client/async_search.py +4 -4
  4. elasticsearch9/_async/client/autoscaling.py +4 -4
  5. elasticsearch9/_async/client/cat.py +419 -51
  6. elasticsearch9/_async/client/ccr.py +13 -13
  7. elasticsearch9/_async/client/cluster.py +32 -22
  8. elasticsearch9/_async/client/connector.py +30 -30
  9. elasticsearch9/_async/client/dangling_indices.py +3 -3
  10. elasticsearch9/_async/client/enrich.py +5 -5
  11. elasticsearch9/_async/client/eql.py +14 -6
  12. elasticsearch9/_async/client/esql.py +125 -9
  13. elasticsearch9/_async/client/features.py +2 -2
  14. elasticsearch9/_async/client/fleet.py +3 -3
  15. elasticsearch9/_async/client/graph.py +1 -1
  16. elasticsearch9/_async/client/ilm.py +11 -11
  17. elasticsearch9/_async/client/indices.py +592 -113
  18. elasticsearch9/_async/client/inference.py +521 -44
  19. elasticsearch9/_async/client/ingest.py +9 -16
  20. elasticsearch9/_async/client/license.py +11 -11
  21. elasticsearch9/_async/client/logstash.py +3 -3
  22. elasticsearch9/_async/client/migration.py +3 -3
  23. elasticsearch9/_async/client/ml.py +75 -87
  24. elasticsearch9/_async/client/monitoring.py +1 -1
  25. elasticsearch9/_async/client/nodes.py +7 -7
  26. elasticsearch9/_async/client/query_rules.py +8 -8
  27. elasticsearch9/_async/client/rollup.py +9 -30
  28. elasticsearch9/_async/client/search_application.py +10 -10
  29. elasticsearch9/_async/client/searchable_snapshots.py +4 -4
  30. elasticsearch9/_async/client/security.py +79 -81
  31. elasticsearch9/_async/client/shutdown.py +3 -3
  32. elasticsearch9/_async/client/simulate.py +1 -1
  33. elasticsearch9/_async/client/slm.py +9 -9
  34. elasticsearch9/_async/client/snapshot.py +64 -21
  35. elasticsearch9/_async/client/sql.py +6 -6
  36. elasticsearch9/_async/client/ssl.py +1 -1
  37. elasticsearch9/_async/client/synonyms.py +26 -7
  38. elasticsearch9/_async/client/tasks.py +4 -4
  39. elasticsearch9/_async/client/text_structure.py +4 -4
  40. elasticsearch9/_async/client/transform.py +11 -11
  41. elasticsearch9/_async/client/watcher.py +17 -15
  42. elasticsearch9/_async/client/xpack.py +2 -2
  43. elasticsearch9/_otel.py +8 -8
  44. elasticsearch9/_sync/client/__init__.py +88 -244
  45. elasticsearch9/_sync/client/async_search.py +4 -4
  46. elasticsearch9/_sync/client/autoscaling.py +4 -4
  47. elasticsearch9/_sync/client/cat.py +419 -51
  48. elasticsearch9/_sync/client/ccr.py +13 -13
  49. elasticsearch9/_sync/client/cluster.py +32 -22
  50. elasticsearch9/_sync/client/connector.py +30 -30
  51. elasticsearch9/_sync/client/dangling_indices.py +3 -3
  52. elasticsearch9/_sync/client/enrich.py +5 -5
  53. elasticsearch9/_sync/client/eql.py +14 -6
  54. elasticsearch9/_sync/client/esql.py +125 -9
  55. elasticsearch9/_sync/client/features.py +2 -2
  56. elasticsearch9/_sync/client/fleet.py +3 -3
  57. elasticsearch9/_sync/client/graph.py +1 -1
  58. elasticsearch9/_sync/client/ilm.py +11 -11
  59. elasticsearch9/_sync/client/indices.py +592 -113
  60. elasticsearch9/_sync/client/inference.py +521 -44
  61. elasticsearch9/_sync/client/ingest.py +9 -16
  62. elasticsearch9/_sync/client/license.py +11 -11
  63. elasticsearch9/_sync/client/logstash.py +3 -3
  64. elasticsearch9/_sync/client/migration.py +3 -3
  65. elasticsearch9/_sync/client/ml.py +75 -87
  66. elasticsearch9/_sync/client/monitoring.py +1 -1
  67. elasticsearch9/_sync/client/nodes.py +7 -7
  68. elasticsearch9/_sync/client/query_rules.py +8 -8
  69. elasticsearch9/_sync/client/rollup.py +9 -30
  70. elasticsearch9/_sync/client/search_application.py +10 -10
  71. elasticsearch9/_sync/client/searchable_snapshots.py +4 -4
  72. elasticsearch9/_sync/client/security.py +79 -81
  73. elasticsearch9/_sync/client/shutdown.py +3 -3
  74. elasticsearch9/_sync/client/simulate.py +1 -1
  75. elasticsearch9/_sync/client/slm.py +9 -9
  76. elasticsearch9/_sync/client/snapshot.py +64 -21
  77. elasticsearch9/_sync/client/sql.py +6 -6
  78. elasticsearch9/_sync/client/ssl.py +1 -1
  79. elasticsearch9/_sync/client/synonyms.py +26 -7
  80. elasticsearch9/_sync/client/tasks.py +4 -4
  81. elasticsearch9/_sync/client/text_structure.py +4 -4
  82. elasticsearch9/_sync/client/transform.py +11 -11
  83. elasticsearch9/_sync/client/watcher.py +17 -15
  84. elasticsearch9/_sync/client/xpack.py +2 -2
  85. elasticsearch9/_version.py +1 -1
  86. elasticsearch9/compat.py +5 -0
  87. elasticsearch9/dsl/__init__.py +2 -1
  88. elasticsearch9/dsl/aggs.py +20 -0
  89. elasticsearch9/dsl/document_base.py +177 -17
  90. elasticsearch9/dsl/field.py +230 -37
  91. elasticsearch9/dsl/query.py +6 -3
  92. elasticsearch9/dsl/response/__init__.py +1 -1
  93. elasticsearch9/dsl/types.py +169 -11
  94. elasticsearch9/dsl/utils.py +1 -1
  95. elasticsearch9/{dsl/_sync/_sync_check → esql}/__init__.py +2 -0
  96. elasticsearch9/esql/esql.py +1105 -0
  97. elasticsearch9/esql/esql1.py1 +307 -0
  98. elasticsearch9/esql/functions.py +1738 -0
  99. {elasticsearch9-9.0.2.dist-info → elasticsearch9-9.1.0.dist-info}/METADATA +3 -4
  100. elasticsearch9-9.1.0.dist-info/RECORD +164 -0
  101. elasticsearch9/dsl/_sync/_sync_check/document.py +0 -514
  102. elasticsearch9/dsl/_sync/_sync_check/faceted_search.py +0 -50
  103. elasticsearch9/dsl/_sync/_sync_check/index.py +0 -597
  104. elasticsearch9/dsl/_sync/_sync_check/mapping.py +0 -49
  105. elasticsearch9/dsl/_sync/_sync_check/search.py +0 -230
  106. elasticsearch9/dsl/_sync/_sync_check/update_by_query.py +0 -45
  107. elasticsearch9-9.0.2.dist-info/RECORD +0 -167
  108. {elasticsearch9-9.0.2.dist-info → elasticsearch9-9.1.0.dist-info}/WHEEL +0 -0
  109. {elasticsearch9-9.0.2.dist-info → elasticsearch9-9.1.0.dist-info}/licenses/LICENSE +0 -0
  110. {elasticsearch9-9.0.2.dist-info → elasticsearch9-9.1.0.dist-info}/licenses/NOTICE +0 -0
@@ -43,7 +43,7 @@ class CcrClient(NamespacedClient):
43
43
  <p>Delete a collection of cross-cluster replication auto-follow patterns.</p>
44
44
 
45
45
 
46
- `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ccr-delete-auto-follow-pattern>`_
46
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-delete-auto-follow-pattern>`_
47
47
 
48
48
  :param name: The auto-follow pattern collection to delete.
49
49
  :param master_timeout: The period to wait for a connection to the master node.
@@ -130,7 +130,7 @@ class CcrClient(NamespacedClient):
130
130
  When the API returns, the follower index exists and cross-cluster replication starts replicating operations from the leader index to the follower index.</p>
131
131
 
132
132
 
133
- `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ccr-follow>`_
133
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-follow>`_
134
134
 
135
135
  :param index: The name of the follower index.
136
136
  :param leader_index: The name of the index in the leader cluster to follow.
@@ -259,7 +259,7 @@ class CcrClient(NamespacedClient):
259
259
  For example, the results include follower index names, leader index names, replication options, and whether the follower indices are active or paused.</p>
260
260
 
261
261
 
262
- `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ccr-follow-info>`_
262
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-follow-info>`_
263
263
 
264
264
  :param index: A comma-delimited list of follower index patterns.
265
265
  :param master_timeout: The period to wait for a connection to the master node.
@@ -311,7 +311,7 @@ class CcrClient(NamespacedClient):
311
311
  The API returns shard-level stats about the &quot;following tasks&quot; associated with each shard for the specified indices.</p>
312
312
 
313
313
 
314
- `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ccr-follow-stats>`_
314
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-follow-stats>`_
315
315
 
316
316
  :param index: A comma-delimited list of index patterns.
317
317
  :param timeout: The period to wait for a response. If no response is received
@@ -380,7 +380,7 @@ class CcrClient(NamespacedClient):
380
380
  The only purpose of this API is to handle the case of failure to remove the following retention leases after the unfollow API is invoked.</p>
381
381
 
382
382
 
383
- `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ccr-forget-follower>`_
383
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-forget-follower>`_
384
384
 
385
385
  :param index: the name of the leader index for which specified follower retention
386
386
  leases should be removed
@@ -445,7 +445,7 @@ class CcrClient(NamespacedClient):
445
445
  <p>Get cross-cluster replication auto-follow patterns.</p>
446
446
 
447
447
 
448
- `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ccr-get-auto-follow-pattern-1>`_
448
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-get-auto-follow-pattern-1>`_
449
449
 
450
450
  :param name: The auto-follow pattern collection that you want to retrieve. If
451
451
  you do not specify a name, the API returns information for all collections.
@@ -505,7 +505,7 @@ class CcrClient(NamespacedClient):
505
505
  Remote indices that were created while the pattern was paused will also be followed, unless they have been deleted or closed in the interim.</p>
506
506
 
507
507
 
508
- `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ccr-pause-auto-follow-pattern>`_
508
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-pause-auto-follow-pattern>`_
509
509
 
510
510
  :param name: The name of the auto-follow pattern to pause.
511
511
  :param master_timeout: The period to wait for a connection to the master node.
@@ -559,7 +559,7 @@ class CcrClient(NamespacedClient):
559
559
  You can pause and resume a follower index to change the configuration of the following task.</p>
560
560
 
561
561
 
562
- `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ccr-pause-follow>`_
562
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-pause-follow>`_
563
563
 
564
564
  :param index: The name of the follower index.
565
565
  :param master_timeout: The period to wait for a connection to the master node.
@@ -648,7 +648,7 @@ class CcrClient(NamespacedClient):
648
648
  NOTE: Follower indices that were configured automatically before updating an auto-follow pattern will remain unchanged even if they do not match against the new patterns.</p>
649
649
 
650
650
 
651
- `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ccr-put-auto-follow-pattern>`_
651
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-put-auto-follow-pattern>`_
652
652
 
653
653
  :param name: The name of the collection of auto-follow patterns.
654
654
  :param remote_cluster: The remote cluster containing the leader indices to match
@@ -782,7 +782,7 @@ class CcrClient(NamespacedClient):
782
782
  Remote indices created while the pattern was paused will also be followed unless they have been deleted or closed in the interim.</p>
783
783
 
784
784
 
785
- `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ccr-resume-auto-follow-pattern>`_
785
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-resume-auto-follow-pattern>`_
786
786
 
787
787
  :param name: The name of the auto-follow pattern to resume.
788
788
  :param master_timeout: The period to wait for a connection to the master node.
@@ -860,7 +860,7 @@ class CcrClient(NamespacedClient):
860
860
  When this API returns, the follower index will resume fetching operations from the leader index.</p>
861
861
 
862
862
 
863
- `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ccr-resume-follow>`_
863
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-resume-follow>`_
864
864
 
865
865
  :param index: The name of the follow index to resume following.
866
866
  :param master_timeout: Period to wait for a connection to the master node.
@@ -951,7 +951,7 @@ class CcrClient(NamespacedClient):
951
951
  <p>This API returns stats about auto-following and the same shard-level stats as the get follower stats API.</p>
952
952
 
953
953
 
954
- `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ccr-stats>`_
954
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-stats>`_
955
955
 
956
956
  :param master_timeout: The period to wait for a connection to the master node.
957
957
  If the master node is not available before the timeout expires, the request
@@ -1009,7 +1009,7 @@ class CcrClient(NamespacedClient):
1009
1009
  </blockquote>
1010
1010
 
1011
1011
 
1012
- `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ccr-unfollow>`_
1012
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-unfollow>`_
1013
1013
 
1014
1014
  :param index: The name of the follower index.
1015
1015
  :param master_timeout: The period to wait for a connection to the master node.
@@ -51,10 +51,11 @@ class ClusterClient(NamespacedClient):
51
51
  Get explanations for shard allocations in the cluster.
52
52
  For unassigned shards, it provides an explanation for why the shard is unassigned.
53
53
  For assigned shards, it provides an explanation for why the shard is remaining on its current node and has not moved or rebalanced to another node.
54
- This API can be very useful when attempting to diagnose why a shard is unassigned or why a shard continues to remain on its current node when you might expect otherwise.</p>
54
+ This API can be very useful when attempting to diagnose why a shard is unassigned or why a shard continues to remain on its current node when you might expect otherwise.
55
+ Refer to the linked documentation for examples of how to troubleshoot allocation issues using this API.</p>
55
56
 
56
57
 
57
- `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cluster-allocation-explain>`_
58
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-allocation-explain>`_
58
59
 
59
60
  :param current_node: Specifies the node ID or the name of the node to only explain
60
61
  a shard that is currently located on the specified node.
@@ -130,7 +131,7 @@ class ClusterClient(NamespacedClient):
130
131
  Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.</p>
131
132
 
132
133
 
133
- `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cluster-put-component-template>`_
134
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-component-template>`_
134
135
 
135
136
  :param name: Comma-separated list or wildcard expression of component template
136
137
  names used to limit the request.
@@ -185,7 +186,7 @@ class ClusterClient(NamespacedClient):
185
186
  Remove master-eligible nodes from the voting configuration exclusion list.</p>
186
187
 
187
188
 
188
- `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cluster-post-voting-config-exclusions>`_
189
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-post-voting-config-exclusions>`_
189
190
 
190
191
  :param master_timeout: Period to wait for a connection to the master node.
191
192
  :param wait_for_removal: Specifies whether to wait for all excluded nodes to
@@ -239,7 +240,7 @@ class ClusterClient(NamespacedClient):
239
240
  Returns information about whether a particular component template exists.</p>
240
241
 
241
242
 
242
- `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cluster-put-component-template>`_
243
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-component-template>`_
243
244
 
244
245
  :param name: Comma-separated list of component template names used to limit the
245
246
  request. Wildcard (*) expressions are supported.
@@ -290,6 +291,7 @@ class ClusterClient(NamespacedClient):
290
291
  local: t.Optional[bool] = None,
291
292
  master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
292
293
  pretty: t.Optional[bool] = None,
294
+ settings_filter: t.Optional[t.Union[str, t.Sequence[str]]] = None,
293
295
  ) -> ObjectApiResponse[t.Any]:
294
296
  """
295
297
  .. raw:: html
@@ -298,7 +300,7 @@ class ClusterClient(NamespacedClient):
298
300
  Get information about component templates.</p>
299
301
 
300
302
 
301
- `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cluster-put-component-template>`_
303
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-component-template>`_
302
304
 
303
305
  :param name: Comma-separated list of component template names used to limit the
304
306
  request. Wildcard (`*`) expressions are supported.
@@ -310,6 +312,8 @@ class ClusterClient(NamespacedClient):
310
312
  :param master_timeout: Period to wait for a connection to the master node. If
311
313
  no response is received before the timeout expires, the request fails and
312
314
  returns an error.
315
+ :param settings_filter: Filter out results, for example to filter out sensitive
316
+ information. Supports wildcards or full settings keys
313
317
  """
314
318
  __path_parts: t.Dict[str, str]
315
319
  if name not in SKIP_IN_PATH:
@@ -335,6 +339,8 @@ class ClusterClient(NamespacedClient):
335
339
  __query["master_timeout"] = master_timeout
336
340
  if pretty is not None:
337
341
  __query["pretty"] = pretty
342
+ if settings_filter is not None:
343
+ __query["settings_filter"] = settings_filter
338
344
  __headers = {"accept": "application/json"}
339
345
  return self.perform_request( # type: ignore[return-value]
340
346
  "GET",
@@ -361,11 +367,11 @@ class ClusterClient(NamespacedClient):
361
367
  """
362
368
  .. raw:: html
363
369
 
364
- <p>Get cluster-wide settings.
365
- By default, it returns only settings that have been explicitly defined.</p>
370
+ <p>Get cluster-wide settings.</p>
371
+ <p>By default, it returns only settings that have been explicitly defined.</p>
366
372
 
367
373
 
368
- `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cluster-get-settings>`_
374
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-get-settings>`_
369
375
 
370
376
  :param flat_settings: If `true`, returns settings in flat format.
371
377
  :param include_defaults: If `true`, returns default cluster settings from the
@@ -441,7 +447,7 @@ class ClusterClient(NamespacedClient):
441
447
  wait_for_no_relocating_shards: t.Optional[bool] = None,
442
448
  wait_for_nodes: t.Optional[t.Union[int, str]] = None,
443
449
  wait_for_status: t.Optional[
444
- t.Union[str, t.Literal["green", "red", "yellow"]]
450
+ t.Union[str, t.Literal["green", "red", "unavailable", "unknown", "yellow"]]
445
451
  ] = None,
446
452
  ) -> ObjectApiResponse[t.Any]:
447
453
  """
@@ -457,7 +463,7 @@ class ClusterClient(NamespacedClient):
457
463
  The cluster status is controlled by the worst index status.</p>
458
464
 
459
465
 
460
- `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cluster-health>`_
466
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-health>`_
461
467
 
462
468
  :param index: Comma-separated list of data streams, indices, and index aliases
463
469
  used to limit the request. Wildcard expressions (`*`) are supported. To target
@@ -565,7 +571,7 @@ class ClusterClient(NamespacedClient):
565
571
  Returns basic information about the cluster.</p>
566
572
 
567
573
 
568
- `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cluster-info>`_
574
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-info>`_
569
575
 
570
576
  :param target: Limits the information returned to the specific target. Supports
571
577
  a comma-separated list, such as http,ingest.
@@ -614,7 +620,7 @@ class ClusterClient(NamespacedClient):
614
620
  However, if a user-initiated task such as a create index command causes a cluster state update, the activity of this task might be reported by both task api and pending cluster tasks API.</p>
615
621
 
616
622
 
617
- `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cluster-pending-tasks>`_
623
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-pending-tasks>`_
618
624
 
619
625
  :param local: If `true`, the request retrieves information from the local node
620
626
  only. If `false`, information is retrieved from the master node.
@@ -680,7 +686,7 @@ class ClusterClient(NamespacedClient):
680
686
  They are not required when removing master-ineligible nodes or when removing fewer than half of the master-eligible nodes.</p>
681
687
 
682
688
 
683
- `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cluster-post-voting-config-exclusions>`_
689
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-post-voting-config-exclusions>`_
684
690
 
685
691
  :param master_timeout: Period to wait for a connection to the master node.
686
692
  :param node_ids: A comma-separated list of the persistent ids of the nodes to
@@ -731,6 +737,7 @@ class ClusterClient(NamespacedClient):
731
737
  *,
732
738
  name: str,
733
739
  template: t.Optional[t.Mapping[str, t.Any]] = None,
740
+ cause: t.Optional[str] = None,
734
741
  create: t.Optional[bool] = None,
735
742
  deprecated: t.Optional[bool] = None,
736
743
  error_trace: t.Optional[bool] = None,
@@ -761,7 +768,7 @@ class ClusterClient(NamespacedClient):
761
768
  To be applied, a component template must be included in an index template's <code>composed_of</code> list.</p>
762
769
 
763
770
 
764
- `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cluster-put-component-template>`_
771
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-component-template>`_
765
772
 
766
773
  :param name: Name of the component template to create. Elasticsearch includes
767
774
  the following built-in component templates: `logs-mappings`; `logs-settings`;
@@ -774,6 +781,7 @@ class ClusterClient(NamespacedClient):
774
781
  update settings API.
775
782
  :param template: The template to be applied which includes mappings, settings,
776
783
  or aliases configuration.
784
+ :param cause: User defined reason for create the component template.
777
785
  :param create: If `true`, this request cannot replace or update existing component
778
786
  templates.
779
787
  :param deprecated: Marks this index template as deprecated. When creating or
@@ -798,6 +806,8 @@ class ClusterClient(NamespacedClient):
798
806
  __path = f'/_component_template/{__path_parts["name"]}'
799
807
  __query: t.Dict[str, t.Any] = {}
800
808
  __body: t.Dict[str, t.Any] = body if body is not None else {}
809
+ if cause is not None:
810
+ __query["cause"] = cause
801
811
  if create is not None:
802
812
  __query["create"] = create
803
813
  if error_trace is not None:
@@ -866,13 +876,13 @@ class ClusterClient(NamespacedClient):
866
876
  If a cluster becomes unstable, transient settings can clear unexpectedly, resulting in a potentially undesired cluster configuration.</p>
867
877
 
868
878
 
869
- `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cluster-put-settings>`_
879
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-settings>`_
870
880
 
871
881
  :param flat_settings: Return settings in flat format (default: false)
872
882
  :param master_timeout: Explicit operation timeout for connection to master node
873
- :param persistent:
883
+ :param persistent: The settings that persist after the cluster restarts.
874
884
  :param timeout: Explicit operation timeout
875
- :param transient:
885
+ :param transient: The settings that do not persist after the cluster restarts.
876
886
  """
877
887
  __path_parts: t.Dict[str, str] = {}
878
888
  __path = "/_cluster/settings"
@@ -932,7 +942,7 @@ class ClusterClient(NamespacedClient):
932
942
  </blockquote>
933
943
 
934
944
 
935
- `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cluster-remote-info>`_
945
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-remote-info>`_
936
946
  """
937
947
  __path_parts: t.Dict[str, str] = {}
938
948
  __path = "/_remote/info"
@@ -989,7 +999,7 @@ class ClusterClient(NamespacedClient):
989
999
  <p>Once the problem has been corrected, allocation can be manually retried by calling the reroute API with the <code>?retry_failed</code> URI query parameter, which will attempt a single retry round for these shards.</p>
990
1000
 
991
1001
 
992
- `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cluster-reroute>`_
1002
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-reroute>`_
993
1003
 
994
1004
  :param commands: Defines the commands to perform.
995
1005
  :param dry_run: If true, then the request simulates the operation. It will calculate
@@ -1094,7 +1104,7 @@ class ClusterClient(NamespacedClient):
1094
1104
  Instead, obtain the information you require using other more stable cluster APIs.</p>
1095
1105
 
1096
1106
 
1097
- `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cluster-state>`_
1107
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-state>`_
1098
1108
 
1099
1109
  :param metric: Limit the information returned to the specified metrics
1100
1110
  :param index: A comma-separated list of index names; use `_all` or empty string
@@ -1182,7 +1192,7 @@ class ClusterClient(NamespacedClient):
1182
1192
  Get basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins).</p>
1183
1193
 
1184
1194
 
1185
- `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cluster-stats>`_
1195
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-stats>`_
1186
1196
 
1187
1197
  :param node_id: Comma-separated list of node filters used to limit returned information.
1188
1198
  Defaults to all nodes in the cluster.
@@ -49,7 +49,7 @@ class ConnectorClient(NamespacedClient):
49
49
  <p>Update the <code>last_seen</code> field in the connector and set it to the current timestamp.</p>
50
50
 
51
51
 
52
- `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-check-in>`_
52
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-check-in>`_
53
53
 
54
54
  :param connector_id: The unique identifier of the connector to be checked in
55
55
  """
@@ -99,7 +99,7 @@ class ConnectorClient(NamespacedClient):
99
99
  These need to be removed manually.</p>
100
100
 
101
101
 
102
- `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-delete>`_
102
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-delete>`_
103
103
 
104
104
  :param connector_id: The unique identifier of the connector to be deleted
105
105
  :param delete_sync_jobs: A flag indicating if associated sync jobs should be
@@ -152,7 +152,7 @@ class ConnectorClient(NamespacedClient):
152
152
  <p>Get the details about a connector.</p>
153
153
 
154
154
 
155
- `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-get>`_
155
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-get>`_
156
156
 
157
157
  :param connector_id: The unique identifier of the connector
158
158
  :param include_deleted: A flag to indicate if the desired connector should be
@@ -256,7 +256,7 @@ class ConnectorClient(NamespacedClient):
256
256
  This action is used for analytics and monitoring.</p>
257
257
 
258
258
 
259
- `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-last-sync>`_
259
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-last-sync>`_
260
260
 
261
261
  :param connector_id: The unique identifier of the connector to be updated
262
262
  :param last_access_control_sync_error:
@@ -356,7 +356,7 @@ class ConnectorClient(NamespacedClient):
356
356
  <p>Get information about all connectors.</p>
357
357
 
358
358
 
359
- `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-list>`_
359
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-list>`_
360
360
 
361
361
  :param connector_name: A comma-separated list of connector names to fetch connector
362
362
  documents for
@@ -441,7 +441,7 @@ class ConnectorClient(NamespacedClient):
441
441
  Self-managed connectors (Connector clients) are self-managed on your infrastructure.</p>
442
442
 
443
443
 
444
- `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-put>`_
444
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-put>`_
445
445
 
446
446
  :param description:
447
447
  :param index_name:
@@ -523,7 +523,7 @@ class ConnectorClient(NamespacedClient):
523
523
  <p>Create or update a connector.</p>
524
524
 
525
525
 
526
- `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-put>`_
526
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-put>`_
527
527
 
528
528
  :param connector_id: The unique identifier of the connector to be created or
529
529
  updated. ID is auto-generated if not provided.
@@ -598,7 +598,7 @@ class ConnectorClient(NamespacedClient):
598
598
  The connector service is then responsible for setting the status of connector sync jobs to cancelled.</p>
599
599
 
600
600
 
601
- `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-sync-job-cancel>`_
601
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-cancel>`_
602
602
 
603
603
  :param connector_sync_job_id: The unique identifier of the connector sync job
604
604
  """
@@ -649,7 +649,7 @@ class ConnectorClient(NamespacedClient):
649
649
  This service runs automatically on Elastic Cloud for Elastic managed connectors.</p>
650
650
 
651
651
 
652
- `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-sync-job-check-in>`_
652
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-check-in>`_
653
653
 
654
654
  :param connector_sync_job_id: The unique identifier of the connector sync job
655
655
  to be checked in.
@@ -709,7 +709,7 @@ class ConnectorClient(NamespacedClient):
709
709
  This service runs automatically on Elastic Cloud for Elastic managed connectors.</p>
710
710
 
711
711
 
712
- `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-sync-job-claim>`_
712
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-claim>`_
713
713
 
714
714
  :param connector_sync_job_id: The unique identifier of the connector sync job.
715
715
  :param worker_hostname: The host name of the current system that will run the
@@ -771,7 +771,7 @@ class ConnectorClient(NamespacedClient):
771
771
  This is a destructive action that is not recoverable.</p>
772
772
 
773
773
 
774
- `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-sync-job-delete>`_
774
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-delete>`_
775
775
 
776
776
  :param connector_sync_job_id: The unique identifier of the connector sync job
777
777
  to be deleted
@@ -825,7 +825,7 @@ class ConnectorClient(NamespacedClient):
825
825
  This service runs automatically on Elastic Cloud for Elastic managed connectors.</p>
826
826
 
827
827
 
828
- `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-sync-job-error>`_
828
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-error>`_
829
829
 
830
830
  :param connector_sync_job_id: The unique identifier for the connector sync job.
831
831
  :param error: The error for the connector sync job error field.
@@ -879,7 +879,7 @@ class ConnectorClient(NamespacedClient):
879
879
  <p>Get a connector sync job.</p>
880
880
 
881
881
 
882
- `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-sync-job-get>`_
882
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-get>`_
883
883
 
884
884
  :param connector_sync_job_id: The unique identifier of the connector sync job
885
885
  """
@@ -952,7 +952,7 @@ class ConnectorClient(NamespacedClient):
952
952
  <p>Get information about all stored connector sync jobs listed by their creation date in ascending order.</p>
953
953
 
954
954
 
955
- `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-sync-job-list>`_
955
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-list>`_
956
956
 
957
957
  :param connector_id: A connector id to fetch connector sync jobs for
958
958
  :param from_: Starting offset (default: 0)
@@ -1018,7 +1018,7 @@ class ConnectorClient(NamespacedClient):
1018
1018
  <p>Create a connector sync job document in the internal index and initialize its counters and timestamps with default values.</p>
1019
1019
 
1020
1020
 
1021
- `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-sync-job-post>`_
1021
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-post>`_
1022
1022
 
1023
1023
  :param id: The id of the associated connector
1024
1024
  :param job_type:
@@ -1094,7 +1094,7 @@ class ConnectorClient(NamespacedClient):
1094
1094
  This service runs automatically on Elastic Cloud for Elastic managed connectors.</p>
1095
1095
 
1096
1096
 
1097
- `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-sync-job-update-stats>`_
1097
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-update-stats>`_
1098
1098
 
1099
1099
  :param connector_sync_job_id: The unique identifier of the connector sync job.
1100
1100
  :param deleted_document_count: The number of documents the sync job deleted.
@@ -1177,7 +1177,7 @@ class ConnectorClient(NamespacedClient):
1177
1177
  <p>Activates the valid draft filtering for a connector.</p>
1178
1178
 
1179
1179
 
1180
- `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-filtering>`_
1180
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-filtering>`_
1181
1181
 
1182
1182
  :param connector_id: The unique identifier of the connector to be updated
1183
1183
  """
@@ -1230,7 +1230,7 @@ class ConnectorClient(NamespacedClient):
1230
1230
  Self-managed connectors (connector clients) do not use this field.</p>
1231
1231
 
1232
1232
 
1233
- `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-api-key-id>`_
1233
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-api-key-id>`_
1234
1234
 
1235
1235
  :param connector_id: The unique identifier of the connector to be updated
1236
1236
  :param api_key_id:
@@ -1289,7 +1289,7 @@ class ConnectorClient(NamespacedClient):
1289
1289
  <p>Update the configuration field in the connector document.</p>
1290
1290
 
1291
1291
 
1292
- `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-configuration>`_
1292
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-configuration>`_
1293
1293
 
1294
1294
  :param connector_id: The unique identifier of the connector to be updated
1295
1295
  :param configuration:
@@ -1349,7 +1349,7 @@ class ConnectorClient(NamespacedClient):
1349
1349
  Otherwise, if the error is reset to null, the connector status is updated to connected.</p>
1350
1350
 
1351
1351
 
1352
- `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-error>`_
1352
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-error>`_
1353
1353
 
1354
1354
  :param connector_id: The unique identifier of the connector to be updated
1355
1355
  :param error:
@@ -1417,7 +1417,7 @@ class ConnectorClient(NamespacedClient):
1417
1417
  This service runs automatically on Elastic Cloud for Elastic managed connectors.</p>
1418
1418
 
1419
1419
 
1420
- `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-features>`_
1420
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-features>`_
1421
1421
 
1422
1422
  :param connector_id: The unique identifier of the connector to be updated.
1423
1423
  :param features:
@@ -1478,7 +1478,7 @@ class ConnectorClient(NamespacedClient):
1478
1478
  The filtering property is used to configure sync rules (both basic and advanced) for a connector.</p>
1479
1479
 
1480
1480
 
1481
- `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-filtering>`_
1481
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-filtering>`_
1482
1482
 
1483
1483
  :param connector_id: The unique identifier of the connector to be updated
1484
1484
  :param advanced_snippet:
@@ -1539,7 +1539,7 @@ class ConnectorClient(NamespacedClient):
1539
1539
  <p>Update the draft filtering validation info for a connector.</p>
1540
1540
 
1541
1541
 
1542
- `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-filtering-validation>`_
1542
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-filtering-validation>`_
1543
1543
 
1544
1544
  :param connector_id: The unique identifier of the connector to be updated
1545
1545
  :param validation:
@@ -1596,7 +1596,7 @@ class ConnectorClient(NamespacedClient):
1596
1596
  <p>Update the <code>index_name</code> field of a connector, specifying the index where the data ingested by the connector is stored.</p>
1597
1597
 
1598
1598
 
1599
- `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-index-name>`_
1599
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-index-name>`_
1600
1600
 
1601
1601
  :param connector_id: The unique identifier of the connector to be updated
1602
1602
  :param index_name:
@@ -1653,7 +1653,7 @@ class ConnectorClient(NamespacedClient):
1653
1653
  <p>Update the connector name and description.</p>
1654
1654
 
1655
1655
 
1656
- `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-name>`_
1656
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-name>`_
1657
1657
 
1658
1658
  :param connector_id: The unique identifier of the connector to be updated
1659
1659
  :param description:
@@ -1710,7 +1710,7 @@ class ConnectorClient(NamespacedClient):
1710
1710
  <p>Update the connector is_native flag.</p>
1711
1711
 
1712
1712
 
1713
- `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-native>`_
1713
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-native>`_
1714
1714
 
1715
1715
  :param connector_id: The unique identifier of the connector to be updated
1716
1716
  :param is_native:
@@ -1767,7 +1767,7 @@ class ConnectorClient(NamespacedClient):
1767
1767
  <p>When you create a new connector, the configuration of an ingest pipeline is populated with default settings.</p>
1768
1768
 
1769
1769
 
1770
- `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-pipeline>`_
1770
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-pipeline>`_
1771
1771
 
1772
1772
  :param connector_id: The unique identifier of the connector to be updated
1773
1773
  :param pipeline:
@@ -1823,7 +1823,7 @@ class ConnectorClient(NamespacedClient):
1823
1823
  <p>Update the connector scheduling.</p>
1824
1824
 
1825
1825
 
1826
- `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-scheduling>`_
1826
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-scheduling>`_
1827
1827
 
1828
1828
  :param connector_id: The unique identifier of the connector to be updated
1829
1829
  :param scheduling:
@@ -1879,7 +1879,7 @@ class ConnectorClient(NamespacedClient):
1879
1879
  <p>Update the connector service type.</p>
1880
1880
 
1881
1881
 
1882
- `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-service-type>`_
1882
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-service-type>`_
1883
1883
 
1884
1884
  :param connector_id: The unique identifier of the connector to be updated
1885
1885
  :param service_type:
@@ -1942,7 +1942,7 @@ class ConnectorClient(NamespacedClient):
1942
1942
  <p>Update the connector status.</p>
1943
1943
 
1944
1944
 
1945
- `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-status>`_
1945
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-status>`_
1946
1946
 
1947
1947
  :param connector_id: The unique identifier of the connector to be updated
1948
1948
  :param status:
@@ -46,7 +46,7 @@ class DanglingIndicesClient(NamespacedClient):
46
46
  For example, this can happen if you delete more than <code>cluster.indices.tombstones.size</code> indices while an Elasticsearch node is offline.</p>
47
47
 
48
48
 
49
- `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-dangling-indices-delete-dangling-index>`_
49
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-dangling-indices-delete-dangling-index>`_
50
50
 
51
51
  :param index_uuid: The UUID of the index to delete. Use the get dangling indices
52
52
  API to find the UUID.
@@ -107,7 +107,7 @@ class DanglingIndicesClient(NamespacedClient):
107
107
  For example, this can happen if you delete more than <code>cluster.indices.tombstones.size</code> indices while an Elasticsearch node is offline.</p>
108
108
 
109
109
 
110
- `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-dangling-indices-import-dangling-index>`_
110
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-dangling-indices-import-dangling-index>`_
111
111
 
112
112
  :param index_uuid: The UUID of the index to import. Use the get dangling indices
113
113
  API to locate the UUID.
@@ -168,7 +168,7 @@ class DanglingIndicesClient(NamespacedClient):
168
168
  <p>Use this API to list dangling indices, which you can then import or delete.</p>
169
169
 
170
170
 
171
- `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-dangling-indices-list-dangling-indices>`_
171
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-dangling-indices-list-dangling-indices>`_
172
172
  """
173
173
  __path_parts: t.Dict[str, str] = {}
174
174
  __path = "/_dangling"