elasticsearch 9.2.0__py3-none-any.whl → 9.3.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 (125) hide show
  1. elasticsearch/_async/client/__init__.py +108 -85
  2. elasticsearch/_async/client/async_search.py +7 -6
  3. elasticsearch/_async/client/autoscaling.py +15 -4
  4. elasticsearch/_async/client/cat.py +203 -10
  5. elasticsearch/_async/client/ccr.py +10 -10
  6. elasticsearch/_async/client/cluster.py +98 -66
  7. elasticsearch/_async/client/connector.py +42 -41
  8. elasticsearch/_async/client/dangling_indices.py +8 -12
  9. elasticsearch/_async/client/enrich.py +10 -10
  10. elasticsearch/_async/client/eql.py +17 -16
  11. elasticsearch/_async/client/esql.py +173 -24
  12. elasticsearch/_async/client/features.py +6 -6
  13. elasticsearch/_async/client/fleet.py +8 -8
  14. elasticsearch/_async/client/graph.py +3 -3
  15. elasticsearch/_async/client/ilm.py +18 -18
  16. elasticsearch/_async/client/indices.py +564 -149
  17. elasticsearch/_async/client/inference.py +374 -64
  18. elasticsearch/_async/client/ingest.py +9 -9
  19. elasticsearch/_async/client/license.py +5 -7
  20. elasticsearch/_async/client/logstash.py +4 -4
  21. elasticsearch/_async/client/migration.py +6 -6
  22. elasticsearch/_async/client/ml.py +132 -88
  23. elasticsearch/_async/client/monitoring.py +4 -3
  24. elasticsearch/_async/client/nodes.py +182 -20
  25. elasticsearch/_async/client/project.py +13 -4
  26. elasticsearch/_async/client/query_rules.py +16 -16
  27. elasticsearch/_async/client/rollup.py +21 -21
  28. elasticsearch/_async/client/search_application.py +19 -19
  29. elasticsearch/_async/client/searchable_snapshots.py +10 -10
  30. elasticsearch/_async/client/security.py +34 -10
  31. elasticsearch/_async/client/shutdown.py +15 -4
  32. elasticsearch/_async/client/simulate.py +4 -4
  33. elasticsearch/_async/client/slm.py +17 -17
  34. elasticsearch/_async/client/snapshot.py +21 -21
  35. elasticsearch/_async/client/sql.py +17 -16
  36. elasticsearch/_async/client/streams.py +6 -7
  37. elasticsearch/_async/client/synonyms.py +10 -10
  38. elasticsearch/_async/client/tasks.py +8 -8
  39. elasticsearch/_async/client/text_structure.py +16 -12
  40. elasticsearch/_async/client/transform.py +51 -12
  41. elasticsearch/_async/client/utils.py +4 -2
  42. elasticsearch/_async/client/watcher.py +26 -26
  43. elasticsearch/_async/client/xpack.py +6 -5
  44. elasticsearch/_sync/client/__init__.py +110 -85
  45. elasticsearch/_sync/client/async_search.py +7 -6
  46. elasticsearch/_sync/client/autoscaling.py +15 -4
  47. elasticsearch/_sync/client/cat.py +203 -10
  48. elasticsearch/_sync/client/ccr.py +10 -10
  49. elasticsearch/_sync/client/cluster.py +98 -66
  50. elasticsearch/_sync/client/connector.py +42 -41
  51. elasticsearch/_sync/client/dangling_indices.py +8 -12
  52. elasticsearch/_sync/client/enrich.py +10 -10
  53. elasticsearch/_sync/client/eql.py +17 -16
  54. elasticsearch/_sync/client/esql.py +173 -24
  55. elasticsearch/_sync/client/features.py +6 -6
  56. elasticsearch/_sync/client/fleet.py +8 -8
  57. elasticsearch/_sync/client/graph.py +3 -3
  58. elasticsearch/_sync/client/ilm.py +18 -18
  59. elasticsearch/_sync/client/indices.py +564 -149
  60. elasticsearch/_sync/client/inference.py +374 -64
  61. elasticsearch/_sync/client/ingest.py +9 -9
  62. elasticsearch/_sync/client/license.py +5 -7
  63. elasticsearch/_sync/client/logstash.py +4 -4
  64. elasticsearch/_sync/client/migration.py +6 -6
  65. elasticsearch/_sync/client/ml.py +132 -88
  66. elasticsearch/_sync/client/monitoring.py +4 -3
  67. elasticsearch/_sync/client/nodes.py +182 -20
  68. elasticsearch/_sync/client/project.py +13 -4
  69. elasticsearch/_sync/client/project_routing.py +264 -0
  70. elasticsearch/_sync/client/query_rules.py +16 -16
  71. elasticsearch/_sync/client/rollup.py +21 -21
  72. elasticsearch/_sync/client/search_application.py +19 -19
  73. elasticsearch/_sync/client/searchable_snapshots.py +10 -10
  74. elasticsearch/_sync/client/security.py +34 -10
  75. elasticsearch/_sync/client/shutdown.py +15 -4
  76. elasticsearch/_sync/client/simulate.py +4 -4
  77. elasticsearch/_sync/client/slm.py +17 -17
  78. elasticsearch/_sync/client/snapshot.py +21 -21
  79. elasticsearch/_sync/client/sql.py +17 -16
  80. elasticsearch/_sync/client/streams.py +6 -7
  81. elasticsearch/_sync/client/synonyms.py +10 -10
  82. elasticsearch/_sync/client/tasks.py +8 -8
  83. elasticsearch/_sync/client/text_structure.py +16 -12
  84. elasticsearch/_sync/client/transform.py +51 -12
  85. elasticsearch/_sync/client/utils.py +16 -2
  86. elasticsearch/_sync/client/watcher.py +26 -26
  87. elasticsearch/_sync/client/xpack.py +6 -5
  88. elasticsearch/_version.py +2 -2
  89. elasticsearch/dsl/__init__.py +4 -0
  90. elasticsearch/dsl/_async/document.py +4 -5
  91. elasticsearch/dsl/_async/index.py +1 -1
  92. elasticsearch/dsl/_async/search.py +2 -3
  93. elasticsearch/dsl/_sync/document.py +4 -5
  94. elasticsearch/dsl/_sync/index.py +1 -1
  95. elasticsearch/dsl/_sync/search.py +2 -3
  96. elasticsearch/dsl/aggs.py +9 -9
  97. elasticsearch/dsl/async_connections.py +1 -2
  98. elasticsearch/dsl/connections.py +1 -2
  99. elasticsearch/dsl/document_base.py +1 -1
  100. elasticsearch/dsl/field.py +90 -6
  101. elasticsearch/dsl/pydantic.py +1 -1
  102. elasticsearch/dsl/query.py +25 -2
  103. elasticsearch/dsl/response/__init__.py +2 -0
  104. elasticsearch/dsl/serializer.py +1 -2
  105. elasticsearch/dsl/types.py +63 -8
  106. elasticsearch/dsl/utils.py +12 -4
  107. elasticsearch/esql/esql.py +1 -1
  108. elasticsearch/esql/functions.py +926 -252
  109. elasticsearch/helpers/__init__.py +2 -0
  110. elasticsearch/helpers/actions.py +21 -0
  111. elasticsearch/helpers/vectorstore/__init__.py +7 -7
  112. elasticsearch/helpers/vectorstore/_async/_utils.py +1 -1
  113. elasticsearch/helpers/vectorstore/_async/embedding_service.py +2 -2
  114. elasticsearch/helpers/vectorstore/_async/strategies.py +3 -3
  115. elasticsearch/helpers/vectorstore/_async/vectorstore.py +8 -5
  116. elasticsearch/helpers/vectorstore/_sync/_utils.py +1 -1
  117. elasticsearch/helpers/vectorstore/_sync/embedding_service.py +2 -2
  118. elasticsearch/helpers/vectorstore/_sync/strategies.py +3 -3
  119. elasticsearch/helpers/vectorstore/_sync/vectorstore.py +8 -5
  120. {elasticsearch-9.2.0.dist-info → elasticsearch-9.3.0.dist-info}/METADATA +2 -1
  121. elasticsearch-9.3.0.dist-info/RECORD +169 -0
  122. {elasticsearch-9.2.0.dist-info → elasticsearch-9.3.0.dist-info}/WHEEL +1 -1
  123. elasticsearch-9.2.0.dist-info/RECORD +0 -168
  124. {elasticsearch-9.2.0.dist-info → elasticsearch-9.3.0.dist-info}/licenses/LICENSE +0 -0
  125. {elasticsearch-9.2.0.dist-info → elasticsearch-9.3.0.dist-info}/licenses/NOTICE +0 -0
