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

elasticsearch/_sync/client/__init__.py

@@ -70,6 +70,7 @@ from .search_application import SearchApplicationClient
 from .searchable_snapshots import SearchableSnapshotsClient
 from .security import SecurityClient
 from .shutdown import ShutdownClient
+from .simulate import SimulateClient
 from .slm import SlmClient
 from .snapshot import SnapshotClient
 from .sql import SqlClient
@@ -465,6 +466,7 @@ class Elasticsearch(BaseClient):
         self.searchable_snapshots = SearchableSnapshotsClient(self)
         self.security = SecurityClient(self)
         self.slm = SlmClient(self)
+        self.simulate = SimulateClient(self)
         self.shutdown = ShutdownClient(self)
         self.sql = SqlClient(self)
         self.ssl = SslClient(self)
@@ -624,12 +626,14 @@ class Elasticsearch(BaseClient):
         error_trace: t.Optional[bool] = None,
         filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
         human: t.Optional[bool] = None,
+        list_executed_pipelines: t.Optional[bool] = None,
         pipeline: t.Optional[str] = None,
         pretty: t.Optional[bool] = None,
         refresh: t.Optional[
             t.Union[bool, str, t.Literal["false", "true", "wait_for"]]
         ] = None,
         require_alias: t.Optional[bool] = None,
+        require_data_stream: t.Optional[bool] = None,
         routing: t.Optional[str] = None,
         source: t.Optional[t.Union[bool, t.Union[str, t.Sequence[str]]]] = None,
         source_excludes: t.Optional[t.Union[str, t.Sequence[str]]] = None,
@@ -640,37 +644,125 @@ class Elasticsearch(BaseClient):
         ] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Bulk index or delete documents. Performs multiple indexing or delete operations
