elasticsearch 8.16.0__py3-none-any.whl → 8.17.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 (85) hide show
  1. elasticsearch/_async/client/__init__.py +82 -46
  2. elasticsearch/_async/client/async_search.py +12 -22
  3. elasticsearch/_async/client/autoscaling.py +39 -4
  4. elasticsearch/_async/client/cat.py +26 -26
  5. elasticsearch/_async/client/ccr.py +85 -35
  6. elasticsearch/_async/client/cluster.py +141 -49
  7. elasticsearch/_async/client/connector.py +25 -25
  8. elasticsearch/_async/client/dangling_indices.py +3 -3
  9. elasticsearch/_async/client/enrich.py +6 -6
  10. elasticsearch/_async/client/eql.py +13 -11
  11. elasticsearch/_async/client/esql.py +3 -2
  12. elasticsearch/_async/client/features.py +27 -5
  13. elasticsearch/_async/client/fleet.py +1 -1
  14. elasticsearch/_async/client/graph.py +9 -3
  15. elasticsearch/_async/client/ilm.py +69 -34
  16. elasticsearch/_async/client/indices.py +307 -105
  17. elasticsearch/_async/client/inference.py +5 -15
  18. elasticsearch/_async/client/ingest.py +28 -23
  19. elasticsearch/_async/client/license.py +38 -22
  20. elasticsearch/_async/client/logstash.py +3 -3
  21. elasticsearch/_async/client/migration.py +3 -3
  22. elasticsearch/_async/client/ml.py +125 -73
  23. elasticsearch/_async/client/monitoring.py +1 -1
  24. elasticsearch/_async/client/nodes.py +34 -20
  25. elasticsearch/_async/client/query_rules.py +17 -16
  26. elasticsearch/_async/client/rollup.py +8 -8
  27. elasticsearch/_async/client/search_application.py +8 -8
  28. elasticsearch/_async/client/searchable_snapshots.py +4 -4
  29. elasticsearch/_async/client/security.py +64 -57
  30. elasticsearch/_async/client/slm.py +9 -9
  31. elasticsearch/_async/client/snapshot.py +12 -12
  32. elasticsearch/_async/client/sql.py +16 -15
  33. elasticsearch/_async/client/ssl.py +1 -1
  34. elasticsearch/_async/client/synonyms.py +17 -14
  35. elasticsearch/_async/client/tasks.py +3 -3
  36. elasticsearch/_async/client/text_structure.py +2 -2
  37. elasticsearch/_async/client/transform.py +11 -11
  38. elasticsearch/_async/client/watcher.py +11 -11
  39. elasticsearch/_async/client/xpack.py +2 -2
  40. elasticsearch/_sync/client/__init__.py +82 -46
  41. elasticsearch/_sync/client/async_search.py +12 -22
  42. elasticsearch/_sync/client/autoscaling.py +39 -4
  43. elasticsearch/_sync/client/cat.py +26 -26
  44. elasticsearch/_sync/client/ccr.py +85 -35
  45. elasticsearch/_sync/client/cluster.py +141 -49
  46. elasticsearch/_sync/client/connector.py +25 -25
  47. elasticsearch/_sync/client/dangling_indices.py +3 -3
  48. elasticsearch/_sync/client/enrich.py +6 -6
  49. elasticsearch/_sync/client/eql.py +13 -11
  50. elasticsearch/_sync/client/esql.py +3 -2
  51. elasticsearch/_sync/client/features.py +27 -5
  52. elasticsearch/_sync/client/fleet.py +1 -1
  53. elasticsearch/_sync/client/graph.py +9 -3
  54. elasticsearch/_sync/client/ilm.py +69 -34
  55. elasticsearch/_sync/client/indices.py +307 -105
  56. elasticsearch/_sync/client/inference.py +5 -15
  57. elasticsearch/_sync/client/ingest.py +28 -23
  58. elasticsearch/_sync/client/license.py +38 -22
  59. elasticsearch/_sync/client/logstash.py +3 -3
  60. elasticsearch/_sync/client/migration.py +3 -3
  61. elasticsearch/_sync/client/ml.py +125 -73
  62. elasticsearch/_sync/client/monitoring.py +1 -1
  63. elasticsearch/_sync/client/nodes.py +34 -20
  64. elasticsearch/_sync/client/query_rules.py +17 -16
  65. elasticsearch/_sync/client/rollup.py +8 -8
  66. elasticsearch/_sync/client/search_application.py +8 -8
  67. elasticsearch/_sync/client/searchable_snapshots.py +4 -4
  68. elasticsearch/_sync/client/security.py +64 -57
  69. elasticsearch/_sync/client/slm.py +9 -9
  70. elasticsearch/_sync/client/snapshot.py +12 -12
  71. elasticsearch/_sync/client/sql.py +16 -15
  72. elasticsearch/_sync/client/ssl.py +1 -1
  73. elasticsearch/_sync/client/synonyms.py +17 -14
  74. elasticsearch/_sync/client/tasks.py +3 -3
  75. elasticsearch/_sync/client/text_structure.py +2 -2
  76. elasticsearch/_sync/client/transform.py +11 -11
  77. elasticsearch/_sync/client/watcher.py +11 -11
  78. elasticsearch/_sync/client/xpack.py +2 -2
  79. elasticsearch/_version.py +1 -1
  80. {elasticsearch-8.16.0.dist-info → elasticsearch-8.17.0.dist-info}/METADATA +6 -4
  81. elasticsearch-8.17.0.dist-info/RECORD +117 -0
  82. {elasticsearch-8.16.0.dist-info → elasticsearch-8.17.0.dist-info}/WHEEL +1 -1
  83. elasticsearch-8.16.0.dist-info/RECORD +0 -117
  84. {elasticsearch-8.16.0.dist-info → elasticsearch-8.17.0.dist-info}/licenses/LICENSE +0 -0
  85. {elasticsearch-8.16.0.dist-info → elasticsearch-8.17.0.dist-info}/licenses/NOTICE +0 -0
