elasticsearch 8.18.1__py3-none-any.whl → 8.19.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 (101) hide show
  1. elasticsearch/_async/client/__init__.py +56 -76
  2. elasticsearch/_async/client/async_search.py +5 -9
  3. elasticsearch/_async/client/autoscaling.py +4 -4
  4. elasticsearch/_async/client/cat.py +620 -65
  5. elasticsearch/_async/client/ccr.py +13 -13
  6. elasticsearch/_async/client/cluster.py +31 -22
  7. elasticsearch/_async/client/connector.py +30 -30
  8. elasticsearch/_async/client/dangling_indices.py +3 -3
  9. elasticsearch/_async/client/enrich.py +5 -5
  10. elasticsearch/_async/client/eql.py +13 -5
  11. elasticsearch/_async/client/esql.py +38 -9
  12. elasticsearch/_async/client/features.py +2 -2
  13. elasticsearch/_async/client/fleet.py +13 -13
  14. elasticsearch/_async/client/graph.py +1 -1
  15. elasticsearch/_async/client/ilm.py +11 -11
  16. elasticsearch/_async/client/indices.py +131 -82
  17. elasticsearch/_async/client/inference.py +411 -112
  18. elasticsearch/_async/client/ingest.py +9 -16
  19. elasticsearch/_async/client/license.py +10 -10
  20. elasticsearch/_async/client/logstash.py +3 -3
  21. elasticsearch/_async/client/migration.py +3 -3
  22. elasticsearch/_async/client/ml.py +76 -88
  23. elasticsearch/_async/client/nodes.py +9 -8
  24. elasticsearch/_async/client/query_rules.py +8 -8
  25. elasticsearch/_async/client/rollup.py +8 -8
  26. elasticsearch/_async/client/search_application.py +10 -10
  27. elasticsearch/_async/client/searchable_snapshots.py +4 -4
  28. elasticsearch/_async/client/security.py +72 -80
  29. elasticsearch/_async/client/shutdown.py +3 -3
  30. elasticsearch/_async/client/simulate.py +1 -1
  31. elasticsearch/_async/client/slm.py +9 -9
  32. elasticsearch/_async/client/snapshot.py +19 -13
  33. elasticsearch/_async/client/sql.py +6 -6
  34. elasticsearch/_async/client/ssl.py +1 -1
  35. elasticsearch/_async/client/synonyms.py +7 -7
  36. elasticsearch/_async/client/tasks.py +3 -3
  37. elasticsearch/_async/client/text_structure.py +4 -4
  38. elasticsearch/_async/client/transform.py +9 -9
  39. elasticsearch/_async/client/xpack.py +1 -1
  40. elasticsearch/_sync/client/__init__.py +56 -76
  41. elasticsearch/_sync/client/async_search.py +5 -9
  42. elasticsearch/_sync/client/autoscaling.py +4 -4
  43. elasticsearch/_sync/client/cat.py +620 -65
  44. elasticsearch/_sync/client/ccr.py +13 -13
  45. elasticsearch/_sync/client/cluster.py +31 -22
  46. elasticsearch/_sync/client/connector.py +30 -30
  47. elasticsearch/_sync/client/dangling_indices.py +3 -3
  48. elasticsearch/_sync/client/enrich.py +5 -5
  49. elasticsearch/_sync/client/eql.py +13 -5
  50. elasticsearch/_sync/client/esql.py +38 -9
  51. elasticsearch/_sync/client/features.py +2 -2
  52. elasticsearch/_sync/client/fleet.py +13 -13
  53. elasticsearch/_sync/client/graph.py +1 -1
  54. elasticsearch/_sync/client/ilm.py +11 -11
  55. elasticsearch/_sync/client/indices.py +131 -82
  56. elasticsearch/_sync/client/inference.py +411 -112
  57. elasticsearch/_sync/client/ingest.py +9 -16
  58. elasticsearch/_sync/client/license.py +10 -10
  59. elasticsearch/_sync/client/logstash.py +3 -3
  60. elasticsearch/_sync/client/migration.py +3 -3
  61. elasticsearch/_sync/client/ml.py +76 -88
  62. elasticsearch/_sync/client/nodes.py +9 -8
  63. elasticsearch/_sync/client/query_rules.py +8 -8
  64. elasticsearch/_sync/client/rollup.py +8 -8
  65. elasticsearch/_sync/client/search_application.py +10 -10
  66. elasticsearch/_sync/client/searchable_snapshots.py +4 -4
  67. elasticsearch/_sync/client/security.py +72 -80
  68. elasticsearch/_sync/client/shutdown.py +3 -3
  69. elasticsearch/_sync/client/simulate.py +1 -1
  70. elasticsearch/_sync/client/slm.py +9 -9
  71. elasticsearch/_sync/client/snapshot.py +19 -13
  72. elasticsearch/_sync/client/sql.py +6 -6
  73. elasticsearch/_sync/client/ssl.py +1 -1
  74. elasticsearch/_sync/client/synonyms.py +7 -7
  75. elasticsearch/_sync/client/tasks.py +3 -3
  76. elasticsearch/_sync/client/text_structure.py +4 -4
  77. elasticsearch/_sync/client/transform.py +9 -9
  78. elasticsearch/_sync/client/xpack.py +1 -1
  79. elasticsearch/_version.py +1 -1
  80. elasticsearch/compat.py +5 -0
  81. elasticsearch/dsl/__init__.py +2 -1
  82. elasticsearch/dsl/_async/document.py +1 -1
  83. elasticsearch/dsl/_sync/document.py +1 -1
  84. elasticsearch/dsl/aggs.py +2 -3
  85. elasticsearch/dsl/document_base.py +176 -16
  86. elasticsearch/dsl/field.py +223 -38
  87. elasticsearch/dsl/query.py +49 -4
  88. elasticsearch/dsl/types.py +107 -16
  89. elasticsearch/dsl/utils.py +1 -1
  90. elasticsearch/esql/__init__.py +18 -0
  91. elasticsearch/esql/esql.py +1105 -0
  92. elasticsearch/esql/functions.py +1738 -0
  93. elasticsearch/exceptions.py +2 -0
  94. {elasticsearch-8.18.1.dist-info → elasticsearch-8.19.0.dist-info}/METADATA +1 -3
  95. elasticsearch-8.19.0.dist-info/RECORD +164 -0
  96. elasticsearch-8.18.1.dist-info/RECORD +0 -163
  97. elasticsearch-8.18.1.dist-info/licenses/LICENSE.txt +0 -175
  98. elasticsearch-8.18.1.dist-info/licenses/NOTICE.txt +0 -559
  99. {elasticsearch-8.18.1.dist-info → elasticsearch-8.19.0.dist-info}/WHEEL +0 -0
  100. {elasticsearch-8.18.1.dist-info → elasticsearch-8.19.0.dist-info}/licenses/LICENSE +0 -0
  101. {elasticsearch-8.18.1.dist-info → elasticsearch-8.19.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/guide/en/elasticsearch/reference/8.18/ccr-delete-auto-follow-pattern.html>`_
46
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ccr-delete-auto-follow-pattern.html>`_
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/guide/en/elasticsearch/reference/8.18/ccr-put-follow.html>`_
133
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ccr-put-follow.html>`_
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/guide/en/elasticsearch/reference/8.18/ccr-get-follow-info.html>`_
262
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ccr-get-follow-info.html>`_
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/guide/en/elasticsearch/reference/8.18/ccr-get-follow-stats.html>`_
314
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ccr-get-follow-stats.html>`_
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/guide/en/elasticsearch/reference/8.18/ccr-post-forget-follower.html>`_
383
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ccr-post-forget-follower.html>`_
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/guide/en/elasticsearch/reference/8.18/ccr-get-auto-follow-pattern.html>`_
448
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ccr-get-auto-follow-pattern.html>`_
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/guide/en/elasticsearch/reference/8.18/ccr-pause-auto-follow-pattern.html>`_
508
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ccr-pause-auto-follow-pattern.html>`_
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/guide/en/elasticsearch/reference/8.18/ccr-post-pause-follow.html>`_
562
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ccr-post-pause-follow.html>`_
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/guide/en/elasticsearch/reference/8.18/ccr-put-auto-follow-pattern.html>`_
651
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ccr-put-auto-follow-pattern.html>`_
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/guide/en/elasticsearch/reference/8.18/ccr-resume-auto-follow-pattern.html>`_
785
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ccr-resume-auto-follow-pattern.html>`_
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/guide/en/elasticsearch/reference/8.18/ccr-post-resume-follow.html>`_
863
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ccr-post-resume-follow.html>`_
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/guide/en/elasticsearch/reference/8.18/ccr-get-stats.html>`_
954
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ccr-get-stats.html>`_
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/guide/en/elasticsearch/reference/8.18/ccr-post-unfollow.html>`_
1012
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ccr-post-unfollow.html>`_
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.
@@ -54,7 +54,7 @@ class ClusterClient(NamespacedClient):
54
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>
55
55
 
56
56
 
57
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cluster-allocation-explain.html>`_
57
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cluster-allocation-explain.html>`_
58
58
 
59
59
  :param current_node: Specifies the node ID or the name of the node to only explain
60
60
  a shard that is currently located on the specified node.
@@ -130,7 +130,7 @@ class ClusterClient(NamespacedClient):
130
130
  Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.</p>
131
131
 
132
132
 
133
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/indices-component-template.html>`_
133
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-component-template.html>`_
134
134
 
135
135
  :param name: Comma-separated list or wildcard expression of component template
136
136
  names used to limit the request.
@@ -239,7 +239,7 @@ class ClusterClient(NamespacedClient):
239
239
  Returns information about whether a particular component template exists.</p>
240
240
 
241
241
 
242
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/indices-component-template.html>`_
242
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-component-template.html>`_
243
243
 
244
244
  :param name: Comma-separated list of component template names used to limit the
245
245
  request. Wildcard (*) expressions are supported.
@@ -290,6 +290,7 @@ class ClusterClient(NamespacedClient):
290
290
  local: t.Optional[bool] = None,
291
291
  master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
292
292
  pretty: t.Optional[bool] = None,
293
+ settings_filter: t.Optional[t.Union[str, t.Sequence[str]]] = None,
293
294
  ) -> ObjectApiResponse[t.Any]:
294
295
  """
295
296
  .. raw:: html
@@ -298,7 +299,7 @@ class ClusterClient(NamespacedClient):
298
299
  Get information about component templates.</p>
299
300
 
300
301
 
301
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/indices-component-template.html>`_
302
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-component-template.html>`_
302
303
 
303
304
  :param name: Comma-separated list of component template names used to limit the
304
305
  request. Wildcard (`*`) expressions are supported.
@@ -310,6 +311,8 @@ class ClusterClient(NamespacedClient):
310
311
  :param master_timeout: Period to wait for a connection to the master node. If
311
312
  no response is received before the timeout expires, the request fails and
312
313
  returns an error.
314
+ :param settings_filter: Filter out results, for example to filter out sensitive
315
+ information. Supports wildcards or full settings keys
313
316
  """
314
317
  __path_parts: t.Dict[str, str]
315
318
  if name not in SKIP_IN_PATH:
@@ -335,6 +338,8 @@ class ClusterClient(NamespacedClient):
335
338
  __query["master_timeout"] = master_timeout
336
339
  if pretty is not None:
337
340
  __query["pretty"] = pretty
341
+ if settings_filter is not None:
342
+ __query["settings_filter"] = settings_filter
338
343
  __headers = {"accept": "application/json"}
339
344
  return await self.perform_request( # type: ignore[return-value]
340
345
  "GET",
@@ -365,7 +370,7 @@ class ClusterClient(NamespacedClient):
365
370
  By default, it returns only settings that have been explicitly defined.</p>
366
371
 
367
372
 
368
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cluster-get-settings.html>`_
373
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cluster-get-settings.html>`_
369
374
 
370
375
  :param flat_settings: If `true`, returns settings in flat format.
371
376
  :param include_defaults: If `true`, returns default cluster settings from the
@@ -441,14 +446,14 @@ class ClusterClient(NamespacedClient):
441
446
  wait_for_no_relocating_shards: t.Optional[bool] = None,
442
447
  wait_for_nodes: t.Optional[t.Union[int, str]] = None,
443
448
  wait_for_status: t.Optional[
444
- t.Union[str, t.Literal["green", "red", "yellow"]]
449
+ t.Union[str, t.Literal["green", "red", "unavailable", "unknown", "yellow"]]
445
450
  ] = None,
446
451
  ) -> ObjectApiResponse[t.Any]:
447
452
  """
448
453
  .. raw:: html
449
454
 
450
- <p>Get the cluster health status.
451
- You can also use the API to get the health status of only specified data streams and indices.
455
+ <p>Get the cluster health status.</p>
456
+ <p>You can also use the API to get the health status of only specified data streams and indices.
452
457
  For data streams, the API retrieves the health status of the stream’s backing indices.</p>
453
458
  <p>The cluster health status is: green, yellow or red.
454
459
  On the shard level, a red status indicates that the specific shard is not allocated in the cluster. Yellow means that the primary shard is allocated but replicas are not. Green means that all shards are allocated.
@@ -457,7 +462,7 @@ class ClusterClient(NamespacedClient):
457
462
  The cluster status is controlled by the worst index status.</p>
458
463
 
459
464
 
460
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cluster-health.html>`_
465
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cluster-health.html>`_
461
466
 
462
467
  :param index: Comma-separated list of data streams, indices, and index aliases
463
468
  used to limit the request. Wildcard expressions (`*`) are supported. To target
@@ -565,7 +570,7 @@ class ClusterClient(NamespacedClient):
565
570
  Returns basic information about the cluster.</p>
566
571
 
567
572
 
568
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cluster-info.html>`_
573
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cluster-info.html>`_
569
574
 
570
575
  :param target: Limits the information returned to the specific target. Supports
571
576
  a comma-separated list, such as http,ingest.
@@ -614,7 +619,7 @@ class ClusterClient(NamespacedClient):
614
619
  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
620
 
616
621
 
617
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cluster-pending.html>`_
622
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cluster-pending.html>`_
618
623
 
619
624
  :param local: If `true`, the request retrieves information from the local node
620
625
  only. If `false`, information is retrieved from the master node.
@@ -731,6 +736,7 @@ class ClusterClient(NamespacedClient):
731
736
  *,
732
737
  name: str,
733
738
  template: t.Optional[t.Mapping[str, t.Any]] = None,
739
+ cause: t.Optional[str] = None,
734
740
  create: t.Optional[bool] = None,
735
741
  deprecated: t.Optional[bool] = None,
736
742
  error_trace: t.Optional[bool] = None,
@@ -761,7 +767,7 @@ class ClusterClient(NamespacedClient):
761
767
  To be applied, a component template must be included in an index template's <code>composed_of</code> list.</p>
762
768
 
763
769
 
764
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/indices-component-template.html>`_
770
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-component-template.html>`_
765
771
 
766
772
  :param name: Name of the component template to create. Elasticsearch includes
767
773
  the following built-in component templates: `logs-mappings`; `logs-settings`;
@@ -774,6 +780,7 @@ class ClusterClient(NamespacedClient):
774
780
  update settings API.
775
781
  :param template: The template to be applied which includes mappings, settings,
776
782
  or aliases configuration.
783
+ :param cause: User defined reason for create the component template.
777
784
  :param create: If `true`, this request cannot replace or update existing component
778
785
  templates.
779
786
  :param deprecated: Marks this index template as deprecated. When creating or
@@ -798,6 +805,8 @@ class ClusterClient(NamespacedClient):
798
805
  __path = f'/_component_template/{__path_parts["name"]}'
799
806
  __query: t.Dict[str, t.Any] = {}
800
807
  __body: t.Dict[str, t.Any] = body if body is not None else {}
808
+ if cause is not None:
809
+ __query["cause"] = cause
801
810
  if create is not None:
802
811
  __query["create"] = create
803
812
  if error_trace is not None:
@@ -850,8 +859,8 @@ class ClusterClient(NamespacedClient):
850
859
  """