-        in a single API call. This reduces overhead and can greatly increase indexing
-        speed.
-
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/docs-bulk.html>`_
+        Bulk index or delete documents. Perform multiple `index`, `create`, `delete`,
+        and `update` actions in a single request. This reduces overhead and can greatly
+        increase indexing speed. If the Elasticsearch security features are enabled,
+        you must have the following index privileges for the target data stream, index,
+        or index alias: * To use the `create` action, you must have the `create_doc`,
+        `create`, `index`, or `write` index privilege. Data streams support only the
+        `create` action. * To use the `index` action, you must have the `create`, `index`,
+        or `write` index privilege. * To use the `delete` action, you must have the `delete`
+        or `write` index privilege. * To use the `update` action, you must have the `index`
+        or `write` index privilege. * To automatically create a data stream or index
+        with a bulk API request, you must have the `auto_configure`, `create_index`,
+        or `manage` index privilege. * To make the result of a bulk operation visible
+        to search using the `refresh` parameter, you must have the `maintenance` or `manage`
+        index privilege. Automatic data stream creation requires a matching index template
+        with data stream enabled. The actions are specified in the request body using
+        a newline delimited JSON (NDJSON) structure: ``` action_and_meta_data\\n optional_source\\n
+        action_and_meta_data\\n optional_source\\n .... action_and_meta_data\\n optional_source\\n
+        ``` The `index` and `create` actions expect a source on the next line and have
+        the same semantics as the `op_type` parameter in the standard index API. A `create`
+        action fails if a document with the same ID already exists in the target An `index`
+        action adds or replaces a document as necessary. NOTE: Data streams support only
+        the `create` action. To update or delete a document in a data stream, you must
+        target the backing index containing the document. An `update` action expects
+        that the partial doc, upsert, and script and its options are specified on the
+        next line. A `delete` action does not expect a source on the next line and has
+        the same semantics as the standard delete API. NOTE: The final line of data must
+        end with a newline character (`\\n`). Each newline character may be preceded
+        by a carriage return (`\\r`). When sending NDJSON data to the `_bulk` endpoint,
+        use a `Content-Type` header of `application/json` or `application/x-ndjson`.
+        Because this format uses literal newline characters (`\\n`) as delimiters, make
+        sure that the JSON actions and sources are not pretty printed. If you provide
+        a target in the request path, it is used for any actions that don't explicitly
+        specify an `_index` argument. A note on the format: the idea here is to make
+        processing as fast as possible. As some of the actions are redirected to other
+        shards on other nodes, only `action_meta_data` is parsed on the receiving node
+        side. Client libraries using this protocol should try and strive to do something
+        similar on the client side, and reduce buffering as much as possible. There is
+        no "correct" number of actions to perform in a single bulk request. Experiment
+        with different settings to find the optimal size for your particular workload.
+        Note that Elasticsearch limits the maximum size of a HTTP request to 100mb by
+        default so clients must ensure that no request exceeds this size. It is not possible
+        to index a single document that exceeds the size limit, so you must pre-process
+        any such documents into smaller pieces before sending them to Elasticsearch.
+        For instance, split documents into pages or chapters before indexing them, or
+        store raw binary data in a system outside Elasticsearch and replace the raw data
+        with a link to the external system in the documents that you send to Elasticsearch.
+        **Client suppport for bulk requests** Some of the officially supported clients
+        provide helpers to assist with bulk requests and reindexing: * Go: Check out
+        `esutil.BulkIndexer` * Perl: Check out `Search::Elasticsearch::Client::5_0::Bulk`
+        and `Search::Elasticsearch::Client::5_0::Scroll` * Python: Check out `elasticsearch.helpers.*`
+        * JavaScript: Check out `client.helpers.*` * .NET: Check out `BulkAllObservable`
+        * PHP: Check out bulk indexing. **Submitting bulk requests with cURL** If you're
+        providing text file input to `curl`, you must use the `--data-binary` flag instead
+        of plain `-d`. The latter doesn't preserve newlines. For example: ``` $ cat requests
+        { "index" : { "_index" : "test", "_id" : "1" } } { "field1" : "value1" } $ curl
+        -s -H "Content-Type: application/x-ndjson" -XPOST localhost:9200/_bulk --data-binary
+        "@requests"; echo {"took":7, "errors": false, "items":[{"index":{"_index":"test","_id":"1","_version":1,"result":"created","forced_refresh":false}}]}
+        ``` **Optimistic concurrency control** Each `index` and `delete` action within
+        a bulk API call may include the `if_seq_no` and `if_primary_term` parameters
+        in their respective action and meta data lines. The `if_seq_no` and `if_primary_term`
+        parameters control how operations are run, based on the last modification to
+        existing documents. See Optimistic concurrency control for more details. **Versioning**
+        Each bulk item can include the version value using the `version` field. It automatically
+        follows the behavior of the index or delete operation based on the `_version`
+        mapping. It also support the `version_type`. **Routing** Each bulk item can include
+        the routing value using the `routing` field. It automatically follows the behavior
+        of the index or delete operation based on the `_routing` mapping. NOTE: Data
+        streams do not support custom routing unless they were created with the `allow_custom_routing`
+        setting enabled in the template. **Wait for active shards** When making bulk
+        calls, you can set the `wait_for_active_shards` parameter to require a minimum
+        number of shard copies to be active before starting to process the bulk request.
+        **Refresh** Control when the changes made by this request are visible to search.
+        NOTE: Only the shards that receive the bulk request will be affected by refresh.
+        Imagine a `_bulk?refresh=wait_for` request with three documents in it that happen
+        to be routed to different shards in an index with five shards. The request will
+        only wait for those three shards to refresh. The other two shards that make up
+        the index do not participate in the `_bulk` request at all.
+
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/docs-bulk.html>`_
 
         :param operations:
-        :param index: Name of the data stream, index, or index alias to perform bulk
+        :param index: The name of the data stream, index, or index alias to perform bulk
             actions on.