@@ -47,7 +47,7 @@ class SnapshotClient(NamespacedClient):
47
47
  Triggers the review of a snapshot repository’s contents and deletes any stale
48
48
  data not referenced by existing snapshots.
49
49
 
50
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/clean-up-snapshot-repo-api.html>`_
50
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/clean-up-snapshot-repo-api.html>`_
51
51
 
52
52
  :param name: Snapshot repository to clean up.
53
53
  :param master_timeout: Period to wait for a connection to the master node.
@@ -101,7 +101,7 @@ class SnapshotClient(NamespacedClient):
101
101
  """
102
102
  Clones indices from one snapshot into another snapshot in the same repository.
103
103
 
104
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/modules-snapshots.html>`_
104
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/modules-snapshots.html>`_
105
105
 
106
106
  :param repository: A repository name
107
107
  :param snapshot: The name of the snapshot to clone from
@@ -184,7 +184,7 @@ class SnapshotClient(NamespacedClient):
184
184
  """
185
185
  Creates a snapshot in a repository.
186
186
 
187
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/modules-snapshots.html>`_
187
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/modules-snapshots.html>`_
188
188
 
189
189
  :param repository: Repository for the snapshot.
190
190
  :param snapshot: Name of the snapshot. Must be unique in the repository.
@@ -288,7 +288,7 @@ class SnapshotClient(NamespacedClient):
288
288
  """
289
289
  Creates a repository.
290
290
 
291
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/modules-snapshots.html>`_
291
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/modules-snapshots.html>`_
292
292
 
293
293
  :param name: A repository name
294
294
  :param repository:
@@ -348,7 +348,7 @@ class SnapshotClient(NamespacedClient):
348
348
  """
349
349
  Deletes one or more snapshots.
350
350
 
351
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/modules-snapshots.html>`_
351
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/modules-snapshots.html>`_
352
352
 
353
353
  :param repository: A repository name
354
354
  :param snapshot: A comma-separated list of snapshot names
