elasticsearch 8.18.0__py3-none-any.whl → 9.0.1__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 (107) hide show
  1. elasticsearch/_async/client/__init__.py +62 -277
  2. elasticsearch/_async/client/_base.py +1 -1
  3. elasticsearch/_async/client/async_search.py +6 -10
  4. elasticsearch/_async/client/autoscaling.py +4 -4
  5. elasticsearch/_async/client/cat.py +26 -33
  6. elasticsearch/_async/client/ccr.py +13 -13
  7. elasticsearch/_async/client/cluster.py +20 -20
  8. elasticsearch/_async/client/connector.py +44 -30
  9. elasticsearch/_async/client/dangling_indices.py +3 -3
  10. elasticsearch/_async/client/enrich.py +5 -5
  11. elasticsearch/_async/client/eql.py +4 -4
  12. elasticsearch/_async/client/esql.py +7 -11
  13. elasticsearch/_async/client/features.py +2 -2
  14. elasticsearch/_async/client/fleet.py +18 -20
  15. elasticsearch/_async/client/graph.py +1 -1
  16. elasticsearch/_async/client/ilm.py +18 -11
  17. elasticsearch/_async/client/indices.py +75 -163
  18. elasticsearch/_async/client/inference.py +132 -25
  19. elasticsearch/_async/client/ingest.py +12 -12
  20. elasticsearch/_async/client/license.py +7 -7
  21. elasticsearch/_async/client/logstash.py +3 -3
  22. elasticsearch/_async/client/migration.py +3 -3
  23. elasticsearch/_async/client/ml.py +80 -85
  24. elasticsearch/_async/client/monitoring.py +1 -1
  25. elasticsearch/_async/client/nodes.py +8 -8
  26. elasticsearch/_async/client/query_rules.py +8 -8
  27. elasticsearch/_async/client/rollup.py +8 -8
  28. elasticsearch/_async/client/search_application.py +10 -10
  29. elasticsearch/_async/client/searchable_snapshots.py +4 -4
  30. elasticsearch/_async/client/security.py +71 -68
  31. elasticsearch/_async/client/shutdown.py +3 -3
  32. elasticsearch/_async/client/simulate.py +1 -1
  33. elasticsearch/_async/client/slm.py +9 -9
  34. elasticsearch/_async/client/snapshot.py +280 -130
  35. elasticsearch/_async/client/sql.py +6 -6
  36. elasticsearch/_async/client/ssl.py +1 -1
  37. elasticsearch/_async/client/synonyms.py +7 -7
  38. elasticsearch/_async/client/tasks.py +3 -3
  39. elasticsearch/_async/client/text_structure.py +4 -4
  40. elasticsearch/_async/client/transform.py +11 -11
  41. elasticsearch/_async/client/watcher.py +14 -14
  42. elasticsearch/_async/client/xpack.py +2 -2
  43. elasticsearch/_sync/client/__init__.py +62 -277
  44. elasticsearch/_sync/client/_base.py +1 -1
  45. elasticsearch/_sync/client/async_search.py +6 -10
  46. elasticsearch/_sync/client/autoscaling.py +4 -4
  47. elasticsearch/_sync/client/cat.py +26 -33
  48. elasticsearch/_sync/client/ccr.py +13 -13
  49. elasticsearch/_sync/client/cluster.py +20 -20
  50. elasticsearch/_sync/client/connector.py +44 -30
  51. elasticsearch/_sync/client/dangling_indices.py +3 -3
  52. elasticsearch/_sync/client/enrich.py +5 -5
  53. elasticsearch/_sync/client/eql.py +4 -4
  54. elasticsearch/_sync/client/esql.py +7 -11
  55. elasticsearch/_sync/client/features.py +2 -2
  56. elasticsearch/_sync/client/fleet.py +18 -20
  57. elasticsearch/_sync/client/graph.py +1 -1
  58. elasticsearch/_sync/client/ilm.py +18 -11
  59. elasticsearch/_sync/client/indices.py +75 -163
  60. elasticsearch/_sync/client/inference.py +132 -25
  61. elasticsearch/_sync/client/ingest.py +12 -12
  62. elasticsearch/_sync/client/license.py +7 -7
  63. elasticsearch/_sync/client/logstash.py +3 -3
  64. elasticsearch/_sync/client/migration.py +3 -3
  65. elasticsearch/_sync/client/ml.py +80 -85
  66. elasticsearch/_sync/client/monitoring.py +1 -1
  67. elasticsearch/_sync/client/nodes.py +8 -8
  68. elasticsearch/_sync/client/query_rules.py +8 -8
  69. elasticsearch/_sync/client/rollup.py +8 -8
  70. elasticsearch/_sync/client/search_application.py +10 -10
  71. elasticsearch/_sync/client/searchable_snapshots.py +4 -4
  72. elasticsearch/_sync/client/security.py +71 -68
  73. elasticsearch/_sync/client/shutdown.py +3 -3
  74. elasticsearch/_sync/client/simulate.py +1 -1
  75. elasticsearch/_sync/client/slm.py +9 -9
  76. elasticsearch/_sync/client/snapshot.py +280 -130
  77. elasticsearch/_sync/client/sql.py +6 -6
  78. elasticsearch/_sync/client/ssl.py +1 -1
  79. elasticsearch/_sync/client/synonyms.py +7 -7
  80. elasticsearch/_sync/client/tasks.py +3 -3
  81. elasticsearch/_sync/client/text_structure.py +4 -4
  82. elasticsearch/_sync/client/transform.py +11 -11
  83. elasticsearch/_sync/client/utils.py +0 -37
  84. elasticsearch/_sync/client/watcher.py +14 -14
  85. elasticsearch/_sync/client/xpack.py +2 -2
  86. elasticsearch/_version.py +1 -1
  87. elasticsearch/dsl/_async/search.py +7 -3
  88. elasticsearch/dsl/_sync/search.py +7 -3
  89. elasticsearch/dsl/aggs.py +11 -7
  90. elasticsearch/dsl/faceted_search_base.py +4 -4
  91. elasticsearch/dsl/field.py +139 -1
  92. elasticsearch/dsl/query.py +7 -1
  93. elasticsearch/dsl/search_base.py +16 -3
  94. elasticsearch/dsl/types.py +66 -84
  95. elasticsearch/dsl/wrappers.py +25 -0
  96. elasticsearch/exceptions.py +2 -0
  97. elasticsearch/helpers/vectorstore/_async/strategies.py +12 -12
  98. elasticsearch/helpers/vectorstore/_sync/strategies.py +12 -12
  99. {elasticsearch-8.18.0.dist-info → elasticsearch-9.0.1.dist-info}/METADATA +17 -29
  100. elasticsearch-9.0.1.dist-info/RECORD +162 -0
  101. elasticsearch-9.0.1.dist-info/licenses/LICENSE.txt +175 -0
  102. elasticsearch-9.0.1.dist-info/licenses/NOTICE.txt +559 -0
  103. elasticsearch/transport.py +0 -57
  104. elasticsearch-8.18.0.dist-info/RECORD +0 -161
  105. {elasticsearch-8.18.0.dist-info → elasticsearch-9.0.1.dist-info}/WHEEL +0 -0
  106. {elasticsearch-8.18.0.dist-info → elasticsearch-9.0.1.dist-info}/licenses/LICENSE +0 -0
  107. {elasticsearch-8.18.0.dist-info → elasticsearch-9.0.1.dist-info}/licenses/NOTICE +0 -0