@@ -47,8 +47,8 @@ class ClusterClient(NamespacedClient):
47
47
  """
48
48
  .. raw:: html
49
49
 
50
- <p>Explain the shard allocations.
51
- Get explanations for shard allocations in the cluster.
50
+ <p>Explain the shard allocations.</p>
51
+ <p>Get explanations for shard allocations in the cluster.
52
52
  This API accepts the current_node, index, primary and shard parameters in the request body or in query parameters, but not in both at the same time.
53
53
  For unassigned shards, it provides an explanation for why the shard is unassigned.
54
54
  For assigned shards, it provides an explanation for why the shard is remaining on its current node and has not moved or rebalanced to another node.
@@ -127,8 +127,8 @@ class ClusterClient(NamespacedClient):
127
127
  """
128
128
  .. raw:: html
129
129
 
130
- <p>Delete component templates.
131
- Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.</p>
130
+ <p>Delete component templates.</p>
131
+ <p>Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.</p>
132
132
 
133
133
 
134
134
  `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-component-template>`_
@@ -182,8 +182,8 @@ class ClusterClient(NamespacedClient):
182
182
  """
183
183
  .. raw:: html
184
184
 
185
- <p>Clear cluster voting config exclusions.
186
- Remove master-eligible nodes from the voting configuration exclusion list.</p>
185
+ <p>Clear cluster voting config exclusions.</p>
186
+ <p>Remove master-eligible nodes from the voting configuration exclusion list.</p>
187
187
 
188
188
 
189
189
  `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-post-voting-config-exclusions>`_
@@ -236,8 +236,8 @@ class ClusterClient(NamespacedClient):
236
236
  """