@@ -399,7 +399,7 @@ class SnapshotClient(NamespacedClient):
399
399
  """
400
400
  Deletes a repository.
401
401
 
402
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/modules-snapshots.html>`_
402
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/modules-snapshots.html>`_
403
403
 
404
404
  :param name: Name of the snapshot repository to unregister. Wildcard (`*`) patterns
405
405
  are supported.
@@ -473,7 +473,7 @@ class SnapshotClient(NamespacedClient):
473
473
  """
474
474
  Returns information about a snapshot.
475
475
 
476
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/modules-snapshots.html>`_
476
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/modules-snapshots.html>`_
477
477
 
478
478
  :param repository: Comma-separated list of snapshot repository names used to
479
479
  limit the request. Wildcard (*) expressions are supported.
@@ -585,7 +585,7 @@ class SnapshotClient(NamespacedClient):
585
585
  """
586
586
  Returns information about a repository.
587
587
 
588
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/modules-snapshots.html>`_
588
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/modules-snapshots.html>`_
589
589
 
590
590
  :param name: A comma-separated list of repository names
591
591
  :param local: Return local information, do not retrieve the state from master
@@ -644,7 +644,7 @@ class SnapshotClient(NamespacedClient):
644
644
  """
645
645
  Verifies the integrity of the contents of a snapshot repository
646
646
 
647
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/modules-snapshots.html>`_
647
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/modules-snapshots.html>`_
648
648
 
649
649
  :param name: A repository name
650
650
  :param blob_thread_pool_concurrency: Number of threads to use for reading blob
@@ -741,7 +741,7 @@ class SnapshotClient(NamespacedClient):
741
741
  """
742
742
  Restores a snapshot.
743
743
 
744
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/modules-snapshots.html>`_
744
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/modules-snapshots.html>`_
745
745
 
746
746
  :param repository: A repository name
747
747
  :param snapshot: A snapshot name
@@ -834,7 +834,7 @@ class SnapshotClient(NamespacedClient):
834
834
  """
835
835
  Returns information about the status of a snapshot.
836
836
 
837
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/modules-snapshots.html>`_
837
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/modules-snapshots.html>`_
838
838
 
839
839
  :param repository: A repository name
840
840
  :param snapshot: A comma-separated list of snapshot names
@@ -893,7 +893,7 @@ class SnapshotClient(NamespacedClient):
893
893
  """
894
894
  Verifies a repository.
895
895
 
896
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/modules-snapshots.html>`_
896
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/modules-snapshots.html>`_
897
897
 
898
898
  :param name: A repository name
899
899
  :param master_timeout: Explicit operation timeout for connection to master node
@@ -39,9 +39,9 @@ class SqlClient(NamespacedClient):
39
39
  body: t.Optional[t.Dict[str, t.Any]] = None,
40
40
  ) -> ObjectApiResponse[t.Any]:
41
41
  """
42
- Clears the SQL cursor
42
+ Clear an SQL search cursor.
43
43
 
44
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/clear-sql-cursor-api.html>`_
44
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/clear-sql-cursor-api.html>`_
45
45
 
46
46
  :param cursor: Cursor to clear.
47
47
  """
@@ -84,10 +84,10 @@ class SqlClient(NamespacedClient):
84
84
  pretty: t.Optional[bool] = None,
85
85
  ) -> ObjectApiResponse[t.Any]:
86
86
  """
87
- Deletes an async SQL search or a stored synchronous SQL search. If the search
88
- is still running, the API cancels it.
87
+ Delete an async SQL search. Delete an async SQL search or a stored synchronous
88
+ SQL search. If the search is still running, the API cancels it.
89
89
 
90
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/delete-async-sql-search-api.html>`_
90
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/delete-async-sql-search-api.html>`_
91
91
 
92
92
  :param id: Identifier for the search.
93
93
  """
@@ -131,10 +131,10 @@ class SqlClient(NamespacedClient):
131
131
  ] = None,
132
132
  ) -> ObjectApiResponse[t.Any]:
133
133
  """
134
- Returns the current status and available results for an async SQL search or stored
135
- synchronous SQL search
134
+ Get async SQL search results. Get the current status and available results for
135
+ an async SQL search or stored synchronous SQL search.
136
136
 