851
860
  .. raw:: html
852
861
 
853
- <p>Update the cluster settings.
854
- Configure and update dynamic settings on a running cluster.
862
+ <p>Update the cluster settings.</p>
863
+ <p>Configure and update dynamic settings on a running cluster.
855
864
  You can also configure dynamic settings locally on an unstarted or shut down node in <code>elasticsearch.yml</code>.</p>
856
865
  <p>Updates made with this API can be persistent, which apply across cluster restarts, or transient, which reset after a cluster restart.
857
866
  You can also reset transient or persistent settings by assigning them a null value.</p>
@@ -866,13 +875,13 @@ class ClusterClient(NamespacedClient):
866
875
  If a cluster becomes unstable, transient settings can clear unexpectedly, resulting in a potentially undesired cluster configuration.</p>
867
876
 
868
877
 
869
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cluster-update-settings.html>`_
878
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cluster-update-settings.html>`_
870
879
 
871
880
  :param flat_settings: Return settings in flat format (default: false)
872
881
  :param master_timeout: Explicit operation timeout for connection to master node
873
- :param persistent:
882
+ :param persistent: The settings that persist after the cluster restarts.
874
883
  :param timeout: Explicit operation timeout
875
- :param transient:
884
+ :param transient: The settings that do not persist after the cluster restarts.
876
885
  """
877
886
  __path_parts: t.Dict[str, str] = {}
878
887
  __path = "/_cluster/settings"
@@ -928,11 +937,11 @@ class ClusterClient(NamespacedClient):
928
937
  This API returns information that reflects current state on the local cluster.
929
938
  The <code>connected</code> field does not necessarily reflect whether a remote cluster is down or unavailable, only whether there is currently an open connection to it.
930
939
  Elasticsearch does not spontaneously try to reconnect to a disconnected remote cluster.
931
- To trigger a reconnection, attempt a cross-cluster search, ES|QL cross-cluster search, or try the <a href="https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-resolve-cluster">resolve cluster endpoint</a>.</p>
940
+ To trigger a reconnection, attempt a cross-cluster search, ES|QL cross-cluster search, or try the <code>/_resolve/cluster</code> endpoint.</p>
932
941
  </blockquote>
933
942
 
934
943
 
935
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cluster-remote-info.html>`_
944
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cluster-remote-info.html>`_
936
945
  """