@@ -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/docs/api/doc/elasticsearch/v9/operation/operation-cluster-allocation-explain>`_
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/docs/api/doc/elasticsearch/v9/operation/operation-cluster-put-component-template>`_
134
134
 
135
135
  :param name: Comma-separated list or wildcard expression of component template
136
136
  names used to limit the request.
@@ -185,7 +185,7 @@ class ClusterClient(NamespacedClient):
185
185
  Remove master-eligible nodes from the voting configuration exclusion list.</p>
186
186
 
187
187
 
188
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/voting-config-exclusions.html>`_
188
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cluster-post-voting-config-exclusions>`_
189
189
 
190
190
  :param master_timeout: Period to wait for a connection to the master node.
191
191
  :param wait_for_removal: Specifies whether to wait for all excluded nodes to
@@ -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/docs/api/doc/elasticsearch/v9/operation/operation-cluster-put-component-template>`_
243
243
 
244
244
  :param name: Comma-separated list of component template names used to limit the
245
245
  request. Wildcard (*) expressions are supported.
@@ -298,7 +298,7 @@ class ClusterClient(NamespacedClient):
298
298
  Get information about component templates.</p>
299
299
 
300
300
 
301
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/indices-component-template.html>`_
301
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cluster-put-component-template>`_
302
302
 
303
303
  :param name: Comma-separated list of component template names used to limit the
304
304
  request. Wildcard (`*`) expressions are supported.
@@ -365,7 +365,7 @@ class ClusterClient(NamespacedClient):
365
365
  By default, it returns only settings that have been explicitly defined.</p>
366
366
 
367
367
 
368
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cluster-get-settings.html>`_
368
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cluster-get-settings>`_
369
369
 
370
370
  :param flat_settings: If `true`, returns settings in flat format.
371
371
  :param include_defaults: If `true`, returns default cluster settings from the
@@ -447,8 +447,8 @@ class ClusterClient(NamespacedClient):
447
447
  """
448
448
  .. raw:: html
449
449
 
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.
450
+ <p>Get the cluster health status.</p>
451
+ <p>You can also use the API to get the health status of only specified data streams and indices.
452
452
  For data streams, the API retrieves the health status of the stream’s backing indices.</p>
453
453
  <p>The cluster health status is: green, yellow or red.
454
454
  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 +457,7 @@ class ClusterClient(NamespacedClient):
457
457
  The cluster status is controlled by the worst index status.</p>
458
458
 
459
459
 
460
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cluster-health.html>`_
460
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cluster-health>`_
461
461
 
462
462
  :param index: Comma-separated list of data streams, indices, and index aliases
463
463
  used to limit the request. Wildcard expressions (`*`) are supported. To target
@@ -565,7 +565,7 @@ class ClusterClient(NamespacedClient):
565
565
  Returns basic information about the cluster.</p>
566
566
 
567
567
 
568
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cluster-info.html>`_
568
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cluster-info>`_
569
569
 
570
570
  :param target: Limits the information returned to the specific target. Supports
571
571
  a comma-separated list, such as http,ingest.
@@ -614,7 +614,7 @@ class ClusterClient(NamespacedClient):
614
614
  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
615
 
616
616
 
617
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cluster-pending.html>`_
617
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cluster-pending-tasks>`_
618
618
 
619
619
  :param local: If `true`, the request retrieves information from the local node
620
620
  only. If `false`, information is retrieved from the master node.
@@ -680,7 +680,7 @@ class ClusterClient(NamespacedClient):
680
680
  They are not required when removing master-ineligible nodes or when removing fewer than half of the master-eligible nodes.</p>
681
681
 
682
682
 
683
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/voting-config-exclusions.html>`_
683
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cluster-post-voting-config-exclusions>`_
684
684
 
685
685
  :param master_timeout: Period to wait for a connection to the master node.
686
686
  :param node_ids: A comma-separated list of the persistent ids of the nodes to
@@ -761,7 +761,7 @@ class ClusterClient(NamespacedClient):
761
761
  To be applied, a component template must be included in an index template's <code>composed_of</code> list.</p>
762
762
 
763
763
 
764
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/indices-component-template.html>`_
764
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cluster-put-component-template>`_
765
765
 
766
766
  :param name: Name of the component template to create. Elasticsearch includes
767
767
  the following built-in component templates: `logs-mappings`; `logs-settings`;
@@ -850,8 +850,8 @@ class ClusterClient(NamespacedClient):
850
850
  """
851
851
  .. raw:: html
852
852
 
853
- <p>Update the cluster settings.
854
- Configure and update dynamic settings on a running cluster.
853
+ <p>Update the cluster settings.</p>
854
+ <p>Configure and update dynamic settings on a running cluster.
855
855
  You can also configure dynamic settings locally on an unstarted or shut down node in <code>elasticsearch.yml</code>.</p>
856
856
  <p>Updates made with this API can be persistent, which apply across cluster restarts, or transient, which reset after a cluster restart.
857
857
  You can also reset transient or persistent settings by assigning them a null value.</p>
@@ -866,7 +866,7 @@ class ClusterClient(NamespacedClient):
866
866
  If a cluster becomes unstable, transient settings can clear unexpectedly, resulting in a potentially undesired cluster configuration.</p>
867
867
 
868
868
 
869
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cluster-update-settings.html>`_
869
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cluster-put-settings>`_
870
870
 
871
871
  :param flat_settings: Return settings in flat format (default: false)
872
872
  :param master_timeout: Explicit operation timeout for connection to master node
@@ -932,7 +932,7 @@ class ClusterClient(NamespacedClient):
932
932
  </blockquote>
933
933
 
934
934
 
935
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cluster-remote-info.html>`_
935
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cluster-remote-info>`_
936
936
  """
937
937
  __path_parts: t.Dict[str, str] = {}
938
938
  __path = "/_remote/info"
@@ -989,7 +989,7 @@ class ClusterClient(NamespacedClient):
989
989
  <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
990
 
991
991
 
992
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cluster-reroute.html>`_
992
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cluster-reroute>`_
993
993
 
994
994
  :param commands: Defines the commands to perform.
995
995
  :param dry_run: If true, then the request simulates the operation. It will calculate
@@ -1094,7 +1094,7 @@ class ClusterClient(NamespacedClient):
1094
1094
  Instead, obtain the information you require using other more stable cluster APIs.</p>
1095
1095
 
1096
1096
 
1097
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cluster-state.html>`_
1097
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cluster-state>`_
1098
1098
 
1099
1099
  :param metric: Limit the information returned to the specified metrics
1100
1100
  :param index: A comma-separated list of index names; use `_all` or empty string
@@ -1182,7 +1182,7 @@ class ClusterClient(NamespacedClient):
1182
1182
  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
1183
 
1184
1184
 
1185
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cluster-stats.html>`_
1185
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cluster-stats>`_
1186
1186
 
1187
1187
  :param node_id: Comma-separated list of node filters used to limit returned information.
1188
1188
  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/docs/api/doc/elasticsearch/v9/operation/operation-connector-check-in>`_