137
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/get-async-sql-search-api.html>`_
137
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-async-sql-search-api.html>`_
138
138
 
139
139
  :param id: Identifier for the search.
140
140
  :param delimiter: Separator for CSV results. The API only supports this parameter
@@ -189,10 +189,10 @@ class SqlClient(NamespacedClient):
189
189
  pretty: t.Optional[bool] = None,
190
190
  ) -> ObjectApiResponse[t.Any]:
191
191
  """
192
- Returns the current status of an async SQL search or a stored synchronous SQL
193
- search
192
+ Get the async SQL search status. Get the current status of an async SQL search
193
+ or a stored synchronous SQL search.
194
194
 
195
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/get-async-sql-search-status-api.html>`_
195
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-async-sql-search-status-api.html>`_
196
196
 
197
197
  :param id: Identifier for the search.
198
198
  """
@@ -273,9 +273,9 @@ class SqlClient(NamespacedClient):
273
273
  body: t.Optional[t.Dict[str, t.Any]] = None,
274
274
  ) -> ObjectApiResponse[t.Any]:
275
275
  """
276
- Executes a SQL request
276
+ Get SQL search results. Run an SQL request.
277
277
 
278
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/sql-search-api.html>`_
278
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/sql-search-api.html>`_
279
279
 
280
280
  :param catalog: Default catalog (cluster) for queries. If unspecified, the queries
281
281
  execute on the data in the local cluster only.
@@ -383,9 +383,10 @@ class SqlClient(NamespacedClient):
383
383
  body: t.Optional[t.Dict[str, t.Any]] = None,
384
384
  ) -> ObjectApiResponse[t.Any]:
385
385
  """
386
- Translates SQL into Elasticsearch queries
386
+ Translate SQL into Elasticsearch queries. Translate an SQL search into a search
387
+ API request containing Query DSL.
387
388
 
388
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/sql-translate-api.html>`_
389
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/sql-translate-api.html>`_
389
390
 
390
391
  :param query: SQL query to run.
391
392
  :param fetch_size: The maximum number of rows (or entries) to return in one response.
@@ -53,7 +53,7 @@ class SslClient(NamespacedClient):
53
53
  the API output includes all certificates in that store, even though some of the
54
54
  certificates might not be in active use within the cluster.
55
55
 
56
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/security-api-ssl.html>`_
56
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-ssl.html>`_
57
57
  """
58
58
  __path_parts: t.Dict[str, str] = {}
59
59
  __path = "/_ssl/certificates"
@@ -36,9 +36,9 @@ class SynonymsClient(NamespacedClient):
36
36
  pretty: t.Optional[bool] = None,
37
37
  ) -> ObjectApiResponse[t.Any]:
38
38
  """
39
- Deletes a synonym set
39
+ Delete a synonym set.
40
40
 
41
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/delete-synonyms-set.html>`_
41
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/delete-synonyms-set.html>`_
42
42
 
43
43
  :param id: The id of the synonyms set to be deleted
44
44
  """
@@ -77,9 +77,9 @@ class SynonymsClient(NamespacedClient):
77
77
  pretty: t.Optional[bool] = None,
78
78
  ) -> ObjectApiResponse[t.Any]:
79
79
  """
80
- Deletes a synonym rule in a synonym set
80
+ Delete a synonym rule. Delete a synonym rule from a synonym set.
81
81
 
82
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/delete-synonym-rule.html>`_
82
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/delete-synonym-rule.html>`_
83
83
 
84
84
  :param set_id: The id of the synonym set to be updated
85
85
  :param rule_id: The id of the synonym rule to be deleted
@@ -127,9 +127,9 @@ class SynonymsClient(NamespacedClient):
127
127
  size: t.Optional[int] = None,
128
128
  ) -> ObjectApiResponse[t.Any]:
129
129
  """
130
- Retrieves a synonym set
130
+ Get a synonym set.
131
131
 
132
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/get-synonyms-set.html>`_
132
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-synonyms-set.html>`_
133
133
 
134
134
  :param id: "The id of the synonyms set to be retrieved
135
135
  :param from_: Starting offset for query rules to be retrieved
@@ -174,9 +174,9 @@ class SynonymsClient(NamespacedClient):
174
174
  pretty: t.Optional[bool] = None,
175
175
  ) -> ObjectApiResponse[t.Any]:
176
176
  """
177
- Retrieves a synonym rule from a synonym set
177
+ Get a synonym rule. Get a synonym rule from a synonym set.
178
178
 
179
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/get-synonym-rule.html>`_
179
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-synonym-rule.html>`_
180
180
 
181
181
  :param set_id: The id of the synonym set to retrieve the synonym rule from
182
182
  :param rule_id: The id of the synonym rule to retrieve
@@ -223,9 +223,9 @@ class SynonymsClient(NamespacedClient):
223
223
  size: t.Optional[int] = None,
224
224
  ) -> ObjectApiResponse[t.Any]:
225
225
  """
226
- Retrieves a summary of all defined synonym sets
226
+ Get all synonym sets. Get a summary of all defined synonym sets.
227
227
 
228
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/list-synonyms-sets.html>`_
228
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/list-synonyms-sets.html>`_
229
229
 
230
230
  :param from_: Starting offset
231
231
  :param size: specifies a max number of results to get
@@ -272,9 +272,11 @@ class SynonymsClient(NamespacedClient):
272
272
  body: t.Optional[t.Dict[str, t.Any]] = None,
273
273
  ) -> ObjectApiResponse[t.Any]:
274
274
  """
275
- Creates or updates a synonym set.
275
+ Create or update a synonym set. Synonyms sets are limited to a maximum of 10,000
276
+ synonym rules per set. If you need to manage more synonym rules, you can create
277
+ multiple synonym sets.
276
278
 
277
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/put-synonyms-set.html>`_
279
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/put-synonyms-set.html>`_
278
280
 
279
281
  :param id: The id of the synonyms set to be created or updated
280
282
  :param synonyms_set: The synonym set information to update
@@ -325,9 +327,10 @@ class SynonymsClient(NamespacedClient):
325
327
  body: t.Optional[t.Dict[str, t.Any]] = None,
326
328
  ) -> ObjectApiResponse[t.Any]:
327
329
  """
328
- Creates or updates a synonym rule in a synonym set
330
+ Create or update a synonym rule. Create or update a synonym rule in a synonym
331
+ set.
329
332
 
330
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/put-synonym-rule.html>`_
333
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/put-synonym-rule.html>`_
331
334
 
332
335
  :param set_id: The id of the synonym set to be updated with the synonym rule
333
336
  :param rule_id: The id of the synonym rule to be updated or created
@@ -49,7 +49,7 @@ class TasksClient(NamespacedClient):
49
49
  """
50
50
  Cancels a task, if it can be cancelled through an API.
51
51
 
52
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/tasks.html>`_
52
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/tasks.html>`_
53
53
 
54
54
  :param task_id: ID of the task.
55
55
  :param actions: Comma-separated list or wildcard expression of actions used to
@@ -110,7 +110,7 @@ class TasksClient(NamespacedClient):
110
110
  Get task information. Returns information about the tasks currently executing
111
111
  in the cluster.
112
112
 
113
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/tasks.html>`_
113
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/tasks.html>`_
114
114
 
115
115
  :param task_id: ID of the task.
116
116
  :param timeout: Period to wait for a response. If no response is received before
@@ -169,7 +169,7 @@ class TasksClient(NamespacedClient):
169
169
  The task management API returns information about tasks currently executing on
170
170
  one or more nodes in the cluster.
171
171
 
172
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/tasks.html>`_
172
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/tasks.html>`_
173
173
 
174
174
  :param actions: Comma-separated list or wildcard expression of actions used to
175
175
  limit the request.
@@ -53,7 +53,7 @@ class TextStructureClient(NamespacedClient):
53
53
  Finds the structure of a text file. The text file must contain data that is suitable
54
54
  to be ingested into Elasticsearch.
55
55
 
56
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/find-structure.html>`_
56
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/find-structure.html>`_
57
57
 