937
946
  __path_parts: t.Dict[str, str] = {}
938
947
  __path = "/_remote/info"
@@ -989,7 +998,7 @@ class ClusterClient(NamespacedClient):
989
998
  <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
999
 
991
1000
 
992
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cluster-reroute.html>`_
1001
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cluster-reroute.html>`_
993
1002
 
994
1003
  :param commands: Defines the commands to perform.
995
1004
  :param dry_run: If true, then the request simulates the operation. It will calculate
@@ -1094,7 +1103,7 @@ class ClusterClient(NamespacedClient):
1094
1103
  Instead, obtain the information you require using other more stable cluster APIs.</p>
1095
1104
 
1096
1105
 
1097
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cluster-state.html>`_
1106
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cluster-state.html>`_
1098
1107
 
1099
1108
  :param metric: Limit the information returned to the specified metrics
1100
1109
  :param index: A comma-separated list of index names; use `_all` or empty string
@@ -1182,7 +1191,7 @@ class ClusterClient(NamespacedClient):
1182
1191
  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
1192
 
1184
1193
 
1185
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cluster-stats.html>`_
1194
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cluster-stats.html>`_
1186
1195
 
1187
1196
  :param node_id: Comma-separated list of node filters used to limit returned information.
1188
1197
  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/guide/en/elasticsearch/reference/8.18/check-in-connector-api.html>`_
52
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/check-in-connector-api.html>`_
53
53
 
54
54
  :param connector_id: The unique identifier of the connector to be checked in
55
55
  """
@@ -98,7 +98,7 @@ class ConnectorClient(NamespacedClient):
98
98
  These need to be removed manually.</p>
99
99
 
100
100
 
101
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/delete-connector-api.html>`_
101
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/delete-connector-api.html>`_
102
102
 
103
103
  :param connector_id: The unique identifier of the connector to be deleted
104
104
  :param delete_sync_jobs: A flag indicating if associated sync jobs should be
@@ -147,7 +147,7 @@ class ConnectorClient(NamespacedClient):
147
147
  <p>Get the details about a connector.</p>
148
148
 
149
149
 
150
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/get-connector-api.html>`_
150
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/get-connector-api.html>`_
151
151
 
152
152
  :param connector_id: The unique identifier of the connector
153
153
  """