-        :param pipeline: ID of the pipeline to use to preprocess incoming documents.
-            If the index has a default ingest pipeline specified, then setting the value
-            to `_none` disables the default ingest pipeline for this request. If a final
-            pipeline is configured it will always run, regardless of the value of this
+        :param list_executed_pipelines: If `true`, the response will include the ingest
+            pipelines that were run for each index or create.
+        :param pipeline: The pipeline identifier to use to preprocess incoming documents.
+            If the index has a default ingest pipeline specified, setting the value to
+            `_none` turns off the default ingest pipeline for this request. If a final
+            pipeline is configured, it will always run regardless of the value of this
             parameter.
         :param refresh: If `true`, Elasticsearch refreshes 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` do nothing with refreshes.
+            this operation visible to search. If `wait_for`, wait for a refresh to make
+            this operation visible to search. If `false`, do nothing with refreshes.
             Valid values: `true`, `false`, `wait_for`.
-        :param require_alias: If `true`, the request’s actions must target an index alias.
-        :param routing: Custom value used to route operations to a specific shard.
-        :param source: `true` or `false` to return the `_source` field or not, or a list
-            of fields to return.
+        :param require_alias: If `true`, the request's actions must target an index alias.
+        :param require_data_stream: If `true`, the request's actions must target a data
+            stream (existing or to be created).
+        :param routing: A custom value that is used to route operations to a specific
+            shard.
+        :param source: Indicates whether to return the `_source` field (`true` or `false`)
+            or contains a list of fields to return.
         :param source_excludes: A comma-separated list of source fields to exclude from
-            the response.
+            the response. You can also use this parameter to exclude fields from the
+            subset specified in `_source_includes` query parameter. If the `_source`
+            parameter is `false`, this parameter is ignored.
         :param source_includes: A comma-separated list of source fields to include in
-            the response.
-        :param timeout: Period each action waits for the following operations: automatic
-            index creation, dynamic mapping updates, waiting for active shards.
+            the response. If this parameter is specified, only these source fields are
+            returned. You can exclude fields from this subset using the `_source_excludes`
+            query parameter. If the `_source` parameter is `false`, this parameter is
+            ignored.
+        :param timeout: The period each action waits for the following operations: automatic
+            index creation, dynamic mapping updates, and waiting for active shards. The
+            default is `1m` (one minute), which guarantees Elasticsearch waits for at
+            least the timeout before failing. The actual wait time could be longer, particularly
+            when multiple waits occur.
         :param wait_for_active_shards: The number of shard copies that must be active
-            before proceeding with the operation. Set to all or any positive integer
-            up to the total number of shards in the index (`number_of_replicas+1`).
+            before proceeding with the operation. Set to `all` or any positive integer
+            up to the total number of shards in the index (`number_of_replicas+1`). The
+            default is `1`, which waits for each primary shard to be active.
         """
         if operations is None and body is None:
             raise ValueError(
@@ -692,6 +784,8 @@ class Elasticsearch(BaseClient):
             __query["filter_path"] = filter_path
         if human is not None:
             __query["human"] = human
+        if list_executed_pipelines is not None:
+            __query["list_executed_pipelines"] = list_executed_pipelines
         if pipeline is not None:
             __query["pipeline"] = pipeline
         if pretty is not None:
@@ -700,6 +794,8 @@ class Elasticsearch(BaseClient):
             __query["refresh"] = refresh
         if require_alias is not None:
             __query["require_alias"] = require_alias
+        if require_data_stream is not None:
+            __query["require_data_stream"] = require_data_stream
         if routing is not None:
             __query["routing"] = routing
         if source is not None:
@@ -744,9 +840,9 @@ class Elasticsearch(BaseClient):
         Clear a scrolling search. Clear the search context and results for a scrolling
         search.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/clear-scroll-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/clear-scroll-api.html>`_
 
-        :param scroll_id: Scroll IDs to clear. To clear all scroll IDs, use `_all`.
+        :param scroll_id: The scroll IDs to clear. To clear all scroll IDs, use `_all`.
         """
         __path_parts: t.Dict[str, str] = {}
         __path = "/_search/scroll"
@@ -798,7 +894,7 @@ class Elasticsearch(BaseClient):
         period has elapsed. However, keeping points in time has a cost; close them as
         soon as they are no longer required for search requests.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/point-in-time-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/point-in-time-api.html>`_
 
         :param id: The ID of the point-in-time.
         """