237
237
  .. raw:: html
238
238
 
239
- <p>Check component templates.
240
- Returns information about whether a particular component template exists.</p>
239
+ <p>Check component templates.</p>
240
+ <p>Returns information about whether a particular component template exists.</p>
241
241
 
242
242
 
243
243
  `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-component-template>`_
@@ -296,17 +296,17 @@ class ClusterClient(NamespacedClient):
296
296
  """
297
297
  .. raw:: html
298
298
 
299
- <p>Get component templates.
300
- Get information about component templates.</p>
299
+ <p>Get component templates.</p>
300
+ <p>Get information about component templates.</p>
301
301
 
302
302
 
303
303
  `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-component-template>`_
304
304
 
305
- :param name: Comma-separated list of component template names used to limit the
306
- request. Wildcard (`*`) expressions are supported.
305
+ :param name: Name of component template to retrieve. Wildcard (`*`) expressions
306
+ are supported.
307
307
  :param flat_settings: If `true`, returns settings in flat format.
308
308
  :param include_defaults: Return all default configurations for the component
309
- template (default: false)
309
+ template
310
310
  :param local: If `true`, the request retrieves information from the local node
311
311
  only. If `false`, information is retrieved from the master node.
312
312
  :param master_timeout: Period to wait for a connection to the master node. If
@@ -470,39 +470,38 @@ class ClusterClient(NamespacedClient):
470
470
 
471
471
  `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-health>`_
472
472
 
473
- :param index: Comma-separated list of data streams, indices, and index aliases
474
- used to limit the request. Wildcard expressions (`*`) are supported. To target
473
+ :param index: A comma-separated list of data streams, indices, and index aliases
474
+ that limit the request. Wildcard expressions (`*`) are supported. To target
475
475
  all data streams and indices in a cluster, omit this parameter or use _all
476
476
  or `*`.
477
- :param expand_wildcards: Whether to expand wildcard expression to concrete indices
478
- that are open, closed or both.
479
- :param level: Can be one of cluster, indices or shards. Controls the details
480
- level of the health information returned.
481
- :param local: If true, the request retrieves information from the local node
482
- only. Defaults to false, which means information is retrieved from the master
483
- node.
484
- :param master_timeout: Period to wait for a connection to the master node. If
485
- no response is received before the timeout expires, the request fails and
486
- returns an error.
487
- :param timeout: Period to wait for a response. If no response is received before
488
- the timeout expires, the request fails and returns an error.
489
- :param wait_for_active_shards: A number controlling to how many active shards
490
- to wait for, all to wait for all shards in the cluster to be active, or 0
491
- to not wait.
492
- :param wait_for_events: Can be one of immediate, urgent, high, normal, low, languid.
493
- Wait until all currently queued events with the given priority are processed.
494
- :param wait_for_no_initializing_shards: A boolean value which controls whether
495
- to wait (until the timeout provided) for the cluster to have no shard initializations.
496
- Defaults to false, which means it will not wait for initializing shards.
497
- :param wait_for_no_relocating_shards: A boolean value which controls whether
498
- to wait (until the timeout provided) for the cluster to have no shard relocations.
499
- Defaults to false, which means it will not wait for relocating shards.
500
- :param wait_for_nodes: The request waits until the specified number N of nodes
501
- is available. It also accepts >=N, <=N, >N and <N. Alternatively, it is possible
502
- to use ge(N), le(N), gt(N) and lt(N) notation.
503
- :param wait_for_status: One of green, yellow or red. Will wait (until the timeout
504
- provided) until the status of the cluster changes to the one provided or
505
- better, i.e. green > yellow > red. By default, will not wait for any status.
477
+ :param expand_wildcards: Expand wildcard expression to concrete indices that
478
+ are open, closed or both.
479
+ :param level: Return health information at a specific level of detail.
480
+ :param local: If true, retrieve information from the local node only. If false,
481
+ retrieve information from the master node.
482
+ :param master_timeout: The period to wait for a connection to the master node.
483
+ If no response is received before the timeout expires, the request fails
484
+ and returns an error.
485
+ :param timeout: The period to wait for a response. If no response is received
486
+ before the timeout expires, the request fails and returns an error.
487
+ :param wait_for_active_shards: Wait for the specified number of active shards.
488
+ Use `all` to wait for all shards in the cluster to be active. Use `0` to
489
+ not wait.
490
+ :param wait_for_events: Wait until all currently queued events with the given
491
+ priority are processed.
492
+ :param wait_for_no_initializing_shards: Wait (until the timeout expires) for
493
+ the cluster to have no shard initializations. If false, the request does
494
+ not wait for initializing shards.
495
+ :param wait_for_no_relocating_shards: Wait (until the timeout expires) for the
496
+ cluster to have no shard relocations. If false, the request not wait for
497
+ relocating shards.
498
+ :param wait_for_nodes: Wait until the specified number (N) of nodes is available.
499
+ It also accepts `>=N`, `<=N`, `>N` and `<N`. Alternatively, use the notations
500
+ `ge(N)`, `le(N)`, `gt(N)`, and `lt(N)`.
501
+ :param wait_for_status: Wait (until the timeout expires) for the cluster to reach
502
+ a specific health status (or a better status). A green status is better than
503
+ yellow and yellow is better than red. By default, the request does not wait
504
+ for a particular status.
506
505
  """