@@ -247,7 +247,7 @@ class ConnectorClient(NamespacedClient):
247
247
  This action is used for analytics and monitoring.</p>
248
248
 
249
249
 
250
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/update-connector-last-sync-api.html>`_
250
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/update-connector-last-sync-api.html>`_
251
251
 
252
252
  :param connector_id: The unique identifier of the connector to be updated
253
253
  :param last_access_control_sync_error:
@@ -346,7 +346,7 @@ class ConnectorClient(NamespacedClient):
346
346
  <p>Get information about all connectors.</p>
347
347
 
348
348
 
349
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/list-connector-api.html>`_
349
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/list-connector-api.html>`_
350
350
 
351
351
  :param connector_name: A comma-separated list of connector names to fetch connector
352
352
  documents for
@@ -427,7 +427,7 @@ class ConnectorClient(NamespacedClient):
427
427
  Self-managed connectors (Connector clients) are self-managed on your infrastructure.</p>
428
428
 
429
429
 
430
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/create-connector-api.html>`_
430
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/create-connector-api.html>`_
431
431
 
432
432
  :param description:
433
433
  :param index_name:
@@ -509,7 +509,7 @@ class ConnectorClient(NamespacedClient):
509
509
  <p>Create or update a connector.</p>
510
510
 
511
511
 
512
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/create-connector-api.html>`_
512
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/create-connector-api.html>`_
513
513
 
514
514
  :param connector_id: The unique identifier of the connector to be created or
515
515
  updated. ID is auto-generated if not provided.
@@ -584,7 +584,7 @@ class ConnectorClient(NamespacedClient):
584
584
  The connector service is then responsible for setting the status of connector sync jobs to cancelled.</p>
585
585
 
586
586
 
587
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cancel-connector-sync-job-api.html>`_
587
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cancel-connector-sync-job-api.html>`_
588
588
 
589
589
  :param connector_sync_job_id: The unique identifier of the connector sync job
590
590
  """
@@ -635,7 +635,7 @@ class ConnectorClient(NamespacedClient):
635
635
  This service runs automatically on Elastic Cloud for Elastic managed connectors.</p>
636
636
 
637
637
 
638
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/check-in-connector-sync-job-api.html>`_
638
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/check-in-connector-sync-job-api.html>`_
639
639
 
640
640
  :param connector_sync_job_id: The unique identifier of the connector sync job
641
641
  to be checked in.
@@ -695,7 +695,7 @@ class ConnectorClient(NamespacedClient):
695
695
  This service runs automatically on Elastic Cloud for Elastic managed connectors.</p>
696
696
 
697
697
 
698
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/claim-connector-sync-job-api.html>`_
698
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/claim-connector-sync-job-api.html>`_
699
699
 
700
700
  :param connector_sync_job_id: The unique identifier of the connector sync job.
701
701
  :param worker_hostname: The host name of the current system that will run the
@@ -757,7 +757,7 @@ class ConnectorClient(NamespacedClient):
757
757
  This is a destructive action that is not recoverable.</p>
758
758
 
759
759
 
760
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/delete-connector-sync-job-api.html>`_
760
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/delete-connector-sync-job-api.html>`_
761
761
 
762
762
  :param connector_sync_job_id: The unique identifier of the connector sync job
763
763
  to be deleted
@@ -811,7 +811,7 @@ class ConnectorClient(NamespacedClient):
811
811
  This service runs automatically on Elastic Cloud for Elastic managed connectors.</p>
812
812
 
813
813
 
814
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/set-connector-sync-job-error-api.html>`_
814
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/set-connector-sync-job-error-api.html>`_
815
815
 
816
816
  :param connector_sync_job_id: The unique identifier for the connector sync job.
817
817
  :param error: The error for the connector sync job error field.
@@ -865,7 +865,7 @@ class ConnectorClient(NamespacedClient):
865
865
  <p>Get a connector sync job.</p>
866
866
 
867
867
 
868
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/get-connector-sync-job-api.html>`_
868
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/get-connector-sync-job-api.html>`_
869
869
 
870
870
  :param connector_sync_job_id: The unique identifier of the connector sync job
871
871
  """