53
53
 
54
54
  :param connector_id: The unique identifier of the connector to be checked in
55
55
  """
@@ -85,6 +85,7 @@ class ConnectorClient(NamespacedClient):
85
85
  delete_sync_jobs: t.Optional[bool] = None,
86
86
  error_trace: t.Optional[bool] = None,
87
87
  filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
88
+ hard: t.Optional[bool] = None,
88
89
  human: t.Optional[bool] = None,
89
90
  pretty: t.Optional[bool] = None,
90
91
  ) -> ObjectApiResponse[t.Any]:
@@ -98,11 +99,12 @@ class ConnectorClient(NamespacedClient):
98
99
  These need to be removed manually.</p>
99
100
 
100
101
 
101
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/delete-connector-api.html>`_
102
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-delete>`_
102
103
 
103
104
  :param connector_id: The unique identifier of the connector to be deleted
104
105
  :param delete_sync_jobs: A flag indicating if associated sync jobs should be
105
106
  also removed. Defaults to false.
107
+ :param hard: A flag indicating if the connector should be hard deleted.
106
108
  """
107
109
  if connector_id in SKIP_IN_PATH:
108
110
  raise ValueError("Empty value passed for parameter 'connector_id'")
@@ -115,6 +117,8 @@ class ConnectorClient(NamespacedClient):
115
117
  __query["error_trace"] = error_trace