507
506
  __path_parts: t.Dict[str, str]
508
507
  if index not in SKIP_IN_PATH:
@@ -572,8 +571,8 @@ class ClusterClient(NamespacedClient):
572
571
  """
573
572
  .. raw:: html
574
573
 
575
- <p>Get cluster info.
576
- Returns basic information about the cluster.</p>
574
+ <p>Get cluster info.</p>
575
+ <p>Returns basic information about the cluster.</p>
577
576
 
578
577
 
579
578
  `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-info>`_
@@ -618,8 +617,8 @@ class ClusterClient(NamespacedClient):
618
617
  """
619
618
  .. raw:: html
620
619
 
621
- <p>Get the pending cluster tasks.
622
- Get information about cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet taken effect.</p>
620
+ <p>Get the pending cluster tasks.</p>
621
+ <p>Get information about cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet taken effect.</p>
623
622
  <p>NOTE: This API returns a list of any pending updates to the cluster state.
624
623
  These are distinct from the tasks reported by the task management API which include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests.
625
624
  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>
@@ -674,8 +673,8 @@ class ClusterClient(NamespacedClient):
674
673
  """
675
674
  .. raw:: html
676
675
 
677
- <p>Update voting configuration exclusions.
678
- Update the cluster voting config exclusions by node IDs or node names.
676
+ <p>Update voting configuration exclusions.</p>
677
+ <p>Update the cluster voting config exclusions by node IDs or node names.
679
678
  By default, if there are more than three master-eligible nodes in the cluster and you remove fewer than half of the master-eligible nodes in the cluster at once, the voting configuration automatically shrinks.
680
679
  If you want to shrink the voting configuration to contain fewer than three nodes or to remove half or more of the master-eligible nodes in the cluster at once, use this API to remove departing nodes from the voting configuration manually.
681
680
  The API adds an entry for each specified node to the cluster’s voting configuration exclusions list.
@@ -757,8 +756,8 @@ class ClusterClient(NamespacedClient):
757
756
  """
758
757
  .. raw:: html
759
758
 
760
- <p>Create or update a component template.
761
- Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.</p>
759
+ <p>Create or update a component template.</p>
760
+ <p>Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.</p>
762
761
  <p>An index template can be composed of multiple component templates.
763
762
  To use a component template, specify it in an index template’s <code>composed_of</code> list.
764
763
  Component templates are only applied to new data streams and indices as part of a matching index template.</p>
@@ -883,10 +882,10 @@ class ClusterClient(NamespacedClient):
883
882
 
884
883
  `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-settings>`_
885
884
 
886
- :param flat_settings: Return settings in flat format (default: false)
887
- :param master_timeout: Explicit operation timeout for connection to master node
885
+ :param flat_settings: Return settings in flat format
886
+ :param master_timeout: The period to wait for a connection to the master node.
888
887
  :param persistent: The settings that persist after the cluster restarts.
889
- :param timeout: Explicit operation timeout
888
+ :param timeout: The period to wait for a response.
890
889
  :param transient: The settings that do not persist after the cluster restarts.
891
890
  """
892
891
  __path_parts: t.Dict[str, str] = {}
@@ -992,8 +991,8 @@ class ClusterClient(NamespacedClient):
992
991
  """
993
992
  .. raw:: html
994
993
 
995
- <p>Reroute the cluster.
996
- Manually change the allocation of individual shards in the cluster.
994
+ <p>Reroute the cluster.</p>
995
+ <p>Manually change the allocation of individual shards in the cluster.
997
996
  For example, a shard can be moved from one node to another explicitly, an allocation can be canceled, and an unassigned shard can be explicitly allocated to a specific node.</p>
998
997
  <p>It is important to note that after processing any reroute commands Elasticsearch will perform rebalancing as normal (respecting the values of settings such as <code>cluster.routing.rebalance.enable</code>) in order to remain in a balanced state.