@@ -938,7 +938,7 @@ class ConnectorClient(NamespacedClient):
938
938
  <p>Get information about all stored connector sync jobs listed by their creation date in ascending order.</p>
939
939
 
940
940
 
941
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/list-connector-sync-jobs-api.html>`_
941
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/list-connector-sync-jobs-api.html>`_
942
942
 
943
943
  :param connector_id: A connector id to fetch connector sync jobs for
944
944
  :param from_: Starting offset (default: 0)
@@ -1004,7 +1004,7 @@ class ConnectorClient(NamespacedClient):
1004
1004
  <p>Create a connector sync job document in the internal index and initialize its counters and timestamps with default values.</p>
1005
1005
 
1006
1006
 
1007
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/create-connector-sync-job-api.html>`_
1007
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/create-connector-sync-job-api.html>`_
1008
1008
 
1009
1009
  :param id: The id of the associated connector
1010
1010
  :param job_type:
@@ -1080,7 +1080,7 @@ class ConnectorClient(NamespacedClient):
1080
1080
  This service runs automatically on Elastic Cloud for Elastic managed connectors.</p>
1081
1081
 
1082
1082
 
1083
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/set-connector-sync-job-stats-api.html>`_
1083
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/set-connector-sync-job-stats-api.html>`_
1084
1084
 
1085
1085
  :param connector_sync_job_id: The unique identifier of the connector sync job.
1086
1086
  :param deleted_document_count: The number of documents the sync job deleted.
@@ -1163,7 +1163,7 @@ class ConnectorClient(NamespacedClient):
1163
1163
  <p>Activates the valid draft filtering for a connector.</p>
1164
1164
 
1165
1165
 
1166
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/update-connector-filtering-api.html>`_
1166
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/update-connector-filtering-api.html>`_
1167
1167
 
1168
1168
  :param connector_id: The unique identifier of the connector to be updated