116
118
  if filter_path is not None:
117
119
  __query["filter_path"] = filter_path
120
+ if hard is not None:
121
+ __query["hard"] = hard
118
122
  if human is not None:
119
123
  __query["human"] = human
120
124
  if pretty is not None:
@@ -138,6 +142,7 @@ class ConnectorClient(NamespacedClient):
138
142
  error_trace: t.Optional[bool] = None,
139
143
  filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
140
144
  human: t.Optional[bool] = None,
145
+ include_deleted: t.Optional[bool] = None,
141
146
  pretty: t.Optional[bool] = None,
142
147
  ) -> ObjectApiResponse[t.Any]:
143
148
  """
@@ -147,9 +152,11 @@ class ConnectorClient(NamespacedClient):
147
152
  <p>Get the details about a connector.</p>
148
153
 
149
154
 
150
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/get-connector-api.html>`_
155
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-get>`_
151
156
 
152
157
  :param connector_id: The unique identifier of the connector
158
+ :param include_deleted: A flag to indicate if the desired connector should be
159
+ fetched, even if it was soft-deleted.
153
160
  """
154
161
  if connector_id in SKIP_IN_PATH:
155
162
  raise ValueError("Empty value passed for parameter 'connector_id'")
@@ -162,6 +169,8 @@ class ConnectorClient(NamespacedClient):
162
169
  __query["filter_path"] = filter_path
