elasticsearch 8.19.2__py3-none-any.whl → 8.19.3__py3-none-any.whl

elasticsearch/_sync/client/monitoring.py

@@ -20,7 +20,7 @@ import typing as t
 from elastic_transport import ObjectApiResponse
 
 from ._base import NamespacedClient
-from .utils import _rewrite_parameters
+from .utils import Stability, Visibility, _availability_warning, _rewrite_parameters
 
 
 class MonitoringClient(NamespacedClient):
@@ -28,6 +28,7 @@ class MonitoringClient(NamespacedClient):
     @_rewrite_parameters(
         body_name="operations",
     )
+    @_availability_warning(Stability.STABLE, Visibility.PRIVATE)
     def bulk(
         self,
         *,

elasticsearch/_sync/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)
     def clear_repositories_metering_archive(
         self,
         *,
@@ -86,7 +86,7 @@ class NodesClient(NamespacedClient):
         )
 
     @_rewrite_parameters()
-    @_stability_warning(Stability.EXPERIMENTAL)
+    @_availability_warning(Stability.EXPERIMENTAL)
     def get_repositories_metering_info(
         self,
         *,
@@ -170,7 +170,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.
@@ -388,7 +388,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.
@@ -502,8 +502,8 @@ class NodesClient(NamespacedClient):
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cluster-nodes-usage.html>`_
 
         :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`.
         :param timeout: Period to wait for a response. If no response is received before

elasticsearch/_sync/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)
     def delete_job(
         self,
         *,
@@ -95,7 +95,7 @@ class RollupClient(NamespacedClient):
         )
 
     @_rewrite_parameters()
-    @_stability_warning(Stability.EXPERIMENTAL)
+    @_availability_warning(Stability.EXPERIMENTAL)
     def get_jobs(
         self,
         *,
@@ -147,7 +147,7 @@ class RollupClient(NamespacedClient):
         )
 
     @_rewrite_parameters()
-    @_stability_warning(Stability.EXPERIMENTAL)
+    @_availability_warning(Stability.EXPERIMENTAL)
     def get_rollup_caps(
         self,
         *,
@@ -203,7 +203,7 @@ class RollupClient(NamespacedClient):
         )
 
     @_rewrite_parameters()
-    @_stability_warning(Stability.EXPERIMENTAL)
+    @_availability_warning(Stability.EXPERIMENTAL)
     def get_rollup_index_caps(
         self,
         *,
@@ -266,7 +266,7 @@ class RollupClient(NamespacedClient):
         ),
         ignore_deprecated_options={"headers"},
     )
-    @_stability_warning(Stability.EXPERIMENTAL)
+    @_availability_warning(Stability.EXPERIMENTAL)
     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)
     def rollup_search(
         self,
         *,
@@ -503,7 +503,7 @@ class RollupClient(NamespacedClient):
         )
 
     @_rewrite_parameters()
-    @_stability_warning(Stability.EXPERIMENTAL)
+    @_availability_warning(Stability.EXPERIMENTAL)
     def start_job(
         self,
         *,
@@ -549,7 +549,7 @@ class RollupClient(NamespacedClient):
         )
 
     @_rewrite_parameters()