1169
1169
  """
@@ -1216,7 +1216,7 @@ class ConnectorClient(NamespacedClient):
1216
1216
  Self-managed connectors (connector clients) do not use this field.</p>
1217
1217
 
1218
1218
 
1219
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/update-connector-api-key-id-api.html>`_
1219
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/update-connector-api-key-id-api.html>`_
1220
1220
 
1221
1221
  :param connector_id: The unique identifier of the connector to be updated
1222
1222
  :param api_key_id:
@@ -1275,7 +1275,7 @@ class ConnectorClient(NamespacedClient):
1275
1275
  <p>Update the configuration field in the connector document.</p>
1276
1276
 
1277
1277
 
1278
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/update-connector-configuration-api.html>`_
1278
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/update-connector-configuration-api.html>`_
1279
1279
 
1280
1280
  :param connector_id: The unique identifier of the connector to be updated
1281
1281
  :param configuration:
@@ -1335,7 +1335,7 @@ class ConnectorClient(NamespacedClient):
1335
1335
  Otherwise, if the error is reset to null, the connector status is updated to connected.</p>
1336
1336
 
1337
1337
 
1338
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/update-connector-error-api.html>`_
1338
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/update-connector-error-api.html>`_
1339
1339
 
1340
1340
  :param connector_id: The unique identifier of the connector to be updated
1341
1341
  :param error:
@@ -1403,7 +1403,7 @@ class ConnectorClient(NamespacedClient):
1403
1403
  This service runs automatically on Elastic Cloud for Elastic managed connectors.</p>
1404
1404
 
1405
1405
 
1406
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/update-connector-features-api.html>`_
1406
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/update-connector-features-api.html>`_
1407
1407
 
1408
1408
  :param connector_id: The unique identifier of the connector to be updated.
1409
1409
  :param features:
@@ -1464,7 +1464,7 @@ class ConnectorClient(NamespacedClient):
1464
1464
  The filtering property is used to configure sync rules (both basic and advanced) for a connector.</p>
1465
1465
 
1466
1466
 
1467
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/update-connector-filtering-api.html>`_
1467
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/update-connector-filtering-api.html>`_
1468
1468
 
1469
1469
  :param connector_id: The unique identifier of the connector to be updated
1470
1470
  :param advanced_snippet:
@@ -1525,7 +1525,7 @@ class ConnectorClient(NamespacedClient):
1525
1525
  <p>Update the draft filtering validation info for a connector.</p>
1526
1526
 
1527
1527
 
1528
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/update-connector-filtering-validation-api.html>`_
1528
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/update-connector-filtering-validation-api.html>`_
1529
1529
 
1530
1530
  :param connector_id: The unique identifier of the connector to be updated
1531
1531
  :param validation:
@@ -1582,7 +1582,7 @@ class ConnectorClient(NamespacedClient):
1582
1582
  <p>Update the <code>index_name</code> field of a connector, specifying the index where the data ingested by the connector is stored.</p>
1583
1583
 
1584
1584
 
1585
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/update-connector-index-name-api.html>`_
1585
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/update-connector-index-name-api.html>`_
1586
1586
 
1587
1587
  :param connector_id: The unique identifier of the connector to be updated
1588
1588
  :param index_name:
@@ -1639,7 +1639,7 @@ class ConnectorClient(NamespacedClient):
1639
1639
  <p>Update the connector name and description.</p>
1640
1640
 
1641
1641
 
1642
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/update-connector-name-description-api.html>`_
1642
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/update-connector-name-description-api.html>`_
1643
1643
 
1644
1644
  :param connector_id: The unique identifier of the connector to be updated
1645
1645
  :param description:
@@ -1696,7 +1696,7 @@ class ConnectorClient(NamespacedClient):
1696
1696
  <p>Update the connector is_native flag.</p>
1697
1697
 
1698
1698
 
1699
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/update-connector-native-api.html>`_
1699
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/update-connector-native-api.html>`_
1700
1700
 
1701
1701
  :param connector_id: The unique identifier of the connector to be updated
1702
1702
  :param is_native:
@@ -1753,7 +1753,7 @@ class ConnectorClient(NamespacedClient):
1753
1753
  <p>When you create a new connector, the configuration of an ingest pipeline is populated with default settings.</p>
1754
1754
 
1755
1755
 
1756
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/update-connector-pipeline-api.html>`_
1756
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/update-connector-pipeline-api.html>`_
1757
1757
 
1758
1758
  :param connector_id: The unique identifier of the connector to be updated
1759
1759
  :param pipeline:
@@ -1809,7 +1809,7 @@ class ConnectorClient(NamespacedClient):
1809
1809
  <p>Update the connector scheduling.</p>
1810
1810
 
1811
1811
 
1812
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/update-connector-scheduling-api.html>`_
1812
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/update-connector-scheduling-api.html>`_
1813
1813
 
1814
1814
  :param connector_id: The unique identifier of the connector to be updated
1815
1815
  :param scheduling:
@@ -1865,7 +1865,7 @@ class ConnectorClient(NamespacedClient):
1865
1865
  <p>Update the connector service type.</p>
1866
1866
 
1867
1867
 
1868
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/update-connector-service-type-api.html>`_
1868
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/update-connector-service-type-api.html>`_
1869
1869
 
1870
1870
  :param connector_id: The unique identifier of the connector to be updated
1871
1871
  :param service_type:
@@ -1928,7 +1928,7 @@ class ConnectorClient(NamespacedClient):
1928
1928
  <p>Update the connector status.</p>
1929
1929
 
1930
1930
 
1931
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/update-connector-status-api.html>`_
1931
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/update-connector-status-api.html>`_
1932
1932
 
1933
1933
  :param connector_id: The unique identifier of the connector to be updated
1934
1934
  :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/guide/en/elasticsearch/reference/8.18/dangling-index-delete.html>`_
49
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/dangling-index-delete.html>`_
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/guide/en/elasticsearch/reference/8.18/dangling-index-import.html>`_
110
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/dangling-index-import.html>`_
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/guide/en/elasticsearch/reference/8.18/dangling-indices-list.html>`_
171
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/dangling-indices-list.html>`_
172
172
  """
173
173
  __path_parts: t.Dict[str, str] = {}
174
174
  __path = "/_dangling"