58
58
  :param text_files:
59
59
  :param charset: The text’s character set. It must be a character set that is
@@ -193,7 +193,7 @@ class TextStructureClient(NamespacedClient):
193
193
  """
194
194
  Tests a Grok pattern on some text.
195
195
 
196
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/test-grok-pattern.html>`_
196
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/test-grok-pattern.html>`_
197
197
 
198
198
  :param grok_pattern: Grok pattern to run on the text.
199
199
  :param text: Lines of text to run the Grok pattern on.
@@ -41,7 +41,7 @@ class TransformClient(NamespacedClient):
41
41
  """
42
42
  Delete a transform. Deletes a transform.
43
43
 
44
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/delete-transform.html>`_
44
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/delete-transform.html>`_
45
45
 
46
46
  :param transform_id: Identifier for the transform.
47
47
  :param delete_dest_index: If this value is true, the destination index is deleted
@@ -101,7 +101,7 @@ class TransformClient(NamespacedClient):
101
101
  """
102
102
  Get transforms. Retrieves configuration information for transforms.
103
103
 
104
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/get-transform.html>`_
104
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-transform.html>`_
105
105
 
106
106
  :param transform_id: Identifier for the transform. It can be a transform identifier
107
107
  or a wildcard expression. You can get information for all transforms by using
@@ -170,7 +170,7 @@ class TransformClient(NamespacedClient):
170
170
  """
171
171
  Get transform stats. Retrieves usage information for transforms.
172
172
 
173
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/get-transform-stats.html>`_
173
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-transform-stats.html>`_
174
174
 
175
175
  :param transform_id: Identifier for the transform. It can be a transform identifier
176
176
  or a wildcard expression. You can get information for all transforms by using
@@ -256,7 +256,7 @@ class TransformClient(NamespacedClient):
256
256
  These values are determined based on the field types of the source index and
257
257
  the transform aggregations.
258
258
 
259
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/preview-transform.html>`_
259
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/preview-transform.html>`_
260
260
 
261
261
  :param transform_id: Identifier for the transform to preview. If you specify
262
262
  this path parameter, you cannot provide transform configuration details in
@@ -393,7 +393,7 @@ class TransformClient(NamespacedClient):
393
393
  If you used transforms prior to 7.5, also do not give users any privileges on
394
394
  `.data-frame-internal*` indices.
395
395
 
396
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/put-transform.html>`_
396
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/put-transform.html>`_
397
397
 
398
398
  :param transform_id: Identifier for the transform. This identifier can contain
399
399
  lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores.
@@ -495,7 +495,7 @@ class TransformClient(NamespacedClient):
495
495
  it; alternatively, use the `force` query parameter. If the destination index
496
496
  was created by the transform, it is deleted.
497
497
 
498
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/reset-transform.html>`_
498
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/reset-transform.html>`_
499
499
 
500
500
  :param transform_id: Identifier for the transform. This identifier can contain
501
501
  lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores.
@@ -547,7 +547,7 @@ class TransformClient(NamespacedClient):
547
547
  the transform will be processed again at now + frequency unless _schedule_now
548
548
  API is called again in the meantime.
549
549
 
550
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/schedule-now-transform.html>`_
550
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/schedule-now-transform.html>`_
551
551
 
552
552
  :param transform_id: Identifier for the transform.
553
553
  :param timeout: Controls the time to wait for the scheduling to take place
@@ -611,7 +611,7 @@ class TransformClient(NamespacedClient):
611
611
  privileges on the source and destination indices, the transform fails when it
612
612
  attempts unauthorized operations.
613
613
 
614
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/start-transform.html>`_
614
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/start-transform.html>`_
615
615
 
616
616
  :param transform_id: Identifier for the transform.
617
617
  :param from_: Restricts the set of transformed entities to those changed after
