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

elasticsearch/_async/client/inference.py

@@ -20,12 +20,19 @@ 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,
+    Stability,
+    _quote,
+    _rewrite_parameters,
+    _stability_warning,
+)
 
 
 class InferenceClient(NamespacedClient):
 
     @_rewrite_parameters()
+    @_stability_warning(Stability.EXPERIMENTAL)
     async def delete(
         self,
         *,
@@ -46,7 +53,7 @@ class InferenceClient(NamespacedClient):
         """
         Delete an inference endpoint
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/delete-inference-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/delete-inference-api.html>`_
 
         :param inference_id: The inference Id
         :param task_type: The task type
@@ -93,6 +100,7 @@ class InferenceClient(NamespacedClient):
         )
 
     @_rewrite_parameters()
+    @_stability_warning(Stability.EXPERIMENTAL)
     async def get(
         self,
         *,
@@ -111,7 +119,7 @@ class InferenceClient(NamespacedClient):
         """
         Get an inference endpoint
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/get-inference-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/get-inference-api.html>`_
 
         :param task_type: The task type
         :param inference_id: The inference Id
@@ -151,6 +159,7 @@ class InferenceClient(NamespacedClient):
     @_rewrite_parameters(
         body_fields=("input", "query", "task_settings"),
     )
+    @_stability_warning(Stability.EXPERIMENTAL)
     async def inference(
         self,
         *,
@@ -174,7 +183,7 @@ class InferenceClient(NamespacedClient):
         """
         Perform inference on the service
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/post-inference-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/post-inference-api.html>`_
 
         :param inference_id: The inference Id
         :param input: Inference input. Either a string or an array of strings.
@@ -237,6 +246,7 @@ class InferenceClient(NamespacedClient):
     @_rewrite_parameters(
         body_name="inference_config",
     )
+    @_stability_warning(Stability.EXPERIMENTAL)
     async def put(
         self,
         *,
@@ -257,7 +267,7 @@ class InferenceClient(NamespacedClient):
         """
         Create an inference endpoint
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/put-inference-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/put-inference-api.html>`_
 
         :param inference_id: The inference Id
         :param inference_config:

elasticsearch/_async/client/ingest.py

@@ -40,7 +40,7 @@ class IngestClient(NamespacedClient):
         """
         Deletes a geoip database configuration.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/TODO.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/delete-geoip-database-api.html>`_
 
         :param id: A comma-separated list of geoip database configurations to delete
         :param master_timeout: Period to wait for a connection to the master node. If
@@ -91,7 +91,7 @@ class IngestClient(NamespacedClient):
         """
         Deletes one or more existing ingest pipeline.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/delete-pipeline-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/delete-pipeline-api.html>`_
 
         :param id: Pipeline ID or wildcard expression of pipeline IDs used to limit the
             request. To delete all ingest pipelines in a cluster, use a value of `*`.
@@ -140,7 +140,7 @@ class IngestClient(NamespacedClient):
         """
         Gets download statistics for GeoIP2 databases used with the geoip processor.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/geoip-processor.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/geoip-processor.html>`_
         """
         __path_parts: t.Dict[str, str] = {}
         __path = "/_ingest/geoip/stats"
@@ -177,7 +177,7 @@ class IngestClient(NamespacedClient):
         """
         Returns information about one or more geoip database configurations.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/TODO.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/get-geoip-database-api.html>`_
 
         :param id: Comma-separated list of database configuration IDs to retrieve. Wildcard
             (`*`) expressions are supported. To get all database configurations, omit
@@ -230,7 +230,7 @@ class IngestClient(NamespacedClient):
         Returns information about one or more ingest pipelines. This API returns a local
         reference of the pipeline.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/get-pipeline-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/get-pipeline-api.html>`_
 
         :param id: Comma-separated list of pipeline IDs to retrieve. Wildcard (`*`) expressions
             are supported. To get all ingest pipelines, omit this parameter or use `*`.
@@ -284,7 +284,7 @@ class IngestClient(NamespacedClient):
         you expect will match. A grok pattern is like a regular expression that supports
         aliased expressions that can be reused.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/grok-processor.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/grok-processor.html>`_
         """
         __path_parts: t.Dict[str, str] = {}
         __path = "/_ingest/processor/grok"
@@ -327,7 +327,7 @@ class IngestClient(NamespacedClient):
         """
         Returns information about one or more geoip database configurations.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/TODO.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/put-geoip-database-api.html>`_
 
         :param id: ID of the database configuration to create or update.
         :param maxmind: The configuration necessary to identify which IP geolocation
@@ -381,13 +381,21 @@ class IngestClient(NamespacedClient):
         )
 
     @_rewrite_parameters(
-        body_fields=("description", "meta", "on_failure", "processors", "version"),
+        body_fields=(
+            "deprecated",
+            "description",
+            "meta",
+            "on_failure",
+            "processors",
+            "version",
+        ),
         parameter_aliases={"_meta": "meta"},
     )
     async def put_pipeline(
         self,
         *,
         id: str,
+        deprecated: t.Optional[bool] = None,
         description: t.Optional[str] = None,
         error_trace: t.Optional[bool] = None,
         filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
@@ -406,9 +414,13 @@ class IngestClient(NamespacedClient):
         Creates or updates an ingest pipeline. Changes made using this API take effect
         immediately.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ingest.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ingest.html>`_
 
         :param id: ID of the ingest pipeline to create or update.
+        :param deprecated: Marks this ingest pipeline as deprecated. When a deprecated
+            ingest pipeline is referenced as the default or final pipeline when creating
+            or updating a non-deprecated index template, Elasticsearch will emit a deprecation
+            warning.
         :param description: Description of the ingest pipeline.
         :param if_version: Required version for optimistic concurrency control for pipeline
             updates
@@ -452,6 +464,8 @@ class IngestClient(NamespacedClient):
         if timeout is not None:
             __query["timeout"] = timeout
         if not __body:
+            if deprecated is not None:
+                __body["deprecated"] = deprecated
             if description is not None:
                 __body["description"] = description
             if meta is not None:
@@ -479,8 +493,8 @@ class IngestClient(NamespacedClient):
     async def simulate(
         self,
         *,
-        id: t.Optional[str] = None,
         docs: t.Optional[t.Sequence[t.Mapping[str, t.Any]]] = None,
+        id: t.Optional[str] = None,
         error_trace: t.Optional[bool] = None,
         filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
         human: t.Optional[bool] = None,
@@ -492,17 +506,19 @@ class IngestClient(NamespacedClient):
         """
         Executes an ingest pipeline against a set of provided documents.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/simulate-pipeline-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/simulate-pipeline-api.html>`_
 
+        :param docs: Sample documents to test in the pipeline.
         :param id: Pipeline to test. If you don’t specify a `pipeline` in the request
             body, this parameter is required.
-        :param docs: Sample documents to test in the pipeline.
         :param pipeline: Pipeline to test. If you don’t specify the `pipeline` request
             path parameter, this parameter is required. If you specify both this and
             the request path parameter, the API only uses the request path parameter.
         :param verbose: If `true`, the response includes output data for each processor
             in the executed pipeline.
         """
+        if docs is None and body is None:
+            raise ValueError("Empty value passed for parameter 'docs'")
         __path_parts: t.Dict[str, str]
         if id not in SKIP_IN_PATH:
             __path_parts = {"id": _quote(id)}

elasticsearch/_async/client/license.py

@@ -37,7 +37,7 @@ class LicenseClient(NamespacedClient):
         """
         Deletes licensing information for the cluster
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/delete-license.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/delete-license.html>`_
         """
         __path_parts: t.Dict[str, str] = {}
         __path = "/_license"
@@ -72,11 +72,11 @@ class LicenseClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        This API returns information about the type of license, when it was issued, and
-        when it expires, for example. For more information about the different types
-        of licenses, see https://www.elastic.co/subscriptions.
+        Get license information. Returns information about your Elastic license, including
+        its type, its status, when it was issued, and when it expires. For more information
+        about the different types of licenses, refer to [Elastic Stack subscriptions](https://www.elastic.co/subscriptions).
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/get-license.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/get-license.html>`_
 
         :param accept_enterprise: If `true`, this parameter returns enterprise for Enterprise
             license types. If `false`, this parameter returns platinum for both platinum
@@ -122,7 +122,7 @@ class LicenseClient(NamespacedClient):
         """
         Retrieves information about the status of the basic license.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/get-basic-status.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/get-basic-status.html>`_
         """
         __path_parts: t.Dict[str, str] = {}
         __path = "/_license/basic_status"
@@ -157,7 +157,7 @@ class LicenseClient(NamespacedClient):
         """
         Retrieves information about the status of the trial license.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/get-trial-status.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/get-trial-status.html>`_
         """
         __path_parts: t.Dict[str, str] = {}
         __path = "/_license/trial_status"
@@ -198,7 +198,7 @@ class LicenseClient(NamespacedClient):
         """
         Updates the license for the cluster.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/update-license.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/update-license.html>`_
 
         :param acknowledge: Specifies whether you acknowledge the license changes.
         :param license:
@@ -257,7 +257,7 @@ class LicenseClient(NamespacedClient):
         acknowledge parameter set to true. To check the status of your basic license,
         use the following API: [Get basic status](https://www.elastic.co/guide/en/elasticsearch/reference/current/get-basic-status.html).
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/start-basic.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/start-basic.html>`_
 
         :param acknowledge: whether the user has acknowledged acknowledge messages (default:
             false)
@@ -300,7 +300,7 @@ class LicenseClient(NamespacedClient):
         The start trial API enables you to start a 30-day trial, which gives access to
         all subscription features.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/start-trial.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/start-trial.html>`_
 
         :param acknowledge: whether the user has acknowledged acknowledge messages (default:
             false)

elasticsearch/_async/client/logstash.py

@@ -38,7 +38,7 @@ class LogstashClient(NamespacedClient):
         """
         Deletes a pipeline used for Logstash Central Management.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/logstash-api-delete-pipeline.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/logstash-api-delete-pipeline.html>`_
 
         :param id: Identifier for the pipeline.
         """
@@ -78,7 +78,7 @@ class LogstashClient(NamespacedClient):
         """
         Retrieves pipelines used for Logstash Central Management.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/logstash-api-get-pipeline.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/logstash-api-get-pipeline.html>`_
 
         :param id: Comma-separated list of pipeline identifiers.
         """
@@ -125,7 +125,7 @@ class LogstashClient(NamespacedClient):
         """
         Creates or updates a pipeline used for Logstash Central Management.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/logstash-api-put-pipeline.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/logstash-api-put-pipeline.html>`_
 
         :param id: Identifier for the pipeline.
         :param pipeline:

elasticsearch/_async/client/migration.py

@@ -40,7 +40,7 @@ class MigrationClient(NamespacedClient):
         that use deprecated features that will be removed or changed in the next major
         version.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/migration-api-deprecation.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/migration-api-deprecation.html>`_
 
         :param index: Comma-separate list of data streams or indices to check. Wildcard
             (*) expressions are supported.
@@ -83,7 +83,7 @@ class MigrationClient(NamespacedClient):
         """
         Find out whether system features need to be upgraded or not
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/migration-api-feature-upgrade.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/migration-api-feature-upgrade.html>`_
         """
         __path_parts: t.Dict[str, str] = {}
         __path = "/_migration/system_features"
@@ -118,7 +118,7 @@ class MigrationClient(NamespacedClient):
         """
         Begin upgrades for system features
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/migration-api-feature-upgrade.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/migration-api-feature-upgrade.html>`_
         """
         __path_parts: t.Dict[str, str] = {}
         __path = "/_migration/system_features"