@@ -870,46 +966,62 @@ class Elasticsearch(BaseClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Returns number of documents matching a query.
-
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/search-count.html>`_
-
-        :param index: Comma-separated list of data streams, indices, and aliases to search.
-            Supports wildcards (`*`). To search all data streams and indices, omit this
-            parameter or use `*` or `_all`.
+        Count search results. Get the number of documents matching a query. The query
+        can either be provided using a simple query string as a parameter or using the
+        Query DSL defined within the request body. The latter must be nested in a `query`
+        key, which is the same as the search API. The count API supports multi-target
+        syntax. You can run a single count API search across multiple data streams and
+        indices. The operation is broadcast across all shards. For each shard ID group,
+        a replica is chosen and the search is run against it. This means that replicas
+        increase the scalability of the count.
+
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/search-count.html>`_
+
+        :param index: A comma-separated list of data streams, indices, and aliases to
+            search. It supports wildcards (`*`). To search all data streams and indices,
+            omit this parameter or use `*` or `_all`.
         :param allow_no_indices: If `false`, the request returns an error if any wildcard
             expression, index alias, or `_all` value targets only missing or closed indices.
-            This behavior applies even if the request targets other open indices.
+            This behavior applies even if the request targets other open indices. For
+            example, a request targeting `foo*,bar*` returns an error if an index starts
+            with `foo` but no index starts with `bar`.
         :param analyze_wildcard: If `true`, wildcard and prefix queries are analyzed.
-            This parameter can only be used when the `q` query string parameter is specified.
-        :param analyzer: Analyzer to use for the query string. This parameter can only
-            be used when the `q` query string parameter is specified.
+            This parameter can be used only when the `q` query string parameter is specified.
+        :param analyzer: The analyzer to use for the query string. This parameter can
+            be used only when the `q` query string parameter is specified.
         :param default_operator: The default operator for query string query: `AND` or
-            `OR`. This parameter can only be used when the `q` query string parameter
+            `OR`. This parameter can be used only when the `q` query string parameter
             is specified.
-        :param df: Field to use as default where no field prefix is given in the query
-            string. This parameter can only be used when the `q` query string parameter
+        :param df: The field to use as a default when no field prefix is given in the
+            query string. This parameter can be used only when the `q` query string parameter
             is specified.
-        :param expand_wildcards: Type of index that wildcard patterns can match. If the
-            request can target data streams, this argument determines whether wildcard
-            expressions match hidden data streams. Supports comma-separated values, such
-            as `open,hidden`.
-        :param ignore_throttled: If `true`, concrete, expanded or aliased indices are
+        :param expand_wildcards: The type of index that wildcard patterns can match.
+            If the request can target data streams, this argument determines whether
+            wildcard expressions match hidden data streams. It supports comma-separated
+            values, such as `open,hidden`.
+        :param ignore_throttled: If `true`, concrete, expanded, or aliased indices are
             ignored when frozen.
         :param ignore_unavailable: If `false`, the request returns an error if it targets
             a missing or closed index.
         :param lenient: If `true`, format-based query failures (such as providing text
-            to a numeric field) in the query string will be ignored.
-        :param min_score: Sets the minimum `_score` value that documents must have to
-            be included in the result.
-        :param preference: Specifies the node or shard the operation should be performed
-            on. Random by default.
-        :param q: Query in the Lucene query string syntax.
-        :param query: Defines the search definition using the Query DSL.
-        :param routing: Custom value used to route operations to a specific shard.
-        :param terminate_after: Maximum number of documents to collect for each shard.
+            to a numeric field) in the query string will be ignored. This parameter can
+            be used only when the `q` query string parameter is specified.
+        :param min_score: The minimum `_score` value that documents must have to be included
+            in the result.
+        :param preference: The node or shard the operation should be performed on. By
+            default, it is random.
+        :param q: The query in Lucene query string syntax.
+        :param query: Defines the search definition using the Query DSL. The query is
+            optional, and when not provided, it will use `match_all` to count all the
+            docs.
+        :param routing: A custom value used to route operations to a specific shard.
+        :param terminate_after: The maximum number of documents to collect for each shard.
             If a query reaches this limit, Elasticsearch terminates the query early.