163
170
  if human is not None:
164
171
  __query["human"] = human
172
+ if include_deleted is not None:
173
+ __query["include_deleted"] = include_deleted
165
174
  if pretty is not None:
166
175
  __query["pretty"] = pretty
167
176
  __headers = {"accept": "application/json"}
@@ -247,7 +256,7 @@ class ConnectorClient(NamespacedClient):
247
256
  This action is used for analytics and monitoring.</p>
248
257
 
249
258
 
250
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/update-connector-last-sync-api.html>`_
259
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-last-sync>`_
251
260
 
252
261
  :param connector_id: The unique identifier of the connector to be updated
253
262
  :param last_access_control_sync_error:
@@ -333,6 +342,7 @@ class ConnectorClient(NamespacedClient):
333
342
  filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
334
343
  from_: t.Optional[int] = None,
335
344
  human: t.Optional[bool] = None,
345
+ include_deleted: t.Optional[bool] = None,
336
346
  index_name: t.Optional[t.Union[str, t.Sequence[str]]] = None,
337
347
  pretty: t.Optional[bool] = None,
338
348
  query: t.Optional[str] = None,
@@ -346,11 +356,13 @@ class ConnectorClient(NamespacedClient):
346
356
  <p>Get information about all connectors.</p>
347
357
 
348
358
 
349
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/list-connector-api.html>`_
359
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-list>`_
350
360
 
351
361
  :param connector_name: A comma-separated list of connector names to fetch connector
352
362
  documents for
353
363
  :param from_: Starting offset (default: 0)
364
+ :param include_deleted: A flag to indicate if the desired connector should be
365
+ fetched, even if it was soft-deleted.
354
366
  :param index_name: A comma-separated list of connector index names to fetch connector
355
367
  documents for
356
368
  :param query: A wildcard query string that filters connectors with matching name,
@@ -372,6 +384,8 @@ class ConnectorClient(NamespacedClient):
372
384
  __query["from"] = from_
373
385
  if human is not None:
374
386
  __query["human"] = human
387
+ if include_deleted is not None:
388
+ __query["include_deleted"] = include_deleted
375
389
  if index_name is not None:
376
390
  __query["index_name"] = index_name
377
391
  if pretty is not None:
@@ -427,7 +441,7 @@ class ConnectorClient(NamespacedClient):
427
441
  Self-managed connectors (Connector clients) are self-managed on your infrastructure.</p>
428
442
 
429
443
 
430
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/create-connector-api.html>`_
444
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-put>`_
431
445
 
432
446
  :param description:
433
447
  :param index_name:
@@ -509,7 +523,7 @@ class ConnectorClient(NamespacedClient):
509
523
  <p>Create or update a connector.</p>
510
524
 
511
525
 
512
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/create-connector-api.html>`_
526
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-put>`_
513
527
 
514
528
  :param connector_id: The unique identifier of the connector to be created or
515
529
  updated. ID is auto-generated if not provided.
@@ -584,7 +598,7 @@ class ConnectorClient(NamespacedClient):
584
598
  The connector service is then responsible for setting the status of connector sync jobs to cancelled.</p>
585
599
 
586
600
 
587
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cancel-connector-sync-job-api.html>`_
601
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-sync-job-cancel>`_
588
602
 
589
603
  :param connector_sync_job_id: The unique identifier of the connector sync job