@@ -665,7 +665,7 @@ class TransformClient(NamespacedClient):
665
665
  """
666
666
  Stop transforms. Stops one or more transforms.
667
667
 
668
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/stop-transform.html>`_
668
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/stop-transform.html>`_
669
669
 
670
670
  :param transform_id: Identifier for the transform. To stop multiple transforms,
671
671
  use a comma-separated list or a wildcard expression. To stop all transforms,
@@ -765,7 +765,7 @@ class TransformClient(NamespacedClient):
765
765
  which roles the user who updated it had at the time of update and runs with those
766
766
  privileges.
767
767
 
768
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/update-transform.html>`_
768
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-transform.html>`_
769
769
 
770
770
  :param transform_id: Identifier for the transform.
771
771
  :param defer_validation: When true, deferrable validations are not run. This
@@ -852,7 +852,7 @@ class TransformClient(NamespacedClient):
852
852
  the role used to read source data and write to the destination index remains
853
853
  unchanged.
854
854
 
855
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/upgrade-transforms.html>`_
855
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/upgrade-transforms.html>`_
856
856
 
857
857
  :param dry_run: When true, the request checks for updates but does not run them.
858
858
  :param timeout: Period to wait for a response. If no response is received before
@@ -39,7 +39,7 @@ class WatcherClient(NamespacedClient):
39
39
  """
40
40
  Acknowledges a watch, manually throttling the execution of the watch's actions.
41
41
 
42
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/watcher-api-ack-watch.html>`_
42
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/watcher-api-ack-watch.html>`_
43
43
 
44
44
  :param watch_id: Watch ID
45
45
  :param action_id: A comma-separated list of the action ids to be acked
@@ -90,7 +90,7 @@ class WatcherClient(NamespacedClient):
90
90
  """
91
91
  Activates a currently inactive watch.
92
92
 
93
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/watcher-api-activate-watch.html>`_
93
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/watcher-api-activate-watch.html>`_
94
94
 
95
95
  :param watch_id: Watch ID
96
96
  """
@@ -130,7 +130,7 @@ class WatcherClient(NamespacedClient):
130
130
  """
131
131
  Deactivates a currently active watch.
132
132
 
133
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/watcher-api-deactivate-watch.html>`_
133
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/watcher-api-deactivate-watch.html>`_
134
134
 
135
135
  :param watch_id: Watch ID
136
136
  """
@@ -170,7 +170,7 @@ class WatcherClient(NamespacedClient):
170
170
  """
171
171
  Removes a watch from Watcher.
172
172
 
173
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/watcher-api-delete-watch.html>`_
173
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/watcher-api-delete-watch.html>`_
174
174
 
175
175
  :param id: Watch ID
176
176
  """
@@ -245,7 +245,7 @@ class WatcherClient(NamespacedClient):
245
245
  and control whether a watch record would be written to the watch history after
246
246
  execution.
247
247
 
248
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/watcher-api-execute-watch.html>`_
248
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/watcher-api-execute-watch.html>`_
249
249
 
250
250
  :param id: Identifier for the watch.
251
251
  :param action_modes: Determines how to handle the watch actions as part of the
@@ -328,7 +328,7 @@ class WatcherClient(NamespacedClient):
328
328
  """
329
329
  Retrieves a watch by its ID.
330
330
 
331
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/watcher-api-get-watch.html>`_
331
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/watcher-api-get-watch.html>`_
332
332
 
333
333
  :param id: Watch ID
334
334
  """
@@ -390,7 +390,7 @@ class WatcherClient(NamespacedClient):
390
390
  """
391
391
  Creates a new watch, or updates an existing one.
392
392
 
393
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/watcher-api-put-watch.html>`_
393
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/watcher-api-put-watch.html>`_
394
394
 
395
395
  :param id: Watch ID
396
396
  :param actions:
@@ -487,7 +487,7 @@ class WatcherClient(NamespacedClient):
487
487
  """
488
488
  Retrieves stored watches.
489
489
 
490
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/watcher-api-query-watches.html>`_
490
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/watcher-api-query-watches.html>`_
491
491
 
492
492
  :param from_: The offset from the first result to fetch. Needs to be non-negative.
493
493
  :param query: Optional, query filter watches to be returned.