-            Elasticsearch collects documents before sorting.
+            Elasticsearch collects documents before sorting. IMPORTANT: Use with caution.
+            Elasticsearch applies this parameter to each shard handling the request.
+            When possible, let Elasticsearch perform early termination automatically.
+            Avoid specifying this parameter for requests that target data streams with
+            backing indices across multiple data tiers.
         """
         __path_parts: t.Dict[str, str]
         if index not in SKIP_IN_PATH:
@@ -1007,7 +1119,7 @@ class Elasticsearch(BaseClient):
         and makes it searchable. If the target is an index and the document already exists,
         the request updates the document and increments its version.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/docs-index_.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/docs-index_.html>`_
 
         :param index: Name of the data stream or index to target. If the target doesn’t
             exist and matches the name or wildcard (`*`) pattern of an index template
@@ -1111,7 +1223,7 @@ class Elasticsearch(BaseClient):
         """
         Delete a document. Removes a JSON document from the specified index.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/docs-delete.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/docs-delete.html>`_
 
         :param index: Name of the target index.
         :param id: Unique identifier for the document.
@@ -1233,7 +1345,7 @@ class Elasticsearch(BaseClient):
         """
         Delete documents. Deletes documents that match the specified query.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/docs-delete-by-query.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/docs-delete-by-query.html>`_
 
         :param index: Comma-separated list of data streams, indices, and aliases to search.
             Supports wildcards (`*`). To search all data streams or indices, omit this
@@ -1414,7 +1526,7 @@ class Elasticsearch(BaseClient):
         takes effect immediately but rethrotting that slows down the query takes effect
         after completing the current batch to prevent scroll timeouts.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/docs-delete-by-query.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/docs-delete-by-query.html>`_
 
         :param task_id: The ID for the task.
         :param requests_per_second: The throttle for this request in sub-requests per
@@ -1460,7 +1572,7 @@ class Elasticsearch(BaseClient):
         """
         Delete a script or search template. Deletes a stored script or search template.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/modules-scripting.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/modules-scripting.html>`_
 
         :param id: Identifier for the stored script or search template.
         :param master_timeout: Period to wait for a connection to the master node. If
@@ -1528,7 +1640,7 @@ class Elasticsearch(BaseClient):
         """
         Check a document. Checks if a specified document exists.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/docs-get.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/docs-get.html>`_
 
         :param index: Comma-separated list of data streams, indices, and aliases. Supports
             wildcards (`*`).
@@ -1629,7 +1741,7 @@ class Elasticsearch(BaseClient):
         """
         Check for a document source. Checks if a document's `_source` is stored.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/docs-get.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/docs-get.html>`_
 
         :param index: Comma-separated list of data streams, indices, and aliases. Supports
             wildcards (`*`).
@@ -1730,7 +1842,7 @@ class Elasticsearch(BaseClient):
         Explain a document match result. Returns information about why a specific document
         matches, or doesn’t match, a query.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/search-explain.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/search-explain.html>`_
 
         :param index: Index names used to limit the request. Only a single index name
             can be provided to this parameter.
@@ -1853,7 +1965,7 @@ class Elasticsearch(BaseClient):
         field. For example, a runtime field with a type of keyword is returned the same
         as any other field that belongs to the `keyword` family.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/search-field-caps.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/search-field-caps.html>`_
 
         :param index: Comma-separated list of data streams, indices, and aliases used
             to limit the request. Supports wildcards (*). To target all data streams
@@ -1970,7 +2082,7 @@ class Elasticsearch(BaseClient):
         Get a document by its ID. Retrieves the document with the specified ID from an
         index.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/docs-get.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/docs-get.html>`_
 
         :param index: Name of the index that contains the document.
         :param id: Unique identifier of the document.
@@ -2059,7 +2171,7 @@ class Elasticsearch(BaseClient):
         """
         Get a script or search template. Retrieves a stored script or search template.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/modules-scripting.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/modules-scripting.html>`_
 
         :param id: Identifier for the stored script or search template.
         :param master_timeout: Specify timeout for connection to master