999
998
  For example, if the requested allocation includes moving a shard from node1 to node2 then this may cause a shard to be moved from node2 back to node1 to even things out.</p>
@@ -1068,7 +1067,40 @@ class ClusterClient(NamespacedClient):
1068
1067
  def state(
1069
1068
  self,
1070
1069
  *,
1071
- metric: t.Optional[t.Union[str, t.Sequence[str]]] = None,
1070
+ metric: t.Optional[
1071
+ t.Union[
1072
+ t.Sequence[
1073
+ t.Union[
1074
+ str,
1075
+ t.Literal[
1076
+ "_all",
1077
+ "blocks",
1078
+ "customs",
1079
+ "master_node",
1080
+ "metadata",
1081
+ "nodes",
1082
+ "routing_nodes",
1083
+ "routing_table",
1084
+ "version",
1085
+ ],
1086
+ ]
1087
+ ],
1088
+ t.Union[
1089
+ str,
1090
+ t.Literal[
1091
+ "_all",
1092
+ "blocks",
1093
+ "customs",
1094
+ "master_node",
1095
+ "metadata",
1096
+ "nodes",
1097
+ "routing_nodes",
1098
+ "routing_table",
1099
+ "version",
1100
+ ],
1101
+ ],
1102
+ ]
1103
+ ] = None,
1072
1104
  index: t.Optional[t.Union[str, t.Sequence[str]]] = None,
1073
1105
  allow_no_indices: t.Optional[bool] = None,
1074
1106
  error_trace: t.Optional[bool] = None,
@@ -1093,8 +1125,8 @@ class ClusterClient(NamespacedClient):
1093
1125
  """
1094
1126
  .. raw:: html
1095
1127
 
1096
- <p>Get the cluster state.
1097
- Get comprehensive information about the state of the cluster.</p>
1128
+ <p>Get the cluster state.</p>
1129
+ <p>Get comprehensive information about the state of the cluster.</p>
1098
1130
  <p>The cluster state is an internal data structure which keeps track of a variety of information needed by every node, including the identity and attributes of the other nodes in the cluster; cluster-wide settings; index metadata, including the mapping and settings for each index; the location and status of every shard copy in the cluster.</p>
1099
1131
  <p>The elected master node ensures that every node in the cluster has a copy of the same cluster state.
1100
1132
  This API lets you retrieve a representation of this internal state for debugging or diagnostic purposes.
@@ -1111,19 +1143,19 @@ class ClusterClient(NamespacedClient):
1111
1143
 
1112
1144
  `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-state>`_
1113
1145
 
1114
- :param metric: Limit the information returned to the specified metrics
1146
+ :param metric: Limit the information returned to the specified metrics.
1115
1147
  :param index: A comma-separated list of index names; use `_all` or empty string
1116
1148
  to perform the operation on all indices
1117
1149
  :param allow_no_indices: Whether to ignore if a wildcard indices expression resolves
1118
1150
  into no concrete indices. (This includes `_all` string or when no indices
1119
1151
  have been specified)
1120
1152
  :param expand_wildcards: Whether to expand wildcard expression to concrete indices
1121
- that are open, closed or both.
1122
- :param flat_settings: Return settings in flat format (default: false)
1153
+ that are open, closed or both
1154
+ :param flat_settings: Return settings in flat format
1123
1155
  :param ignore_unavailable: Whether specified concrete indices should be ignored
1124
1156
  when unavailable (missing or closed)
1125
1157
  :param local: Return local information, do not retrieve the state from master
1126
- node (default: false)
1158
+ node
1127
1159
  :param master_timeout: Timeout for waiting for new cluster state in case it is
1128
1160
  blocked
1129
1161
  :param wait_for_metadata_version: Wait for the metadata version to be equal or
@@ -1194,8 +1226,8 @@ class ClusterClient(NamespacedClient):
1194
1226
  """
1195
1227
  .. raw:: html
1196
1228
 
1197
- <p>Get cluster statistics.
1198
- 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>
1229
+ <p>Get cluster statistics.</p>
1230
+ <p>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>
1199
1231
 
1200
1232
 
1201
1233
  `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-stats>`_
@@ -23,16 +23,17 @@ from ._base import NamespacedClient
23
23
  from .utils import (
24
24
  SKIP_IN_PATH,
25
25
  Stability,
26
+ Visibility,
27
+ _availability_warning,
26
28
  _quote,
27
29
  _rewrite_parameters,
28
- _stability_warning,
29
30
  )
30
31
 
31
32
 
32
33
  class ConnectorClient(NamespacedClient):
33
34
 
34
35
  @_rewrite_parameters()
35
- @_stability_warning(Stability.EXPERIMENTAL)
36
+ @_availability_warning(Stability.EXPERIMENTAL)
36
37
  def check_in(
37
38
  self,
38
39
  *,
@@ -77,7 +78,7 @@ class ConnectorClient(NamespacedClient):
77
78
  )
78
79
 
79
80
  @_rewrite_parameters()
80
- @_stability_warning(Stability.BETA)
81
+ @_availability_warning(Stability.BETA)
81
82
  def delete(
82
83
  self,
83
84
  *,
@@ -134,7 +135,7 @@ class ConnectorClient(NamespacedClient):
134
135
  )
135
136
 
136
137
  @_rewrite_parameters()
137
- @_stability_warning(Stability.BETA)
138
+ @_availability_warning(Stability.BETA)
138
139
  def get(
139
140
  self,
140
141
  *,
@@ -199,7 +200,7 @@ class ConnectorClient(NamespacedClient):
199
200
  "sync_cursor",
200
201
  ),
201
202
  )