@@ -557,7 +557,7 @@ class WatcherClient(NamespacedClient):
557
557
  """
558
558
  Starts Watcher if it is not already running.
559
559
 
560
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/watcher-api-start.html>`_
560
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/watcher-api-start.html>`_
561
561
  """
562
562
  __path_parts: t.Dict[str, str] = {}
563
563
  __path = "/_watcher/_start"
@@ -614,7 +614,7 @@ class WatcherClient(NamespacedClient):
614
614
  """
615
615
  Retrieves the current Watcher metrics.
616
616
 
617
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/watcher-api-stats.html>`_
617
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/watcher-api-stats.html>`_
618
618
 
619
619
  :param metric: Defines which additional metrics are included in the response.
620
620
  :param emit_stacktraces: Defines whether stack traces are generated for each
@@ -660,7 +660,7 @@ class WatcherClient(NamespacedClient):
660
660
  """
661
661
  Stops Watcher if it is running.
662
662
 
663
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/watcher-api-stop.html>`_
663
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/watcher-api-stop.html>`_
664
664
  """
665
665
  __path_parts: t.Dict[str, str] = {}
666
666
  __path = "/_watcher/_stop"
@@ -45,7 +45,7 @@ class XPackClient(NamespacedClient):
45
45
  """
46
46
  Provides general information about the installed X-Pack features.
47
47
 
48
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/info-api.html>`_
48
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/info-api.html>`_
49
49
 
50
50
  :param accept_enterprise: If this param is used it must be set to true
51
51
  :param categories: A comma-separated list of the information categories to include
@@ -90,7 +90,7 @@ class XPackClient(NamespacedClient):
90
90
  This API provides information about which features are currently enabled and
91
91
  available under the current license and some usage statistics.
92
92
 
93
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/usage-api.html>`_
93
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/usage-api.html>`_
94
94
 
95
95
  :param master_timeout: Period to wait for a connection to the master node. If
96
96
  no response is received before the timeout expires, the request fails and
elasticsearch/_version.py CHANGED
@@ -15,4 +15,4 @@
15
15
  # specific language governing permissions and limitations
16
16
  # under the License.
17
17
 
18
- __versionstr__ = "8.16.0"
18
+ __versionstr__ = "8.17.0"
@@ -1,6 +1,6 @@
1
- Metadata-Version: 2.3
1
+ Metadata-Version: 2.4
2
2
  Name: elasticsearch
3
- Version: 8.16.0
3
+ Version: 8.17.0
4
4
  Summary: Python client for Elasticsearch
5
5
  Project-URL: Documentation, https://elasticsearch-py.readthedocs.io/
6
6
  Project-URL: Homepage, https://github.com/elastic/elasticsearch-py
@@ -8,7 +8,9 @@ Project-URL: Issue Tracker, https://github.com/elastic/elasticsearch-py/issues
8
8
  Project-URL: Source Code, https://github.com/elastic/elasticsearch-py
9
9
  Author-email: Elastic Client Library Maintainers <client-libs@elastic.co>
10
10
  Maintainer-email: Elastic Client Library Maintainers <client-libs@elastic.co>
11
- License: Apache-2.0
11
+ License-Expression: Apache-2.0
12
+ License-File: LICENSE
13
+ License-File: NOTICE
12
14
  Keywords: REST,client,elastic,elasticsearch,index,kibana,mapping,search
13
15
  Classifier: Development Status :: 5 - Production/Stable
14
16
  Classifier: Intended Audience :: Developers
@@ -47,7 +49,7 @@ Requires-Dist: pytest-cov; extra == 'dev'
47
49
  Requires-Dist: python-dateutil; extra == 'dev'
48
50
  Requires-Dist: pyyaml>=5.4; extra == 'dev'
49
51
  Requires-Dist: requests<3,>=2; extra == 'dev'
50
- Requires-Dist: simsimd; (python_version < '3.13') and extra == 'dev'
52
+ Requires-Dist: simsimd; extra == 'dev'
51
53
  Requires-Dist: twine; extra == 'dev'
52
54
  Requires-Dist: unasync; extra == 'dev'
53
55
  Provides-Extra: docs