elasticsearch9 9.2.0__py3-none-any.whl → 9.3.0__py3-none-any.whl

elasticsearch9/_async/client/nodes.py

@@ -23,16 +23,16 @@ from ._base import NamespacedClient
 from .utils import (
     SKIP_IN_PATH,
     Stability,
+    _availability_warning,
     _quote,
     _rewrite_parameters,
-    _stability_warning,
 )
 
 
 class NodesClient(NamespacedClient):
 
     @_rewrite_parameters()
-    @_stability_warning(Stability.EXPERIMENTAL)
+    @_availability_warning(Stability.EXPERIMENTAL)
     async def clear_repositories_metering_archive(
         self,
         *,
@@ -46,8 +46,8 @@ class NodesClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Clear the archived repositories metering.
-          Clear the archived repositories metering information in the cluster.</p>
+          <p>Clear the archived repositories metering.</p>
+          <p>Clear the archived repositories metering information in the cluster.</p>
 
 
         `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-nodes-clear-repositories-metering-archive>`_
@@ -86,7 +86,7 @@ class NodesClient(NamespacedClient):
         )
 
     @_rewrite_parameters()
-    @_stability_warning(Stability.EXPERIMENTAL)
+    @_availability_warning(Stability.EXPERIMENTAL)
     async def get_repositories_metering_info(
         self,
         *,
@@ -99,8 +99,8 @@ class NodesClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Get cluster repositories metering.
-          Get repositories metering information for a cluster.
+          <p>Get cluster repositories metering.</p>
+          <p>Get repositories metering information for a cluster.
           This API exposes monotonically non-decreasing counters and it is expected that clients would durably store the information needed to compute aggregations over a period of time.
           Additionally, the information exposed by this API is volatile, meaning that it will not be present after node restarts.</p>
 
@@ -157,8 +157,8 @@ class NodesClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Get the hot threads for nodes.
-          Get a breakdown of the hot threads on each selected node in the cluster.
+          <p>Get the hot threads for nodes.</p>
+          <p>Get a breakdown of the hot threads on each selected node in the cluster.
           The output is plain text with a breakdown of the top hot threads for each node.</p>
 
 
@@ -169,7 +169,7 @@ class NodesClient(NamespacedClient):
             select, or to get a task from an empty queue) are filtered out.
         :param interval: The interval to do the second sampling of threads.
         :param snapshots: Number of samples of thread stacktrace.
-        :param sort: The sort order for 'cpu' type (default: total)
+        :param sort: The sort order for 'cpu' type
         :param threads: Specifies the number of hot threads to provide information for.
         :param timeout: Period to wait for a response. If no response is received before
             the timeout expires, the request fails and returns an error.
@@ -220,7 +220,50 @@ class NodesClient(NamespacedClient):
         self,
         *,
         node_id: t.Optional[t.Union[str, t.Sequence[str]]] = None,
-        metric: t.Optional[t.Union[str, t.Sequence[str]]] = None,
+        metric: t.Optional[
+            t.Union[
+                t.Sequence[
+                    t.Union[
+                        str,
+                        t.Literal[
+                            "_all",
+                            "_none",
+                            "aggregations",
+                            "http",
+                            "indices",
+                            "ingest",
+                            "jvm",
+                            "os",
+                            "plugins",
+                            "process",
+                            "remote_cluster_server",
+                            "settings",
+                            "thread_pool",
+                            "transport",
+                        ],
+                    ]
+                ],
+                t.Union[
+                    str,
+                    t.Literal[
+                        "_all",
+                        "_none",
+                        "aggregations",
+                        "http",
+                        "indices",
+                        "ingest",
+                        "jvm",
+                        "os",
+                        "plugins",
+                        "process",
+                        "remote_cluster_server",
+                        "settings",
+                        "thread_pool",
+                        "transport",
+                    ],
+                ],
+            ]
+        ] = None,
         error_trace: t.Optional[bool] = None,
         filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
         flat_settings: t.Optional[bool] = None,