202
- @_stability_warning(Stability.EXPERIMENTAL)
203
+ @_availability_warning(Stability.EXPERIMENTAL, Visibility.PRIVATE)
203
204
  def last_sync(
204
205
  self,
205
206
  *,
@@ -333,7 +334,7 @@ class ConnectorClient(NamespacedClient):
333
334
  @_rewrite_parameters(
334
335
  parameter_aliases={"from": "from_"},
335
336
  )
336
- @_stability_warning(Stability.BETA)
337
+ @_availability_warning(Stability.BETA)
337
338
  def list(
338
339
  self,
339
340
  *,
@@ -416,7 +417,7 @@ class ConnectorClient(NamespacedClient):
416
417
  "service_type",
417
418
  ),
418
419
  )
419
- @_stability_warning(Stability.BETA)
420
+ @_availability_warning(Stability.BETA)
420
421
  def post(
421
422
  self,
422
423
  *,
@@ -500,7 +501,7 @@ class ConnectorClient(NamespacedClient):
500
501
  "service_type",
501
502
  ),
502
503
  )
503
- @_stability_warning(Stability.BETA)
504
+ @_availability_warning(Stability.BETA)
504
505
  def put(
505
506
  self,
506
507
  *,
@@ -580,7 +581,7 @@ class ConnectorClient(NamespacedClient):
580
581
  )
581
582
 
582
583
  @_rewrite_parameters()
583
- @_stability_warning(Stability.BETA)
584
+ @_availability_warning(Stability.BETA)
584
585
  def sync_job_cancel(
585
586
  self,
586
587
  *,
@@ -630,7 +631,7 @@ class ConnectorClient(NamespacedClient):
630
631
  )
631
632
 
632
633
  @_rewrite_parameters()
633
- @_stability_warning(Stability.EXPERIMENTAL)
634
+ @_availability_warning(Stability.EXPERIMENTAL)
634
635
  def sync_job_check_in(
635
636
  self,
636
637
  *,
@@ -643,8 +644,8 @@ class ConnectorClient(NamespacedClient):
643
644
  """
644
645
  .. raw:: html
645
646
 
646
- <p>Check in a connector sync job.
647
- Check in a connector sync job and set the <code>last_seen</code> field to the current time before updating it in the internal index.</p>
647
+ <p>Check in a connector sync job.</p>
648
+ <p>Check in a connector sync job and set the <code>last_seen</code> field to the current time before updating it in the internal index.</p>
648
649
  <p>To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure.
649
650
  This service runs automatically on Elastic Cloud for Elastic managed connectors.</p>
650
651
 
@@ -684,7 +685,7 @@ class ConnectorClient(NamespacedClient):
684
685
  @_rewrite_parameters(
685
686
  body_fields=("worker_hostname", "sync_cursor"),
686
687
  )
687
- @_stability_warning(Stability.EXPERIMENTAL)
688
+ @_availability_warning(Stability.EXPERIMENTAL)
688
689
  def sync_job_claim(
689
690
  self,
690
691
  *,
@@ -700,8 +701,8 @@ class ConnectorClient(NamespacedClient):
700
701
  """
701
702
  .. raw:: html
702
703
 
703
- <p>Claim a connector sync job.
704
- This action updates the job status to <code>in_progress</code> and sets the <code>last_seen</code> and <code>started_at</code> timestamps to the current time.
704
+ <p>Claim a connector sync job.</p>
705
+ <p>This action updates the job status to <code>in_progress</code> and sets the <code>last_seen</code> and <code>started_at</code> timestamps to the current time.
705
706
  Additionally, it can set the <code>sync_cursor</code> property for the sync job.</p>
706
707
  <p>This API is not intended for direct connector management by users.
707
708
  It supports the implementation of services that utilize the connector protocol to communicate with Elasticsearch.</p>
@@ -753,7 +754,7 @@ class ConnectorClient(NamespacedClient):
753
754
  )
754
755
 
755
756
  @_rewrite_parameters()
