elasticsearch 8.16.0__py3-none-any.whl → 8.17.0__py3-none-any.whl

elasticsearch/_async/client/monitoring.py

@@ -44,7 +44,7 @@ class MonitoringClient(NamespacedClient):
         """
         Used by the monitoring features to send monitoring data.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/monitor-elasticsearch-cluster.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/monitor-elasticsearch-cluster.html>`_
 
         :param interval: Collection interval (e.g., '10s' or '10000ms') of the payload
         :param operations:

elasticsearch/_async/client/nodes.py

@@ -44,10 +44,10 @@ class NodesClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        You can use this API to clear the archived repositories metering information
-        in the cluster.
+        Clear the archived repositories metering. Clear the archived repositories metering
+        information in the cluster.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/clear-repositories-metering-archive-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/clear-repositories-metering-archive-api.html>`_
 
         :param node_id: Comma-separated list of node IDs or names used to limit returned
             information. All the nodes selective options are explained [here](https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster.html#cluster-nodes).
@@ -94,13 +94,13 @@ class NodesClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        You can use the cluster repositories metering API to retrieve repositories metering
-        information in a cluster. This API exposes monotonically non-decreasing counters
-        and it’s 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 won’t be present after node restarts.
+        Get cluster repositories metering. 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.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/get-repositories-metering-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-repositories-metering-api.html>`_
 
         :param node_id: Comma-separated list of node IDs or names used to limit returned
             information. All the nodes selective options are explained [here](https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster.html#cluster-nodes).
@@ -151,10 +151,11 @@ class NodesClient(NamespacedClient):
         ] = None,
     ) -> TextApiResponse:
         """
-        This API yields a breakdown of the hot threads on each selected node in the cluster.
-        The output is plain text with a breakdown of each node’s top hot threads.
+        Get the hot threads for nodes. 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.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-nodes-hot-threads.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-nodes-hot-threads.html>`_
 
         :param node_id: List of node IDs or names used to limit returned information.
         :param ignore_idle_threads: If true, known idle threads (e.g. waiting in a socket
@@ -227,9 +228,10 @@ class NodesClient(NamespacedClient):
         timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Returns cluster nodes information.
+        Get node information. By default, the API returns all attributes and core settings
+        for cluster nodes.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-nodes-info.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-nodes-info.html>`_
 
         :param node_id: Comma-separated list of node IDs or names used to limit returned
             information.
@@ -296,9 +298,20 @@ class NodesClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Reloads the keystore on nodes in the cluster.
+        Reload the keystore on nodes in the cluster. Secure settings are stored in an
+        on-disk keystore. Certain of these settings are reloadable. That is, you can
+        change them on disk and reload them without restarting any nodes in the cluster.
+        When you have updated reloadable secure settings in your keystore, you can use
+        this API to reload those settings on each node. When the Elasticsearch keystore
+        is password protected and not simply obfuscated, you must provide the password
+        for the keystore when you reload the secure settings. Reloading the settings
+        for the whole cluster assumes that the keystores for all nodes are protected
+        with the same password; this method is allowed only when inter-node communications
+        are encrypted. Alternatively, you can reload the secure settings on each node
+        by locally accessing the API and passing the node-specific Elasticsearch keystore
+        password.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/secure-settings.html#reloadable-secure-settings>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/secure-settings.html#reloadable-secure-settings>`_
 
         :param node_id: The names of particular nodes in the cluster to target.
         :param secure_settings_password: The password for the Elasticsearch keystore.