590
604
  """
@@ -635,7 +649,7 @@ class ConnectorClient(NamespacedClient):
635
649
  This service runs automatically on Elastic Cloud for Elastic managed connectors.</p>
636
650
 
637
651
 
638
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/check-in-connector-sync-job-api.html>`_
652
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-sync-job-check-in>`_
639
653
 
640
654
  :param connector_sync_job_id: The unique identifier of the connector sync job
641
655
  to be checked in.
@@ -695,7 +709,7 @@ class ConnectorClient(NamespacedClient):
695
709
  This service runs automatically on Elastic Cloud for Elastic managed connectors.</p>
696
710
 
697
711
 
698
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/claim-connector-sync-job-api.html>`_
712
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-sync-job-claim>`_
699
713
 
700
714
  :param connector_sync_job_id: The unique identifier of the connector sync job.
701
715
  :param worker_hostname: The host name of the current system that will run the
@@ -757,7 +771,7 @@ class ConnectorClient(NamespacedClient):
757
771
  This is a destructive action that is not recoverable.</p>
758
772
 
759
773
 
760
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/delete-connector-sync-job-api.html>`_
774
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-sync-job-delete>`_
761
775
 
762
776
  :param connector_sync_job_id: The unique identifier of the connector sync job
763
777
  to be deleted
@@ -811,7 +825,7 @@ class ConnectorClient(NamespacedClient):
811
825
  This service runs automatically on Elastic Cloud for Elastic managed connectors.</p>
812
826
 
813
827
 
814
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/set-connector-sync-job-error-api.html>`_
828
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-sync-job-error>`_
815
829
 
816
830
  :param connector_sync_job_id: The unique identifier for the connector sync job.
817
831
  :param error: The error for the connector sync job error field.
@@ -865,7 +879,7 @@ class ConnectorClient(NamespacedClient):
865
879
  <p>Get a connector sync job.</p>
866
880
 
867
881
 
868
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/get-connector-sync-job-api.html>`_
882
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-sync-job-get>`_
869
883
 
870
884
  :param connector_sync_job_id: The unique identifier of the connector sync job
871
885
  """
@@ -938,7 +952,7 @@ class ConnectorClient(NamespacedClient):
938
952
  <p>Get information about all stored connector sync jobs listed by their creation date in ascending order.</p>
939
953
 
940
954
 
941
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/list-connector-sync-jobs-api.html>`_
955
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-sync-job-list>`_
942
956
 
943
957
  :param connector_id: A connector id to fetch connector sync jobs for
944
958
  :param from_: Starting offset (default: 0)
@@ -1004,7 +1018,7 @@ class ConnectorClient(NamespacedClient):
1004
1018
  <p>Create a connector sync job document in the internal index and initialize its counters and timestamps with default values.</p>
1005
1019
 
1006
1020
 
1007
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/create-connector-sync-job-api.html>`_
1021
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-sync-job-post>`_
1008
1022
 
1009
1023
  :param id: The id of the associated connector
1010
1024
  :param job_type:
@@ -1080,7 +1094,7 @@ class ConnectorClient(NamespacedClient):
1080
1094
  This service runs automatically on Elastic Cloud for Elastic managed connectors.</p>
1081
1095
 
1082
1096
 
1083
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/set-connector-sync-job-stats-api.html>`_
1097
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-sync-job-update-stats>`_
1084
1098
 
1085
1099
  :param connector_sync_job_id: The unique identifier of the connector sync job.
1086
1100
  :param deleted_document_count: The number of documents the sync job deleted.
@@ -1163,7 +1177,7 @@ class ConnectorClient(NamespacedClient):
1163
1177
  <p>Activates the valid draft filtering for a connector.</p>
1164
1178
 
1165
1179
 
1166
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/update-connector-filtering-api.html>`_
1180
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-filtering>`_
1167
1181
 
1168
1182
  :param connector_id: The unique identifier of the connector to be updated