@@ -2101,7 +2213,7 @@ class Elasticsearch(BaseClient):
         """
         Get script contexts. Get a list of supported script contexts and their methods.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/painless/8.16/painless-contexts.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/painless/8.17/painless-contexts.html>`_
         """
         __path_parts: t.Dict[str, str] = {}
         __path = "/_script_context"
@@ -2136,7 +2248,7 @@ class Elasticsearch(BaseClient):
         """
         Get script languages. Get a list of available script types, languages, and contexts.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/modules-scripting.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/modules-scripting.html>`_
         """
         __path_parts: t.Dict[str, str] = {}
         __path = "/_script_language"
@@ -2191,7 +2303,7 @@ class Elasticsearch(BaseClient):
         """
         Get a document's source. Returns the source of a document.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/docs-get.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/docs-get.html>`_
 
         :param index: Name of the index that contains the document.
         :param id: Unique identifier of the document.
@@ -2272,9 +2384,28 @@ class Elasticsearch(BaseClient):
         verbose: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Returns the health of the cluster.
-
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/health-api.html>`_
+        Get the cluster health. Get a report with the health status of an Elasticsearch
+        cluster. The report contains a list of indicators that compose Elasticsearch
+        functionality. Each indicator has a health status of: green, unknown, yellow
+        or red. The indicator will provide an explanation and metadata describing the
+        reason for its current health status. The cluster’s status is controlled by the
+        worst indicator status. In the event that an indicator’s status is non-green,
+        a list of impacts may be present in the indicator result which detail the functionalities
+        that are negatively affected by the health issue. Each impact carries with it
+        a severity level, an area of the system that is affected, and a simple description
+        of the impact on the system. Some health indicators can determine the root cause
+        of a health problem and prescribe a set of steps that can be performed in order
+        to improve the health of the system. The root cause and remediation steps are
+        encapsulated in a diagnosis. A diagnosis contains a cause detailing a root cause
+        analysis, an action containing a brief description of the steps to take to fix
+        the problem, the list of affected resources (if applicable), and a detailed step-by-step
+        troubleshooting guide to fix the diagnosed problem. NOTE: The health indicators
+        perform root cause analysis of non-green health statuses. This can be computationally
+        expensive when called frequently. When setting up automated polling of the API
+        for health status, set verbose to false to disable the more expensive analysis
+        logic.
+
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/health-api.html>`_
 
         :param feature: A feature of the cluster, as returned by the top-level health
             report API.
@@ -2351,7 +2482,7 @@ class Elasticsearch(BaseClient):
         and makes it searchable. If the target is an index and the document already exists,
         the request updates the document and increments its version.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/docs-index_.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/docs-index_.html>`_
 
         :param index: Name of the data stream or index to target.
         :param document:
@@ -2458,9 +2589,9 @@ class Elasticsearch(BaseClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Get cluster info. Returns basic information about the cluster.
+        Get cluster info. Get basic build, version, and cluster information.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/index.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/rest-api-root.html>`_
         """
         __path_parts: t.Dict[str, str] = {}
         __path = "/"
@@ -2525,7 +2656,7 @@ class Elasticsearch(BaseClient):
         The kNN search API supports restricting the search using a filter. The search
         will return the top k documents that also match the filter query.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/search-search.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/search-search.html>`_
 
         :param index: A comma-separated list of index names to search; use `_all` or
             to perform the operation on all indices
@@ -2629,7 +2760,7 @@ class Elasticsearch(BaseClient):
         IDs in the request body. To ensure fast responses, this multi get (mget) API
         responds with partial results if one or more shards fail.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/docs-multi-get.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/docs-multi-get.html>`_
 
         :param index: Name of the index to retrieve documents from when `ids` are specified,
             or when a document in the `docs` array does not specify an index.