@@ -367,9 +380,10 @@ class NodesClient(NamespacedClient):
         types: t.Optional[t.Sequence[str]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Returns cluster nodes statistics.
+        Get node statistics. Get statistics for nodes in a cluster. By default, all stats
+        are returned. You can limit the returned information by using metrics.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-nodes-stats.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cluster-nodes-stats.html>`_
 
         :param node_id: Comma-separated list of node IDs or names used to limit returned
             information.
@@ -484,9 +498,9 @@ class NodesClient(NamespacedClient):
         timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Returns information on the usage of features.
+        Get feature usage information.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/cluster-nodes-usage.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/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

elasticsearch/_async/client/query_rules.py

@@ -37,9 +37,9 @@ class QueryRulesClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Deletes a query rule within a query ruleset.
+        Delete a query rule. Delete a query rule within a query ruleset.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/delete-query-rule.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/delete-query-rule.html>`_
 
         :param ruleset_id: The unique identifier of the query ruleset containing the
             rule to delete
@@ -85,9 +85,9 @@ class QueryRulesClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Deletes a query ruleset.
+        Delete a query ruleset.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/delete-query-ruleset.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/delete-query-ruleset.html>`_
 
         :param ruleset_id: The unique identifier of the query ruleset to delete
         """
@@ -126,9 +126,9 @@ class QueryRulesClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Returns the details about a query rule within a query ruleset
+        Get a query rule. Get details about a query rule within a query ruleset.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/get-query-rule.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-query-rule.html>`_
 
         :param ruleset_id: The unique identifier of the query ruleset containing the
             rule to retrieve
@@ -174,9 +174,9 @@ class QueryRulesClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Returns the details about a query ruleset
+        Get a query ruleset. Get details about a query ruleset.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/get-query-ruleset.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-query-ruleset.html>`_
 
         :param ruleset_id: The unique identifier of the query ruleset
         """
@@ -217,9 +217,9 @@ class QueryRulesClient(NamespacedClient):
         size: t.Optional[int] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Returns summarized information about existing query rulesets.
+        Get all query rulesets. Get summarized information about the query rulesets.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/list-query-rulesets.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/list-query-rulesets.html>`_
 
         :param from_: Starting offset (default: 0)
         :param size: specifies a max number of results to get
@@ -270,9 +270,9 @@ class QueryRulesClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Creates or updates a query rule within a query ruleset.
+        Create or update a query rule. Create or update a query rule within a query ruleset.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/put-query-rule.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/put-query-rule.html>`_
 
         :param ruleset_id: The unique identifier of the query ruleset containing the
             rule to be created or updated
@@ -345,9 +345,9 @@ class QueryRulesClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Creates or updates a query ruleset.
+        Create or update a query ruleset.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/put-query-ruleset.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/put-query-ruleset.html>`_
 
         :param ruleset_id: The unique identifier of the query ruleset to be created or
             updated
@@ -398,9 +398,10 @@ class QueryRulesClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Creates or updates a query ruleset.
+        Test a query ruleset. Evaluate match criteria against a query ruleset to identify
+        the rules that would match that criteria.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/test-query-ruleset.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/test-query-ruleset.html>`_
 
         :param ruleset_id: The unique identifier of the query ruleset to be created or
             updated

elasticsearch/_async/client/rollup.py

@@ -45,7 +45,7 @@ class RollupClient(NamespacedClient):
         """
         Deletes an existing rollup job.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/rollup-delete-job.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/rollup-delete-job.html>`_
 
         :param id: Identifier for the job.
         """
@@ -86,7 +86,7 @@ class RollupClient(NamespacedClient):
         """
         Retrieves the configuration, stats, and status of rollup jobs.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/rollup-get-job.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/rollup-get-job.html>`_
 
         :param id: Identifier for the rollup job. If it is `_all` or omitted, the API
             returns all rollup jobs.
@@ -132,7 +132,7 @@ class RollupClient(NamespacedClient):
         Returns the capabilities of any rollup jobs that have been configured for a specific
         index or index pattern.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/rollup-get-rollup-caps.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/rollup-get-rollup-caps.html>`_
 
         :param id: Index, indices or index-pattern to return rollup capabilities for.
             `_all` may be used to fetch rollup capabilities from all jobs.
@@ -178,7 +178,7 @@ class RollupClient(NamespacedClient):
         Returns the rollup capabilities of all jobs inside of a rollup index (for example,
         the index where rollup data is stored).
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/rollup-get-rollup-index-caps.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/rollup-get-rollup-index-caps.html>`_
 
         :param index: Data stream or index to check for rollup capabilities. Wildcard
             (`*`) expressions are supported.
@@ -241,7 +241,7 @@ class RollupClient(NamespacedClient):
         """
         Creates a rollup job.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/rollup-put-job.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/rollup-put-job.html>`_
 
         :param id: Identifier for the rollup job. This can be any alphanumeric string
             and uniquely identifies the data that is associated with the rollup job.
@@ -358,7 +358,7 @@ class RollupClient(NamespacedClient):
         """
         Enables searching rolled-up data using the standard Query DSL.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/rollup-search.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/rollup-search.html>`_
 
         :param index: Enables searching rolled-up data using the standard Query DSL.
         :param aggregations: Specifies aggregations.
@@ -422,7 +422,7 @@ class RollupClient(NamespacedClient):
         """
         Starts an existing, stopped rollup job.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/rollup-start-job.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/rollup-start-job.html>`_
 
         :param id: Identifier for the rollup job.
         """
@@ -465,7 +465,7 @@ class RollupClient(NamespacedClient):
         """
         Stops an existing, started rollup job.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/rollup-stop-job.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/rollup-stop-job.html>`_
 
         :param id: Identifier for the rollup job.
         :param timeout: If `wait_for_completion` is `true`, the API blocks for (at maximum)

elasticsearch/_async/client/search_application.py

@@ -46,7 +46,7 @@ class SearchApplicationClient(NamespacedClient):
         Delete a search application. Remove a search application and its associated alias.
         Indices attached to the search application are not removed.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/delete-search-application.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/delete-search-application.html>`_
 
         :param name: The name of the search application to delete
         """
@@ -88,7 +88,7 @@ class SearchApplicationClient(NamespacedClient):
         Delete a behavioral analytics collection. The associated data stream is also
         deleted.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/delete-analytics-collection.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/delete-analytics-collection.html>`_
 
         :param name: The name of the analytics collection to be deleted
         """
@@ -129,7 +129,7 @@ class SearchApplicationClient(NamespacedClient):
         """
         Get search application details.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/get-search-application.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-search-application.html>`_
 
         :param name: The name of the search application
         """
@@ -170,7 +170,7 @@ class SearchApplicationClient(NamespacedClient):
         """
         Get behavioral analytics collections.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/list-analytics-collection.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/list-analytics-collection.html>`_
 
         :param name: A list of analytics collections to limit the returned information
         """
@@ -218,7 +218,7 @@ class SearchApplicationClient(NamespacedClient):
         """
         Returns the existing search applications.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/list-search-applications.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/list-search-applications.html>`_
 
         :param from_: Starting offset.
         :param q: Query in the Lucene query string syntax.
@@ -270,7 +270,7 @@ class SearchApplicationClient(NamespacedClient):
         """
         Create or update a search application.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/put-search-application.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/put-search-application.html>`_
 
         :param name: The name of the search application to be created or updated.
         :param search_application:
@@ -324,7 +324,7 @@ class SearchApplicationClient(NamespacedClient):
         """
         Create a behavioral analytics collection.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/put-analytics-collection.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/put-analytics-collection.html>`_
 
         :param name: The name of the analytics collection to be created or updated.
         """
@@ -374,7 +374,7 @@ class SearchApplicationClient(NamespacedClient):
         the search application or default template. Unspecified template parameters are
         assigned their default values if applicable.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/search-application-search.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/search-application-search.html>`_
 
         :param name: The name of the search application to be searched.
         :param params: Query parameters specific to this request, which will override

elasticsearch/_async/client/searchable_snapshots.py

@@ -46,7 +46,7 @@ class SearchableSnapshotsClient(NamespacedClient):
         """
         Retrieve node-level cache statistics about searchable snapshots.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/searchable-snapshots-apis.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/searchable-snapshots-apis.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
@@ -105,7 +105,7 @@ class SearchableSnapshotsClient(NamespacedClient):
         """
         Clear the cache of searchable snapshots.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/searchable-snapshots-apis.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/searchable-snapshots-apis.html>`_
 
         :param index: A comma-separated list of index names
         :param allow_no_indices: Whether to ignore if a wildcard indices expression resolves
@@ -177,7 +177,7 @@ class SearchableSnapshotsClient(NamespacedClient):
         """
         Mount a snapshot as a searchable index.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/searchable-snapshots-api-mount-snapshot.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/searchable-snapshots-api-mount-snapshot.html>`_
 
         :param repository: The name of the repository containing the snapshot of the
             index to mount
@@ -257,7 +257,7 @@ class SearchableSnapshotsClient(NamespacedClient):
         """
         Retrieve shard-level statistics about searchable snapshots.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/searchable-snapshots-apis.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/searchable-snapshots-apis.html>`_
 
         :param index: A comma-separated list of index names
         :param level: Return stats aggregated at cluster, index or shard level