@@ -357,8 +400,120 @@ class NodesClient(NamespacedClient):
         self,
         *,
         node_id: t.Optional[t.Union[str, t.Sequence[str]]] = None,
-        metric: t.Optional[t.Union[str, t.Sequence[str]]] = None,
-        index_metric: t.Optional[t.Union[str, t.Sequence[str]]] = None,
+        metric: t.Optional[
+            t.Union[
+                t.Sequence[
+                    t.Union[
+                        str,
+                        t.Literal[
+                            "_all",
+                            "_none",
+                            "adaptive_selection",
+                            "allocations",
+                            "breaker",
+                            "discovery",
+                            "fs",
+                            "http",
+                            "indexing_pressure",
+                            "indices",
+                            "ingest",
+                            "jvm",
+                            "os",
+                            "process",
+                            "repositories",
+                            "script",
+                            "script_cache",
+                            "thread_pool",
+                            "transport",
+                        ],
+                    ]
+                ],
+                t.Union[
+                    str,
+                    t.Literal[
+                        "_all",
+                        "_none",
+                        "adaptive_selection",
+                        "allocations",
+                        "breaker",
+                        "discovery",
+                        "fs",
+                        "http",
+                        "indexing_pressure",
+                        "indices",
+                        "ingest",
+                        "jvm",
+                        "os",
+                        "process",
+                        "repositories",
+                        "script",
+                        "script_cache",
+                        "thread_pool",
+                        "transport",
+                    ],
+                ],
+            ]
+        ] = None,
+        index_metric: t.Optional[
+            t.Union[
+                t.Sequence[
+                    t.Union[
+                        str,
+                        t.Literal[
+                            "_all",
+                            "bulk",
+                            "completion",
+                            "dense_vector",
+                            "docs",
+                            "fielddata",
+                            "flush",
+                            "get",
+                            "indexing",
+                            "mappings",
+                            "merge",
+                            "query_cache",
+                            "recovery",
+                            "refresh",
+                            "request_cache",
+                            "search",
+                            "segments",
+                            "shard_stats",
+                            "sparse_vector",
+                            "store",
+                            "translog",
+                            "warmer",
+                        ],
+                    ]
+                ],
+                t.Union[
+                    str,
+                    t.Literal[
+                        "_all",
+                        "bulk",
+                        "completion",
+                        "dense_vector",
+                        "docs",
+                        "fielddata",
+                        "flush",
+                        "get",
+                        "indexing",
+                        "mappings",
+                        "merge",
+                        "query_cache",
+                        "recovery",
+                        "refresh",
+                        "request_cache",
+                        "search",
+                        "segments",
+                        "shard_stats",
+                        "sparse_vector",
+                        "store",
+                        "translog",
+                        "warmer",
+                    ],
+                ],
+            ]
+        ] = None,
         completion_fields: t.Optional[t.Union[str, t.Sequence[str]]] = None,
         error_trace: t.Optional[bool] = None,
         fielddata_fields: t.Optional[t.Union[str, t.Sequence[str]]] = None,
@@ -376,8 +531,8 @@ class NodesClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Get node statistics.
-          Get statistics for nodes in a cluster.
+          <p>Get node statistics.</p>
+          <p>Get statistics for nodes in a cluster.
           By default, all stats are returned. You can limit the returned information by using metrics.</p>
 
 
@@ -385,7 +540,7 @@ class NodesClient(NamespacedClient):
 
         :param node_id: Comma-separated list of node IDs or names used to limit returned
             information.
-        :param metric: Limit the information returned to the specified metrics
+        :param metric: Limits the information returned to the specific metrics.
         :param index_metric: Limit the information returned for indices metric to the
             specific index metrics. It can be used only if indices (or all) metric is
             specified.
@@ -483,7 +638,14 @@ class NodesClient(NamespacedClient):
         self,
         *,
         node_id: t.Optional[t.Union[str, t.Sequence[str]]] = None,