1169
1183
  """
@@ -1216,7 +1230,7 @@ class ConnectorClient(NamespacedClient):
1216
1230
  Self-managed connectors (connector clients) do not use this field.</p>
1217
1231
 
1218
1232
 
1219
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/update-connector-api-key-id-api.html>`_
1233
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-api-key-id>`_
1220
1234
 
1221
1235
  :param connector_id: The unique identifier of the connector to be updated
1222
1236
  :param api_key_id:
@@ -1275,7 +1289,7 @@ class ConnectorClient(NamespacedClient):
1275
1289
  <p>Update the configuration field in the connector document.</p>
1276
1290
 
1277
1291
 
1278
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/update-connector-configuration-api.html>`_
1292
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-configuration>`_
1279
1293
 
1280
1294
  :param connector_id: The unique identifier of the connector to be updated
1281
1295
  :param configuration:
@@ -1335,7 +1349,7 @@ class ConnectorClient(NamespacedClient):
1335
1349
  Otherwise, if the error is reset to null, the connector status is updated to connected.</p>
1336
1350
 
1337
1351
 
1338
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/update-connector-error-api.html>`_
1352
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-error>`_
1339
1353
 
1340
1354
  :param connector_id: The unique identifier of the connector to be updated
1341
1355
  :param error:
@@ -1403,7 +1417,7 @@ class ConnectorClient(NamespacedClient):
1403
1417
  This service runs automatically on Elastic Cloud for Elastic managed connectors.</p>
1404
1418
 
1405
1419
 
1406
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/update-connector-features-api.html>`_
1420
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-features>`_
1407
1421
 
1408
1422
  :param connector_id: The unique identifier of the connector to be updated.
1409
1423
  :param features:
@@ -1464,7 +1478,7 @@ class ConnectorClient(NamespacedClient):
1464
1478
  The filtering property is used to configure sync rules (both basic and advanced) for a connector.</p>
1465
1479
 
1466
1480
 
1467
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/update-connector-filtering-api.html>`_
1481
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-filtering>`_
1468
1482
 
1469
1483
  :param connector_id: The unique identifier of the connector to be updated
1470
1484
  :param advanced_snippet:
@@ -1525,7 +1539,7 @@ class ConnectorClient(NamespacedClient):
1525
1539
  <p>Update the draft filtering validation info for a connector.</p>
1526
1540
 
1527
1541
 
1528
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/update-connector-filtering-validation-api.html>`_
1542
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-filtering-validation>`_
1529
1543
 
1530
1544
  :param connector_id: The unique identifier of the connector to be updated
1531
1545
  :param validation:
@@ -1582,7 +1596,7 @@ class ConnectorClient(NamespacedClient):
1582
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>
1583
1597
 
1584
1598
 
1585
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/update-connector-index-name-api.html>`_
1599
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-index-name>`_
1586
1600
 
1587
1601
  :param connector_id: The unique identifier of the connector to be updated
1588
1602
  :param index_name:
@@ -1639,7 +1653,7 @@ class ConnectorClient(NamespacedClient):
1639
1653
  <p>Update the connector name and description.</p>
1640
1654
 
1641
1655
 
1642
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/update-connector-name-description-api.html>`_
1656
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-name>`_
1643
1657
 
1644
1658
  :param connector_id: The unique identifier of the connector to be updated
1645
1659
  :param description:
@@ -1696,7 +1710,7 @@ class ConnectorClient(NamespacedClient):
1696
1710
  <p>Update the connector is_native flag.</p>
1697
1711
 
1698
1712
 
1699
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/update-connector-native-api.html>`_
1713
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-native>`_
1700
1714
 
1701
1715
  :param connector_id: The unique identifier of the connector to be updated
1702
1716
  :param is_native:
@@ -1753,7 +1767,7 @@ class ConnectorClient(NamespacedClient):
1753
1767
  <p>When you create a new connector, the configuration of an ingest pipeline is populated with default settings.</p>
1754
1768
 
1755
1769
 
1756
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/update-connector-pipeline-api.html>`_
1770
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-pipeline>`_
1757
1771
 
1758
1772
  :param connector_id: The unique identifier of the connector to be updated
1759
1773
  :param pipeline:
@@ -1809,7 +1823,7 @@ class ConnectorClient(NamespacedClient):
1809
1823
  <p>Update the connector scheduling.</p>
1810
1824
 
1811
1825
 
1812
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/update-connector-scheduling-api.html>`_
1826
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-scheduling>`_
1813
1827
 
1814
1828
  :param connector_id: The unique identifier of the connector to be updated
1815
1829
  :param scheduling:
@@ -1865,7 +1879,7 @@ class ConnectorClient(NamespacedClient):
1865
1879
  <p>Update the connector service type.</p>
1866
1880
 
1867
1881
 
1868
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/update-connector-service-type-api.html>`_
1882
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-service-type>`_
1869
1883
 
1870
1884
  :param connector_id: The unique identifier of the connector to be updated
1871
1885
  :param service_type:
@@ -1928,7 +1942,7 @@ class ConnectorClient(NamespacedClient):
1928
1942
  <p>Update the connector status.</p>
1929
1943
 
1930
1944
 
1931
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/update-connector-status-api.html>`_
1945
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-status>`_
1932
1946
 
1933
1947
  :param connector_id: The unique identifier of the connector to be updated
1934
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/guide/en/elasticsearch/reference/8.18/dangling-index-delete.html>`_
49
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/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/guide/en/elasticsearch/reference/8.18/dangling-index-import.html>`_
110
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/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/guide/en/elasticsearch/reference/8.18/dangling-indices-list.html>`_
171
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-dangling-indices-list-dangling-indices>`_
172
172
  """