@@ -2756,7 +2887,7 @@ class Elasticsearch(BaseClient):
         Each newline character may be preceded by a carriage return `\\r`. When sending
         requests to this endpoint the `Content-Type` header should be set to `application/x-ndjson`.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/search-multi-search.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/search-multi-search.html>`_
 
         :param searches:
         :param index: Comma-separated list of data streams, indices, and index aliases
@@ -2888,7 +3019,7 @@ class Elasticsearch(BaseClient):
         """
         Run multiple templated searches.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/search-multi-search.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/search-multi-search.html>`_
 
         :param search_templates:
         :param index: Comma-separated list of data streams, indices, and aliases to search.
@@ -2987,7 +3118,7 @@ class Elasticsearch(BaseClient):
         with all the fetched termvectors. Each element has the structure provided by
         the termvectors API.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/docs-multi-termvectors.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/docs-multi-termvectors.html>`_
 
         :param index: Name of the index that contains the documents.
         :param docs: Array of existing or artificial documents.
@@ -3077,6 +3208,7 @@ class Elasticsearch(BaseClient):
         *,
         index: t.Union[str, t.Sequence[str]],
         keep_alive: t.Union[str, t.Literal[-1], t.Literal[0]],
+        allow_partial_search_results: t.Optional[bool] = None,
         error_trace: t.Optional[bool] = None,
         expand_wildcards: t.Optional[
             t.Union[
@@ -3106,11 +3238,15 @@ class Elasticsearch(BaseClient):
         A point in time must be opened explicitly before being used in search requests.
         The `keep_alive` parameter tells Elasticsearch how long it should persist.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/point-in-time-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/point-in-time-api.html>`_
 
         :param index: A comma-separated list of index names to open point in time; use
             `_all` or empty string to perform the operation on all indices
         :param keep_alive: Extends the time to live of the corresponding point in time.
+        :param allow_partial_search_results: If `false`, creating a point in time request
+            when a shard is missing or unavailable will throw an exception. If `true`,
+            the point in time will contain all the shards that are available at the time
+            of the request.
         :param expand_wildcards: Type of index that wildcard patterns can match. If the
             request can target data streams, this argument determines whether wildcard
             expressions match hidden data streams. Supports comma-separated values, such
@@ -3133,6 +3269,8 @@ class Elasticsearch(BaseClient):
         __body: t.Dict[str, t.Any] = body if body is not None else {}
         if keep_alive is not None:
             __query["keep_alive"] = keep_alive
+        if allow_partial_search_results is not None:
+            __query["allow_partial_search_results"] = allow_partial_search_results
         if error_trace is not None:
             __query["error_trace"] = error_trace
         if expand_wildcards is not None:
@@ -3188,7 +3326,7 @@ class Elasticsearch(BaseClient):
         Create or update a script or search template. Creates or updates a stored script
         or search template.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/modules-scripting.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/modules-scripting.html>`_
 
         :param id: Identifier for the stored script or search template. Must be unique
             within the cluster.
@@ -3274,7 +3412,7 @@ class Elasticsearch(BaseClient):
         Evaluate ranked search results. Evaluate the quality of ranked search results
         over a set of typical search queries.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/search-rank-eval.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/search-rank-eval.html>`_
 
         :param requests: A set of typical search requests, together with their provided
             ratings.
@@ -3370,7 +3508,7 @@ class Elasticsearch(BaseClient):
         can be any existing index, alias, or data stream. The destination must differ
         from the source. For example, you cannot reindex a data stream into itself.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/docs-reindex.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/docs-reindex.html>`_
 
         :param dest: The destination you are copying to.
         :param source: The source you are copying from.
@@ -3467,7 +3605,7 @@ class Elasticsearch(BaseClient):
         Throttle a reindex operation. Change the number of requests per second for a
         particular reindex operation.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/docs-reindex.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/docs-reindex.html>`_
 
         :param task_id: Identifier for the task.
         :param requests_per_second: The throttle for this request in sub-requests per