-    @_stability_warning(Stability.EXPERIMENTAL)
+    @_availability_warning(Stability.EXPERIMENTAL)
     def stop_job(
         self,
         *,

elasticsearch/_sync/client/search_application.py

@@ -23,16 +23,16 @@ from ._base import NamespacedClient
 from .utils import (
     SKIP_IN_PATH,
     Stability,
+    _availability_warning,
     _quote,
     _rewrite_parameters,
-    _stability_warning,
 )
 
 
 class SearchApplicationClient(NamespacedClient):
 
     @_rewrite_parameters()
-    @_stability_warning(Stability.BETA)
+    @_availability_warning(Stability.BETA)
     def delete(
         self,
         *,
@@ -77,7 +77,7 @@ class SearchApplicationClient(NamespacedClient):
         )
 
     @_rewrite_parameters()
-    @_stability_warning(Stability.EXPERIMENTAL)
+    @_availability_warning(Stability.EXPERIMENTAL)
     def delete_behavioral_analytics(
         self,
         *,
@@ -122,7 +122,7 @@ class SearchApplicationClient(NamespacedClient):
         )
 
     @_rewrite_parameters()
-    @_stability_warning(Stability.BETA)
+    @_availability_warning(Stability.BETA)
     def get(
         self,
         *,
@@ -166,7 +166,7 @@ class SearchApplicationClient(NamespacedClient):
         )
 
     @_rewrite_parameters()
-    @_stability_warning(Stability.EXPERIMENTAL)
+    @_availability_warning(Stability.EXPERIMENTAL)
     def get_behavioral_analytics(
         self,
         *,
@@ -215,7 +215,7 @@ class SearchApplicationClient(NamespacedClient):
     @_rewrite_parameters(
         parameter_aliases={"from": "from_"},
     )
-    @_stability_warning(Stability.BETA)
+    @_availability_warning(Stability.BETA)
     def list(
         self,
         *,
@@ -270,7 +270,7 @@ class SearchApplicationClient(NamespacedClient):
     @_rewrite_parameters(
         body_name="payload",
     )
-    @_stability_warning(Stability.EXPERIMENTAL)
+    @_availability_warning(Stability.EXPERIMENTAL)
     def post_behavioral_analytics_event(
         self,
         *,
@@ -338,7 +338,7 @@ class SearchApplicationClient(NamespacedClient):
     @_rewrite_parameters(
         body_name="search_application",
     )
-    @_stability_warning(Stability.BETA)
+    @_availability_warning(Stability.BETA)
     def put(
         self,
         *,
@@ -398,7 +398,7 @@ class SearchApplicationClient(NamespacedClient):
         )
 
     @_rewrite_parameters()
-    @_stability_warning(Stability.EXPERIMENTAL)
+    @_availability_warning(Stability.EXPERIMENTAL)
     def put_behavioral_analytics(
         self,
         *,
@@ -445,7 +445,7 @@ class SearchApplicationClient(NamespacedClient):
         body_fields=("params",),
         ignore_deprecated_options={"params"},
     )
-    @_stability_warning(Stability.EXPERIMENTAL)
+    @_availability_warning(Stability.EXPERIMENTAL)
     def render_query(
         self,
         *,
@@ -510,7 +510,7 @@ class SearchApplicationClient(NamespacedClient):
         body_fields=("params",),
         ignore_deprecated_options={"params"},
     )
-    @_stability_warning(Stability.BETA)
+    @_availability_warning(Stability.BETA)
     def search(
         self,
         *,

elasticsearch/_sync/client/searchable_snapshots.py

@@ -23,16 +23,16 @@ from ._base import NamespacedClient
 from .utils import (
     SKIP_IN_PATH,
     Stability,
+    _availability_warning,
     _quote,
     _rewrite_parameters,
-    _stability_warning,
 )
 
 
 class SearchableSnapshotsClient(NamespacedClient):
 
     @_rewrite_parameters()
-    @_stability_warning(Stability.EXPERIMENTAL)
+    @_availability_warning(Stability.EXPERIMENTAL)
     def cache_stats(
         self,
         *,
@@ -84,7 +84,7 @@ class SearchableSnapshotsClient(NamespacedClient):
         )
 
     @_rewrite_parameters()
-    @_stability_warning(Stability.EXPERIMENTAL)
+    @_availability_warning(Stability.EXPERIMENTAL)
     def clear_cache(
         self,
         *,
@@ -119,7 +119,7 @@ class SearchableSnapshotsClient(NamespacedClient):
             into no concrete indices. (This includes `_all` string or when no indices
             have been specified)
         :param expand_wildcards: Whether to expand wildcard expression to concrete indices
-            that are open, closed or both.
+            that are open, closed or both
         :param ignore_unavailable: Whether specified concrete indices should be ignored
             when unavailable (missing or closed)
         """

elasticsearch/_sync/client/security.py

@@ -892,8 +892,8 @@ class SecurityClient(NamespacedClient):
             Token names must be unique in the context of the associated service account.
             They must also be globally unique with their fully qualified names, which
             are comprised of the service account principal and token name, such as `<namespace>/<service>/<token-name>`.
-        :param refresh: If `true` then refresh the affected shards to make this operation
-            visible to search, if `wait_for` (the default) then wait for a refresh to
+        :param refresh: If `true` (the default) then refresh the affected shards to make
+            this operation visible to search, if `wait_for` then wait for a refresh to
             make this operation visible to search, if `false` then do nothing with refreshes.
         """
         if namespace in SKIP_IN_PATH:
@@ -1208,8 +1208,8 @@ class SecurityClient(NamespacedClient):
         :param namespace: The namespace, which is a top-level grouping of service accounts.
         :param service: The service name.
         :param name: The name of the service account token.
-        :param refresh: If `true` then refresh the affected shards to make this operation
-            visible to search, if `wait_for` (the default) then wait for a refresh to
+        :param refresh: If `true` (the default) then refresh the affected shards to make
+            this operation visible to search, if `wait_for` then wait for a refresh to
             make this operation visible to search, if `false` then do nothing with refreshes.
         """
         if namespace in SKIP_IN_PATH:

elasticsearch/_sync/client/shutdown.py

@@ -20,7 +20,11 @@ import typing as t
 from elastic_transport import ObjectApiResponse
 
 from ._base import NamespacedClient
-from .utils import SKIP_IN_PATH, _quote, _rewrite_parameters
+from .utils import (
+    SKIP_IN_PATH,
+    _quote,
+    _rewrite_parameters,
+)
 
 
 class ShutdownClient(NamespacedClient):
@@ -108,7 +112,8 @@ class ShutdownClient(NamespacedClient):
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/get-shutdown.html>`_
 
-        :param node_id: Which node for which to retrieve the shutdown status
+        :param node_id: Comma-separated list of nodes for which to retrieve the shutdown
+            status
         :param master_timeout: Period to wait for a connection to the master node. If
             no response is received before the timeout expires, the request fails and
             returns an error.

elasticsearch/_sync/client/simulate.py

@@ -23,9 +23,9 @@ from ._base import NamespacedClient
 from .utils import (
     SKIP_IN_PATH,
     Stability,
+    _availability_warning,
     _quote,
     _rewrite_parameters,
-    _stability_warning,
 )
 
 
@@ -40,7 +40,7 @@ class SimulateClient(NamespacedClient):
             "pipeline_substitutions",
         ),
     )
-    @_stability_warning(Stability.EXPERIMENTAL)
+    @_availability_warning(Stability.EXPERIMENTAL)
     def ingest(
         self,
         *,

elasticsearch/_sync/client/slm.py

@@ -210,7 +210,7 @@ class SlmClient(NamespacedClient):
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/slm-api-get-policy.html>`_
 
-        :param policy_id: Comma-separated list of snapshot lifecycle policies to retrieve
+        :param policy_id: A comma-separated list of snapshot lifecycle policy identifiers.
         :param master_timeout: The period to wait for a connection to the master node.
             If no response is received before the timeout expires, the request fails
             and returns an error.

elasticsearch/_sync/client/snapshot.py

@@ -23,9 +23,10 @@ from ._base import NamespacedClient
 from .utils import (
     SKIP_IN_PATH,
     Stability,
+    Visibility,
+    _availability_warning,
     _quote,
     _rewrite_parameters,
-    _stability_warning,
 )
 
 
@@ -913,7 +914,7 @@ class SnapshotClient(NamespacedClient):
         )
 
     @_rewrite_parameters()
-    @_stability_warning(Stability.EXPERIMENTAL)
+    @_availability_warning(Stability.EXPERIMENTAL, Visibility.PRIVATE)
     def repository_verify_integrity(
         self,
         *,

elasticsearch/_sync/client/streams.py

@@ -23,15 +23,15 @@ from elastic_transport import ObjectApiResponse, TextApiResponse
 from ._base import NamespacedClient
 from .utils import (
     Stability,
+    _availability_warning,
     _rewrite_parameters,
-    _stability_warning,
 )
 
 
 class StreamsClient(NamespacedClient):
 
     @_rewrite_parameters()
-    @_stability_warning(Stability.EXPERIMENTAL)
+    @_availability_warning(Stability.EXPERIMENTAL)
     def logs_disable(
         self,
         *,
@@ -72,7 +72,7 @@ class StreamsClient(NamespacedClient):
             __query["pretty"] = pretty
         if timeout is not None:
             __query["timeout"] = timeout
-        __headers = {"accept": "application/json,text/plain"}
+        __headers = {"accept": "text/plain,application/json"}
         return self.perform_request(  # type: ignore[return-value]
             "POST",
             __path,
@@ -83,7 +83,7 @@ class StreamsClient(NamespacedClient):
         )
 
     @_rewrite_parameters()
-    @_stability_warning(Stability.EXPERIMENTAL)
+    @_availability_warning(Stability.EXPERIMENTAL)
     def logs_enable(
         self,
         *,
@@ -127,7 +127,7 @@ class StreamsClient(NamespacedClient):
             __query["pretty"] = pretty
         if timeout is not None:
             __query["timeout"] = timeout
-        __headers = {"accept": "application/json,text/plain"}
+        __headers = {"accept": "text/plain,application/json"}
         return self.perform_request(  # type: ignore[return-value]
             "POST",
             __path,
@@ -138,7 +138,7 @@ class StreamsClient(NamespacedClient):
         )
 
     @_rewrite_parameters()
-    @_stability_warning(Stability.EXPERIMENTAL)
+    @_availability_warning(Stability.EXPERIMENTAL)
     def status(
         self,
         *,

elasticsearch/_sync/client/tasks.py

@@ -23,16 +23,16 @@ from ._base import NamespacedClient
 from .utils import (
     SKIP_IN_PATH,
     Stability,
+    _availability_warning,
     _quote,
     _rewrite_parameters,
-    _stability_warning,
 )
 
 
 class TasksClient(NamespacedClient):
 
     @_rewrite_parameters()
-    @_stability_warning(Stability.EXPERIMENTAL)
+    @_availability_warning(Stability.EXPERIMENTAL)
     def cancel(
         self,
         *,
@@ -106,7 +106,7 @@ class TasksClient(NamespacedClient):
         )
 
     @_rewrite_parameters()
-    @_stability_warning(Stability.EXPERIMENTAL)
+    @_availability_warning(Stability.EXPERIMENTAL)
     def get(
         self,
         *,
@@ -164,7 +164,7 @@ class TasksClient(NamespacedClient):
         )
 
     @_rewrite_parameters()
-    @_stability_warning(Stability.EXPERIMENTAL)
+    @_availability_warning(Stability.EXPERIMENTAL)
     def list(
         self,
         *,

elasticsearch/_sync/client/text_structure.py

@@ -402,7 +402,11 @@ class TextStructureClient(NamespacedClient):
         delimiter: t.Optional[str] = None,
         ecs_compatibility: t.Optional[str] = None,
         explain: t.Optional[bool] = None,
-        format: t.Optional[str] = None,
+        format: t.Optional[
+            t.Union[
+                str, t.Literal["delimited", "ndjson", "semi_structured_text", "xml"]
+            ]
+        ] = None,
         grok_pattern: t.Optional[str] = None,
         has_header_row: t.Optional[bool] = None,
         line_merge_size_limit: t.Optional[int] = None,

elasticsearch/_sync/client/transform.py

@@ -85,6 +85,43 @@ class TransformClient(NamespacedClient):
             path_parts=__path_parts,
         )
 
+    @_rewrite_parameters()
+    def get_node_stats(
+        self,
+        *,
+        error_trace: t.Optional[bool] = None,
+        filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
+        human: t.Optional[bool] = None,
+        pretty: t.Optional[bool] = None,
+    ) -> ObjectApiResponse[t.Any]:
+        """
+        .. raw:: html
+
+          <p>Get node stats.</p>
+          <p>Get per-node information about transform usage.</p>
+
+        """
+        __path_parts: t.Dict[str, str] = {}
+        __path = "/_transform/_node_stats"
+        __query: t.Dict[str, t.Any] = {}
+        if error_trace is not None:
+            __query["error_trace"] = error_trace
+        if filter_path is not None:
+            __query["filter_path"] = filter_path
+        if human is not None:
+            __query["human"] = human
+        if pretty is not None:
+            __query["pretty"] = pretty
+        __headers = {"accept": "application/json"}
+        return self.perform_request(  # type: ignore[return-value]
+            "GET",
+            __path,
+            params=__query,
+            headers=__headers,
+            endpoint_id="transform.get_node_stats",
+            path_parts=__path_parts,
+        )
+
     @_rewrite_parameters(
         parameter_aliases={"from": "from_"},
     )

elasticsearch/_sync/client/utils.py

@@ -79,6 +79,12 @@ class Stability(Enum):
     EXPERIMENTAL = auto()
 
 
+class Visibility(Enum):
+    PUBLIC = auto()
+    FEATURE_FLAG = auto()
+    PRIVATE = auto()
+
+
 _TYPE_HOSTS = Union[
     str, Sequence[Union[str, Mapping[str, Union[str, int]], NodeConfig]]
 ]
@@ -456,15 +462,23 @@ def _rewrite_parameters(
     return wrapper
 
 
-def _stability_warning(
+def _availability_warning(
     stability: Stability,
+    visibility: Visibility = Visibility.PUBLIC,
     version: Optional[str] = None,
     message: Optional[str] = None,
 ) -> Callable[[F], F]:
     def wrapper(api: F) -> F:
         @wraps(api)
         def wrapped(*args: Any, **kwargs: Any) -> Any:
-            if stability == Stability.BETA:
+            if visibility == Visibility.PRIVATE:
+                warnings.warn(
+                    "This API is private. "
+                    "Private APIs are not subject to the support SLA of official GA features.",
+                    category=GeneralAvailabilityWarning,
+                    stacklevel=warn_stacklevel(),
+                )
+            elif stability == Stability.BETA:
                 warnings.warn(
                     "This API is in beta and is subject to change. "
                     "The design and code is less mature than official GA features and is being provided as-is with no warranties. "

elasticsearch/_sync/client/watcher.py

@@ -492,9 +492,9 @@ class WatcherClient(NamespacedClient):
         :param active: The initial state of the watch. The default value is `true`, which
             means the watch is active by default.
         :param condition: The condition that defines if the actions should be run.
-        :param if_primary_term: only update the watch if the last operation that has
+        :param if_primary_term: Only update the watch if the last operation that has
             changed the watch has the specified primary term
-        :param if_seq_no: only update the watch if the last operation that has changed
+        :param if_seq_no: Only update the watch if the last operation that has changed
             the watch has the specified sequence number
         :param input: The input that defines the input that loads the data for the watch.
         :param metadata: Metadata JSON that will be copied into the history entries.

elasticsearch/_sync/client/xpack.py

@@ -56,7 +56,8 @@ class XPackClient(NamespacedClient):
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/info-api.html>`_
 
-        :param accept_enterprise: If this param is used it must be set to true
+        :param accept_enterprise: If used, this otherwise ignored parameter must be set
+            to true
         :param categories: A comma-separated list of the information categories to include
             in the response. For example, `build,license,features`.
         """

elasticsearch/_version.py

@@ -15,5 +15,5 @@
 #  specific language governing permissions and limitations
 #  under the License.
 
-__versionstr__ = "8.19.2"
-__es_specification_commit__ = "f4816bb41c52c1bfda93c48191f0a0e4e2d575be"
+__versionstr__ = "8.19.3"
+__es_specification_commit__ = "1c755b6fc50623dce6993efb7bfd3bdaef68fb90"

elasticsearch/dsl/_async/document.py

@@ -31,9 +31,8 @@ from typing import (
 
 from typing_extensions import Self, dataclass_transform
 
-from elasticsearch.exceptions import NotFoundError, RequestError
-from elasticsearch.helpers import async_bulk
-
+from ...exceptions import NotFoundError, RequestError
+from ...helpers import async_bulk
 from .._async.index import AsyncIndex
 from ..async_connections import get_connection
 from ..document_base import DocumentBase, DocumentMeta, mapped_field
@@ -42,8 +41,8 @@ from ..utils import DOC_META_FIELDS, META_FIELDS, AsyncUsingType, merge
 from .search import AsyncSearch
 
 if TYPE_CHECKING:
-    from elasticsearch import AsyncElasticsearch
-    from elasticsearch.esql.esql import ESQLBase
+    from ... import AsyncElasticsearch
+    from ...esql.esql import ESQLBase
 
 
 class AsyncIndexMeta(DocumentMeta):

elasticsearch/dsl/_async/index.py

@@ -30,7 +30,7 @@ from .update_by_query import AsyncUpdateByQuery
 if TYPE_CHECKING:
     from elastic_transport import ObjectApiResponse
 
-    from elasticsearch import AsyncElasticsearch
+    from ... import AsyncElasticsearch
 
 
 class AsyncIndexTemplate:

elasticsearch/dsl/_async/search.py

@@ -29,9 +29,8 @@ from typing import (
 
 from typing_extensions import Self
 
-from elasticsearch.exceptions import ApiError
-from elasticsearch.helpers import async_scan
-
+from ...exceptions import ApiError
+from ...helpers import async_scan
 from ..async_connections import get_connection
 from ..response import Response
 from ..search_base import MultiSearchBase, SearchBase