-        metric: t.Optional[t.Union[str, t.Sequence[str]]] = None,
+        metric: t.Optional[
+            t.Union[
+                t.Sequence[
+                    t.Union[str, t.Literal["_all", "aggregations", "rest_actions"]]
+                ],
+                t.Union[str, t.Literal["_all", "aggregations", "rest_actions"]],
+            ]
+        ] = None,
         error_trace: t.Optional[bool] = None,
         filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
         human: t.Optional[bool] = None,
@@ -499,10 +661,10 @@ class NodesClient(NamespacedClient):
         `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-nodes-usage>`_
 
         :param node_id: A comma-separated list of node IDs or names to limit the returned
-            information; use `_local` to return information from the node you're connecting
-            to, leave empty to get information from all nodes
+            information. Use `_local` to return information from the node you're connecting
+            to, leave empty to get information from all nodes.
         :param metric: Limits the information returned to the specific metrics. A comma-separated
-            list of the following options: `_all`, `rest_actions`.
+            list of the following options: `_all`, `rest_actions`, `aggregations`.
         :param timeout: Period to wait for a response. If no response is received before
             the timeout expires, the request fails and returns an error.
         """

elasticsearch9/_async/client/project.py

@@ -22,15 +22,15 @@ from elastic_transport import ObjectApiResponse
 from ._base import NamespacedClient
 from .utils import (
     Stability,
+    _availability_warning,
     _rewrite_parameters,
-    _stability_warning,
 )
 
 
 class ProjectClient(NamespacedClient):
 
     @_rewrite_parameters()
-    @_stability_warning(Stability.EXPERIMENTAL)
+    @_availability_warning(Stability.EXPERIMENTAL)
     async def tags(
         self,
         *,
@@ -38,12 +38,19 @@ class ProjectClient(NamespacedClient):
         filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
         human: t.Optional[bool] = None,
         pretty: t.Optional[bool] = None,
+        project_routing: t.Optional[str] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
         .. raw:: html
 
-          <p>Return tags defined for the project</p>
+          <p>Get tags.</p>
+          <p>Get the tags that are defined for the project.</p>
 
+
+        `<https://www.elastic.co/docs/api/doc/elasticsearch-serverless/operation/operation-project-tags>`_
+
+        :param project_routing: A Lucene query using project metadata tags used to filter
+            which projects are returned in the response, such as _alias:_origin or _alias:*pr*.
         """
         __path_parts: t.Dict[str, str] = {}
         __path = "/_project/tags"
@@ -56,9 +63,11 @@ class ProjectClient(NamespacedClient):
             __query["human"] = human
         if pretty is not None:
             __query["pretty"] = pretty
