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

elasticsearch/_async/client/inference.py

@@ -46,7 +46,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.17/delete-inference-api.html>`_
 
         :param inference_id: The inference Id
         :param task_type: The task type
@@ -111,7 +111,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.17/get-inference-api.html>`_
 
         :param task_type: The task type
         :param inference_id: The inference Id
@@ -174,7 +174,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.17/post-inference-api.html>`_
 
         :param inference_id: The inference Id
         :param input: Inference input. Either a string or an array of strings.
@@ -257,7 +257,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.17/put-inference-api.html>`_
 
         :param inference_id: The inference Id
         :param inference_config:

elasticsearch/_async/client/ingest.py

@@ -38,9 +38,10 @@ class IngestClient(NamespacedClient):
         timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Deletes a geoip database configuration.
+        Delete GeoIP database configurations. Delete one or more IP geolocation database
+        configurations.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/TODO.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/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
@@ -89,9 +90,9 @@ class IngestClient(NamespacedClient):
         timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Deletes one or more existing ingest pipeline.
+        Delete pipelines. Delete one or more ingest pipelines.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/delete-pipeline-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/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 `*`.
@@ -138,9 +139,10 @@ class IngestClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Gets download statistics for GeoIP2 databases used with the geoip processor.
+        Get GeoIP statistics. Get download statistics for GeoIP2 databases that are 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.17/geoip-processor.html>`_
         """
         __path_parts: t.Dict[str, str] = {}
         __path = "/_ingest/geoip/stats"
@@ -175,9 +177,10 @@ class IngestClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Returns information about one or more geoip database configurations.
+        Get GeoIP database configurations. Get information about one or more IP geolocation
+        database configurations.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/TODO.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/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
@@ -227,10 +230,10 @@ class IngestClient(NamespacedClient):
         summary: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Returns information about one or more ingest pipelines. This API returns a local
-        reference of the pipeline.
+        Get pipelines. Get 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.17/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 `*`.
@@ -279,12 +282,12 @@ class IngestClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Extracts structured fields out of a single text field within a document. You
-        choose which field to extract matched fields from, as well as the grok pattern
-        you expect will match. A grok pattern is like a regular expression that supports
-        aliased expressions that can be reused.
+        Run a grok processor. Extract structured fields out of a single text field within
+        a document. You must choose which field to extract matched fields from, as well
+        as the grok pattern 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.17/grok-processor.html>`_
         """
         __path_parts: t.Dict[str, str] = {}
         __path = "/_ingest/processor/grok"
@@ -325,9 +328,10 @@ class IngestClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Returns information about one or more geoip database configurations.
+        Create or update GeoIP database configurations. Create or update IP geolocation
+        database configurations.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/TODO.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/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 +385,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,
@@ -403,12 +415,15 @@ class IngestClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Creates or updates an ingest pipeline. Changes made using this API take effect
-        immediately.
+        Create or update a 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.17/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 +467,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 +496,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,
@@ -490,19 +507,23 @@ class IngestClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Executes an ingest pipeline against a set of provided documents.
+        Simulate a pipeline. Run an ingest pipeline against a set of provided documents.
+        You can either specify an existing pipeline to use with the provided documents
+        or supply a pipeline definition in the body of the request.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/simulate-pipeline-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/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

@@ -35,9 +35,11 @@ class LicenseClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Deletes licensing information for the cluster
+        Delete the license. When the license expires, your subscription level reverts
+        to Basic. If the operator privileges feature is enabled, only operator users
+        can use this API.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/delete-license.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/delete-license.html>`_
         """
         __path_parts: t.Dict[str, str] = {}
         __path = "/_license"
@@ -72,11 +74,13 @@ 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. Get information about your Elastic license including
+        its type, its status, when it was issued, and when it expires. NOTE: If the master
+        node is generating a new cluster state, the get license API may return a `404
+        Not Found` response. If you receive an unexpected 404 response after cluster
+        startup, wait a short period and retry the request.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/get-license.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/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
@@ -120,9 +124,9 @@ class LicenseClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Retrieves information about the status of the basic license.
+        Get the basic license status.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/get-basic-status.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-basic-status.html>`_
         """
         __path_parts: t.Dict[str, str] = {}
         __path = "/_license/basic_status"
@@ -155,9 +159,9 @@ class LicenseClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Retrieves information about the status of the trial license.
+        Get the trial status.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/get-trial-status.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-trial-status.html>`_
         """
         __path_parts: t.Dict[str, str] = {}
         __path = "/_license/trial_status"
@@ -196,9 +200,16 @@ class LicenseClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Updates the license for the cluster.
+        Update the license. You can update your license at runtime without shutting down
+        your nodes. License updates take effect immediately. If the license you are installing
+        does not support all of the features that were available with your previous license,
+        however, you are notified in the response. You must then re-submit the API request
+        with the acknowledge parameter set to true. NOTE: If Elasticsearch security features
+        are enabled and you are installing a gold or higher license, you must enable
+        TLS on the transport networking layer before you install the license. If the
+        operator privileges feature is enabled, only operator users can use this API.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/update-license.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-license.html>`_
 
         :param acknowledge: Specifies whether you acknowledge the license changes.
         :param license:
@@ -250,14 +261,15 @@ class LicenseClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        The start basic API enables you to initiate an indefinite basic license, which
-        gives access to all the basic features. If the basic license does not support
-        all of the features that are available with your current license, however, you
-        are notified in the response. You must then re-submit the API request with the
-        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).
+        Start a basic license. Start an indefinite basic license, which gives access
+        to all the basic features. NOTE: In order to start a basic license, you must
+        not currently have a basic license. If the basic license does not support all
+        of the features that are available with your current license, however, you are
+        notified in the response. You must then re-submit the API request with the `acknowledge`
+        parameter set to `true`. To check the status of your basic license, use the get
+        basic license API.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/start-basic.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/start-basic.html>`_
 
         :param acknowledge: whether the user has acknowledged acknowledge messages (default:
             false)
@@ -297,10 +309,14 @@ class LicenseClient(NamespacedClient):
         type_query_string: t.Optional[str] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        The start trial API enables you to start a 30-day trial, which gives access to
-        all subscription features.
+        Start a trial. Start a 30-day trial, which gives access to all subscription features.
+        NOTE: You are allowed to start a trial only if your cluster has not already activated
+        a trial for the current major product version. For example, if you have already
+        activated a trial for v8.0, you cannot start a new trial until v9.0. You can,
+        however, request an extended trial at https://www.elastic.co/trialextension.
+        To check the status of your trial, use the get trial status API.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/start-trial.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/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.17/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.17/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.17/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.17/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.17/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.17/migration-api-feature-upgrade.html>`_
         """
         __path_parts: t.Dict[str, str] = {}
         __path = "/_migration/system_features"