173
173
  __path_parts: t.Dict[str, str] = {}
174
174
  __path = "/_dangling"
@@ -43,7 +43,7 @@ class EnrichClient(NamespacedClient):
43
43
  Deletes an existing enrich policy and its enrich index.</p>
44
44
 
45
45
 
46
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/delete-enrich-policy-api.html>`_
46
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-enrich-delete-policy>`_
47
47
 
48
48
  :param name: Enrich policy to delete.
49
49
  :param master_timeout: Period to wait for a connection to the master node.
@@ -92,7 +92,7 @@ class EnrichClient(NamespacedClient):
92
92
  Create the enrich index for an existing enrich policy.</p>
93
93
 
94
94
 
95
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/execute-enrich-policy-api.html>`_
95
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-enrich-execute-policy>`_
96
96
 
97
97
  :param name: Enrich policy to execute.
98
98
  :param master_timeout: Period to wait for a connection to the master node.
@@ -144,7 +144,7 @@ class EnrichClient(NamespacedClient):
144
144
  Returns information about an enrich policy.</p>
145
145
 
146
146
 
147
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/get-enrich-policy-api.html>`_
147
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-enrich-get-policy>`_
148
148
 
149
149
  :param name: Comma-separated list of enrich policy names used to limit the request.
150
150
  To return information for all enrich policies, omit this parameter.
@@ -202,7 +202,7 @@ class EnrichClient(NamespacedClient):
202
202
  Creates an enrich policy.</p>
203
203
 
204
204
 
205
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/put-enrich-policy-api.html>`_
205
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-enrich-put-policy>`_
206
206
 
207
207
  :param name: Name of the enrich policy to create or update.
208
208
  :param geo_match: Matches enrich data to incoming documents based on a `geo_shape`
@@ -263,7 +263,7 @@ class EnrichClient(NamespacedClient):
263
263
  Returns enrich coordinator statistics and information about enrich policies that are currently executing.</p>
264
264
 
265
265
 
266
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/enrich-stats-api.html>`_
266
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-enrich-stats>`_
267
267
 
268
268
  :param master_timeout: Period to wait for a connection to the master node.
269
269
  """
@@ -43,7 +43,7 @@ class EqlClient(NamespacedClient):
43
43
  The API also deletes results for the search.</p>
44
44
 
45
45
 
46
- `<https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-eql-delete>`_
46
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-eql-delete>`_
47
47
 
48
48
  :param id: Identifier for the search to delete. A search ID is provided in the
49
49
  EQL search API's response for an async search. A search ID is also provided
@@ -93,7 +93,7 @@ class EqlClient(NamespacedClient):
93
93
  Get the current status and available results for an async EQL search or a stored synchronous EQL search.</p>
94
94
 
95
95
 
96
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/get-async-eql-search-api.html>`_
96
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-eql-get>`_
97
97
 
98
98
  :param id: Identifier for the search.
99
99
  :param keep_alive: Period for which the search and its results are stored on
@@ -147,7 +147,7 @@ class EqlClient(NamespacedClient):
147
147
  Get the current status for an async EQL search or a stored synchronous EQL search without returning results.</p>
148
148
 
149
149
 
150
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/get-async-eql-status-api.html>`_
150
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-eql-get-status>`_
151
151
 
152
152
  :param id: Identifier for the search.
153
153
  """
@@ -246,7 +246,7 @@ class EqlClient(NamespacedClient):
246
246
  EQL assumes each document in a data stream or index corresponds to an event.</p>
247
247
 
248
248
 
249
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/eql-search-api.html>`_
249
+ `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-eql-search>`_
250
250
 
251
251
  :param index: The name of the index to scope the operation
252
252
  :param query: EQL query you wish to run.