+        if project_routing is not None:
+            __query["project_routing"] = project_routing
         __headers = {"accept": "application/json"}
         return await self.perform_request(  # type: ignore[return-value]
-            "GET",
+            "POST",
             __path,
             params=__query,
             headers=__headers,

elasticsearch9/_async/client/query_rules.py

@@ -39,8 +39,8 @@ class QueryRulesClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Delete a query rule.
-          Delete a query rule within a query ruleset.
+          <p>Delete a query rule.</p>
+          <p>Delete a query rule within a query ruleset.
           This is a destructive action that is only recoverable by re-adding the same rule with the create or update query rule API.</p>
 
 
@@ -92,8 +92,8 @@ class QueryRulesClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Delete a query ruleset.
-          Remove a query ruleset and its associated data.
+          <p>Delete a query ruleset.</p>
+          <p>Remove a query ruleset and its associated data.
           This is a destructive action that is not recoverable.</p>
 
 
@@ -138,8 +138,8 @@ class QueryRulesClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Get a query rule.
-          Get details about a query rule within a query ruleset.</p>
+          <p>Get a query rule.</p>
+          <p>Get details about a query rule within a query ruleset.</p>
 
 
         `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-query-rules-get-rule>`_
@@ -190,8 +190,8 @@ class QueryRulesClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Get a query ruleset.
-          Get details about a query ruleset.</p>
+          <p>Get a query ruleset.</p>
+          <p>Get details about a query ruleset.</p>
 
 
         `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-query-rules-get-ruleset>`_
@@ -237,8 +237,8 @@ class QueryRulesClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Get all query rulesets.
-          Get summarized information about the query rulesets.</p>
+          <p>Get all query rulesets.</p>
+          <p>Get summarized information about the query rulesets.</p>
 
 
         `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-query-rules-list-rulesets>`_
@@ -294,8 +294,8 @@ class QueryRulesClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Create or update a query rule.
-          Create or update a query rule within a query ruleset.</p>
+          <p>Create or update a query rule.</p>
+          <p>Create or update a query rule within a query ruleset.</p>
           <p>IMPORTANT: Due to limitations within pinned queries, you can only pin documents using ids or docs, but cannot use both in single rule.
           It is advised to use one or the other in query rulesets, to avoid errors.
           Additionally, pinned queries have a maximum limit of 100 pinned hits.
@@ -380,8 +380,8 @@ class QueryRulesClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Create or update a query ruleset.
-          There is a limit of 100 rules per ruleset.
+          <p>Create or update a query ruleset.</p>
+          <p>There is a limit of 100 rules per ruleset.
           This limit can be increased by using the <code>xpack.applications.rules.max_rules_per_ruleset</code> cluster setting.</p>
           <p>IMPORTANT: Due to limitations within pinned queries, you can only select documents using <code>ids</code> or <code>docs</code>, but cannot use both in single rule.
           It is advised to use one or the other in query rulesets, to avoid errors.
@@ -442,8 +442,8 @@ class QueryRulesClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Test a query ruleset.
-          Evaluate match criteria against a query ruleset to identify the rules that would match that criteria.</p>
+          <p>Test a query ruleset.</p>
+          <p>Evaluate match criteria against a query ruleset to identify the rules that would match that criteria.</p>
 
 
         `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-query-rules-test>`_

elasticsearch9/_async/client/rollup.py

@@ -23,16 +23,16 @@ from ._base import NamespacedClient
 from .utils import (
     SKIP_IN_PATH,
     Stability,
+    _availability_warning,
     _quote,
     _rewrite_parameters,
-    _stability_warning,
 )
 
 
 class RollupClient(NamespacedClient):
 
     @_rewrite_parameters()
-    @_stability_warning(Stability.EXPERIMENTAL)
+    @_availability_warning(Stability.EXPERIMENTAL)
     async def delete_job(
         self,
         *,
@@ -95,7 +95,7 @@ class RollupClient(NamespacedClient):
         )
 
     @_rewrite_parameters()
-    @_stability_warning(Stability.EXPERIMENTAL)
+    @_availability_warning(Stability.EXPERIMENTAL)
     async def get_jobs(
         self,
         *,
@@ -108,8 +108,8 @@ class RollupClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Get rollup job information.
-          Get the configuration, stats, and status of rollup jobs.</p>
+          <p>Get rollup job information.</p>
+          <p>Get the configuration, stats, and status of rollup jobs.</p>
           <p>NOTE: This API returns only active (both <code>STARTED</code> and <code>STOPPED</code>) jobs.
           If a job was created, ran for a while, then was deleted, the API does not return any details about it.
           For details about a historical rollup job, the rollup capabilities API may be more useful.</p>
@@ -147,7 +147,7 @@ class RollupClient(NamespacedClient):
         )
 
     @_rewrite_parameters()
-    @_stability_warning(Stability.EXPERIMENTAL)
+    @_availability_warning(Stability.EXPERIMENTAL)
     async def get_rollup_caps(
         self,
         *,
@@ -160,8 +160,8 @@ class RollupClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Get the rollup job capabilities.
-          Get the capabilities of any rollup jobs that have been configured for a specific index or index pattern.</p>
+          <p>Get the rollup job capabilities.</p>
+          <p>Get the capabilities of any rollup jobs that have been configured for a specific index or index pattern.</p>
           <p>This API is useful because a rollup job is often configured to rollup only a subset of fields from the source index.
           Furthermore, only certain aggregations can be configured for various fields, leading to a limited subset of functionality depending on that configuration.
           This API enables you to inspect an index and determine:</p>
@@ -203,7 +203,7 @@ class RollupClient(NamespacedClient):
         )
 
     @_rewrite_parameters()
-    @_stability_warning(Stability.EXPERIMENTAL)
+    @_availability_warning(Stability.EXPERIMENTAL)
     async def get_rollup_index_caps(
         self,
         *,
@@ -216,8 +216,8 @@ class RollupClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Get the rollup index capabilities.
-          Get the rollup capabilities of all jobs inside of a rollup index.
+          <p>Get the rollup index capabilities.</p>
+          <p>Get the rollup capabilities of all jobs inside of a rollup index.
           A single rollup index may store the data for multiple rollup jobs and may have a variety of capabilities depending on those jobs. This API enables you to determine:</p>
           <ul>
           <li>What jobs are stored in an index (or indices specified via a pattern)?</li>
@@ -266,7 +266,7 @@ class RollupClient(NamespacedClient):
         ),
         ignore_deprecated_options={"headers"},
     )