756
- @_stability_warning(Stability.BETA)
757
+ @_availability_warning(Stability.BETA)
757
758
  def sync_job_delete(
758
759
  self,
759
760
  *,
@@ -804,7 +805,7 @@ class ConnectorClient(NamespacedClient):
804
805
  @_rewrite_parameters(
805
806
  body_fields=("error",),
806
807
  )
807
- @_stability_warning(Stability.EXPERIMENTAL)
808
+ @_availability_warning(Stability.EXPERIMENTAL)
808
809
  def sync_job_error(
809
810
  self,
810
811
  *,
@@ -819,8 +820,8 @@ class ConnectorClient(NamespacedClient):
819
820
  """
820
821
  .. raw:: html
821
822
 
822
- <p>Set a connector sync job error.
823
- Set the <code>error</code> field for a connector sync job and set its <code>status</code> to <code>error</code>.</p>
823
+ <p>Set a connector sync job error.</p>
824
+ <p>Set the <code>error</code> field for a connector sync job and set its <code>status</code> to <code>error</code>.</p>
824
825
  <p>To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure.
825
826
  This service runs automatically on Elastic Cloud for Elastic managed connectors.</p>
826
827
 
@@ -863,7 +864,7 @@ class ConnectorClient(NamespacedClient):
863
864
  )
864
865
 
865
866
  @_rewrite_parameters()
866
- @_stability_warning(Stability.BETA)
867
+ @_availability_warning(Stability.BETA)
867
868
  def sync_job_get(
868
869
  self,
869
870
  *,
@@ -911,7 +912,7 @@ class ConnectorClient(NamespacedClient):
911
912
  @_rewrite_parameters(
912
913
  parameter_aliases={"from": "from_"},
913
914
  )
914
- @_stability_warning(Stability.BETA)
915
+ @_availability_warning(Stability.BETA)
915
916
  def sync_job_list(
916
917
  self,
917
918
  *,
@@ -994,7 +995,7 @@ class ConnectorClient(NamespacedClient):
994
995
  @_rewrite_parameters(
995
996
  body_fields=("id", "job_type", "trigger_method"),
996
997
  )
997
- @_stability_warning(Stability.BETA)
998
+ @_availability_warning(Stability.BETA)
998
999
  def sync_job_post(
999
1000
  self,
1000
1001
  *,
@@ -1066,7 +1067,7 @@ class ConnectorClient(NamespacedClient):
1066
1067
  "total_document_count",
1067
1068
  ),
1068
1069
  )
1069
- @_stability_warning(Stability.EXPERIMENTAL)
1070
+ @_availability_warning(Stability.EXPERIMENTAL)
1070
1071
  def sync_job_update_stats(
1071
1072
  self,
1072
1073
  *,
@@ -1086,8 +1087,8 @@ class ConnectorClient(NamespacedClient):
1086
1087
  """
1087
1088
  .. raw:: html
1088
1089
 
1089
- <p>Set the connector sync job stats.
1090
- Stats include: <code>deleted_document_count</code>, <code>indexed_document_count</code>, <code>indexed_document_volume</code>, and <code>total_document_count</code>.
1090
+ <p>Set the connector sync job stats.</p>
1091
+ <p>Stats include: <code>deleted_document_count</code>, <code>indexed_document_count</code>, <code>indexed_document_volume</code>, and <code>total_document_count</code>.
1091
1092
  You can also update <code>last_seen</code>.
1092
1093
  This API is mainly used by the connector service for updating sync job information.</p>
1093
1094
  <p>To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure.
@@ -1160,7 +1161,7 @@ class ConnectorClient(NamespacedClient):
1160
1161
  )
1161
1162
 
1162
1163
  @_rewrite_parameters()
1163
- @_stability_warning(Stability.EXPERIMENTAL)
1164
+ @_availability_warning(Stability.EXPERIMENTAL)
1164
1165
  def update_active_filtering(
1165
1166
  self,
1166
1167
  *,
@@ -1207,7 +1208,7 @@ class ConnectorClient(NamespacedClient):
1207
1208
  @_rewrite_parameters(
1208
1209
  body_fields=("api_key_id", "api_key_secret_id"),
1209
1210
  )
1210
- @_stability_warning(Stability.BETA)
1211
+ @_availability_warning(Stability.BETA)
1211
1212
  def update_api_key_id(
1212
1213
  self,
1213
1214
  *,
@@ -1269,7 +1270,7 @@ class ConnectorClient(NamespacedClient):
1269
1270
  @_rewrite_parameters(
1270
1271
  body_fields=("configuration", "values"),
1271
1272
  )
1272
- @_stability_warning(Stability.BETA)
1273
+ @_availability_warning(Stability.BETA)
1273
1274
  def update_configuration(
1274
1275
  self,
1275
1276
  *,
@@ -1328,7 +1329,7 @@ class ConnectorClient(NamespacedClient):
1328
1329
  @_rewrite_parameters(
1329
1330
  body_fields=("error",),
1330
1331
  )
1331
- @_stability_warning(Stability.EXPERIMENTAL)
1332
+ @_availability_warning(Stability.EXPERIMENTAL)
1332
1333
  def update_error(
1333
1334
  self,
1334
1335
  *,
@@ -1387,7 +1388,7 @@ class ConnectorClient(NamespacedClient):
1387
1388
  @_rewrite_parameters(
1388
1389
  body_fields=("features",),
1389
1390
  )
1390
- @_stability_warning(Stability.EXPERIMENTAL)
1391
+ @_availability_warning(Stability.EXPERIMENTAL)
1391
1392
  def update_features(
1392
1393
  self,
1393
1394
  *,
@@ -1402,8 +1403,8 @@ class ConnectorClient(NamespacedClient):
1402
1403
  """
1403
1404
  .. raw:: html
1404
1405
 
1405
- <p>Update the connector features.
1406
- Update the connector features in the connector document.
1406
+ <p>Update the connector features.</p>
1407
+ <p>Update the connector features in the connector document.
1407
1408
  This API can be used to control the following aspects of a connector:</p>
1408
1409
  <ul>
1409
1410
  <li>document-level security</li>
@@ -1455,7 +1456,7 @@ class ConnectorClient(NamespacedClient):
1455
1456
  @_rewrite_parameters(
1456
1457
  body_fields=("advanced_snippet", "filtering", "rules"),
1457
1458
  )
1458
- @_stability_warning(Stability.BETA)
1459
+ @_availability_warning(Stability.BETA)
1459
1460
  def update_filtering(
1460
1461
  self,
1461
1462
  *,
@@ -1520,7 +1521,7 @@ class ConnectorClient(NamespacedClient):
1520
1521
  @_rewrite_parameters(
1521
1522
  body_fields=("validation",),
1522
1523
  )
1523
- @_stability_warning(Stability.EXPERIMENTAL)
1524
+ @_availability_warning(Stability.EXPERIMENTAL)
1524
1525
  def update_filtering_validation(
1525
1526
  self,
1526
1527
  *,
@@ -1577,7 +1578,7 @@ class ConnectorClient(NamespacedClient):
1577
1578
  @_rewrite_parameters(
1578
1579
  body_fields=("index_name",),
1579
1580
  )
1580
- @_stability_warning(Stability.BETA)
1581
+ @_availability_warning(Stability.BETA)
1581
1582
  def update_index_name(
1582
1583
  self,
1583
1584
  *,
@@ -1634,7 +1635,7 @@ class ConnectorClient(NamespacedClient):
1634
1635
  @_rewrite_parameters(
1635
1636
  body_fields=("description", "name"),
1636
1637
  )
1637
- @_stability_warning(Stability.BETA)
1638
+ @_availability_warning(Stability.BETA)
1638
1639
  def update_name(
1639
1640
  self,
1640
1641
  *,
@@ -1692,7 +1693,7 @@ class ConnectorClient(NamespacedClient):
1692
1693
  @_rewrite_parameters(
1693
1694
  body_fields=("is_native",),
1694
1695
  )
1695
- @_stability_warning(Stability.BETA)
1696
+ @_availability_warning(Stability.BETA)
1696
1697
  def update_native(
1697
1698
  self,
1698
1699
  *,
@@ -1748,7 +1749,7 @@ class ConnectorClient(NamespacedClient):
1748
1749
  @_rewrite_parameters(
1749
1750
  body_fields=("pipeline",),
1750
1751
  )
1751
- @_stability_warning(Stability.BETA)
1752
+ @_availability_warning(Stability.BETA)
1752
1753
  def update_pipeline(
1753
1754
  self,
1754
1755
  *,
@@ -1805,7 +1806,7 @@ class ConnectorClient(NamespacedClient):
1805
1806
  @_rewrite_parameters(
1806
1807
  body_fields=("scheduling",),
1807
1808
  )
1808
- @_stability_warning(Stability.BETA)
1809
+ @_availability_warning(Stability.BETA)
1809
1810
  def update_scheduling(
1810
1811
  self,
1811
1812
  *,
@@ -1861,7 +1862,7 @@ class ConnectorClient(NamespacedClient):
1861
1862
  @_rewrite_parameters(
1862
1863
  body_fields=("service_type",),
1863
1864
  )
1864
- @_stability_warning(Stability.BETA)
1865
+ @_availability_warning(Stability.BETA)
1865
1866
  def update_service_type(
1866
1867
  self,
1867
1868
  *,
@@ -1917,7 +1918,7 @@ class ConnectorClient(NamespacedClient):
1917
1918
  @_rewrite_parameters(
1918
1919
  body_fields=("status",),
1919
1920
  )
1920
- @_stability_warning(Stability.EXPERIMENTAL)
1921
+ @_availability_warning(Stability.EXPERIMENTAL)
1921
1922
  def update_status(
1922
1923
  self,
1923
1924
  *,