@@ -3518,7 +3656,7 @@ class Elasticsearch(BaseClient):
         """
         Render a search template. Render a search template as a search request body.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/render-search-template-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/render-search-template-api.html>`_
 
         :param id: ID of the search template to render. If no `source` is specified,
             this or the `id` request body parameter is required.
@@ -3587,7 +3725,7 @@ class Elasticsearch(BaseClient):
         """
         Run a script. Runs a script and returns a result.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/painless/8.16/painless-execute-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/painless/8.17/painless-execute-api.html>`_
 
         :param context: The context that the script should run in.
         :param context_setup: Additional parameters for the `context`.
@@ -3660,7 +3798,7 @@ class Elasticsearch(BaseClient):
         of the index at the time of the initial search request. Subsequent indexing or
         document changes only affect later search and scroll requests.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/search-request-body.html#request-body-search-scroll>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/search-request-body.html#request-body-search-scroll>`_
 
         :param scroll_id: Scroll ID of the search.
         :param rest_total_hits_as_int: If true, the API response’s hit.total property
@@ -3852,7 +3990,7 @@ class Elasticsearch(BaseClient):
         can provide search queries using the `q` query string parameter or the request
         body. If both are specified, only the query parameter is used.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/search-search.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/search-search.html>`_
 
         :param index: Comma-separated list of data streams, indices, and aliases to search.
             Supports wildcards (`*`). To search all data streams and indices, omit this
@@ -4282,7 +4420,7 @@ class Elasticsearch(BaseClient):
         """
         Search a vector tile. Search a vector tile for geospatial values.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/search-vector-tile-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/search-vector-tile-api.html>`_
 
         :param index: Comma-separated list of data streams, indices, or aliases to search
         :param field: Field containing geospatial data to return
@@ -4439,7 +4577,7 @@ class Elasticsearch(BaseClient):
         optimizations with routing and shard preferences. When filtered aliases are used,
         the filter is returned as part of the indices section.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/search-shards.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/search-shards.html>`_
 
         :param index: Returns the indices and shards that a search request would be executed
             against.
@@ -4540,7 +4678,7 @@ class Elasticsearch(BaseClient):
         """
         Run a search with a search template.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/search-template.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/search-template.html>`_
 
         :param index: Comma-separated list of data streams, indices, and aliases to search.
             Supports wildcards (*).
@@ -4680,7 +4818,7 @@ class Elasticsearch(BaseClient):
         are actually deleted. Until that happens, the terms enum API will return terms
         from these documents.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/search-terms-enum.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/search-terms-enum.html>`_
 
         :param index: Comma-separated list of data streams, indices, and index aliases
             to search. Wildcard (*) expressions are supported.
@@ -4779,7 +4917,7 @@ class Elasticsearch(BaseClient):
         Get term vector information. Get information and statistics about terms in the
         fields of a particular document.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/docs-termvectors.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/docs-termvectors.html>`_
 
         :param index: Name of the index that contains the document.
         :param id: Unique identifier of the document.
@@ -4922,7 +5060,7 @@ class Elasticsearch(BaseClient):
         Update a document. Updates a document by running a script or passing a partial
         document.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/docs-update.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/docs-update.html>`_
 
         :param index: The name of the index
         :param id: Document ID
@@ -5088,7 +5226,7 @@ class Elasticsearch(BaseClient):
         is specified, performs an update on every document in the data stream or index
         without modifying the source, which is useful for picking up mapping changes.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/docs-update-by-query.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/docs-update-by-query.html>`_
 
         :param index: Comma-separated list of data streams, indices, and aliases to search.
             Supports wildcards (`*`). To search all data streams or indices, omit this
@@ -5287,7 +5425,7 @@ class Elasticsearch(BaseClient):
         takes effect immediately but rethrotting that slows down the query takes effect
         after completing the current batch to prevent scroll timeouts.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/docs-update-by-query.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/docs-update-by-query.html>`_
 
         :param task_id: The ID for the task.
         :param requests_per_second: The throttle for this request in sub-requests per