-    @_stability_warning(Stability.EXPERIMENTAL)
+    @_availability_warning(Stability.EXPERIMENTAL)
     async def put_job(
         self,
         *,
@@ -392,7 +392,7 @@ class RollupClient(NamespacedClient):
     @_rewrite_parameters(
         body_fields=("aggregations", "aggs", "query", "size"),
     )
-    @_stability_warning(Stability.EXPERIMENTAL)
+    @_availability_warning(Stability.EXPERIMENTAL)
     async def rollup_search(
         self,
         *,
@@ -412,8 +412,8 @@ class RollupClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Search rolled-up data.
-          The rollup search endpoint is needed because, internally, rolled-up documents utilize a different document structure than the original data.
+          <p>Search rolled-up data.</p>
+          <p>The rollup search endpoint is needed because, internally, rolled-up documents utilize a different document structure than the original data.
           It rewrites standard Query DSL into a format that matches the rollup documents then takes the response and rewrites it back to what a client would expect given the original query.</p>
           <p>The request body supports a subset of features from the regular search API.
           The following functionality is not available:</p>
@@ -482,7 +482,7 @@ class RollupClient(NamespacedClient):
         )
 
     @_rewrite_parameters()
-    @_stability_warning(Stability.EXPERIMENTAL)
+    @_availability_warning(Stability.EXPERIMENTAL)
     async def start_job(
         self,
         *,
@@ -495,8 +495,8 @@ class RollupClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Start rollup jobs.
-          If you try to start a job that does not exist, an exception occurs.
+          <p>Start rollup jobs.</p>
+          <p>If you try to start a job that does not exist, an exception occurs.
           If you try to start a job that is already started, nothing happens.</p>
 
 
@@ -528,7 +528,7 @@ class RollupClient(NamespacedClient):
         )
 
     @_rewrite_parameters()
-    @_stability_warning(Stability.EXPERIMENTAL)
+    @_availability_warning(Stability.EXPERIMENTAL)
     async def stop_job(
         self,
         *,
@@ -543,8 +543,8 @@ class RollupClient(NamespacedClient):
         """
         .. raw:: html
 
-          <p>Stop rollup jobs.
-          If you try to stop a job that does not exist, an exception occurs.
+          <p>Stop rollup jobs.</p>
+          <p>If you try to stop a job that does not exist, an exception occurs.
           If you try to stop a job that is already stopped, nothing happens.</p>
           <p>Since only a stopped job can be deleted, it can be useful to block the API until the indexer has fully stopped.
           This is accomplished with the <code>wait_for_completion</code> query parameter, and optionally a timeout. For example:</p>