elasticsearch 8.11.1__py3-none-any.whl → 8.12.0__py3-none-any.whl

elasticsearch/_sync/client/ccr.py

@@ -37,7 +37,7 @@ class CcrClient(NamespacedClient):
         """
         Deletes auto-follow patterns.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/ccr-delete-auto-follow-pattern.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.12/ccr-delete-auto-follow-pattern.html>`_
 
         :param name: The name of the auto follow pattern.
         """
@@ -59,7 +59,20 @@ class CcrClient(NamespacedClient):
         )
 
     @_rewrite_parameters(
-        body_fields=True,
+        body_fields=(
+            "leader_index",
+            "max_outstanding_read_requests",
+            "max_outstanding_write_requests",
+            "max_read_request_operation_count",
+            "max_read_request_size",
+            "max_retry_delay",
+            "max_write_buffer_count",
+            "max_write_buffer_size",
+            "max_write_request_operation_count",
+            "max_write_request_size",
+            "read_poll_timeout",
+            "remote_cluster",
+        ),
     )
     def follow(
         self,
@@ -88,11 +101,12 @@ class CcrClient(NamespacedClient):
         wait_for_active_shards: t.Optional[
             t.Union[int, t.Union["t.Literal['all', 'index-setting']", str]]
         ] = None,
+        body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
         Creates a new follower index configured to follow the referenced leader index.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/ccr-put-follow.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.12/ccr-put-follow.html>`_
 
         :param index: The name of the follower index
         :param leader_index:
@@ -116,45 +130,48 @@ class CcrClient(NamespacedClient):
             raise ValueError("Empty value passed for parameter 'index'")
         __path = f"/{_quote(index)}/_ccr/follow"
         __query: t.Dict[str, t.Any] = {}
-        __body: t.Dict[str, t.Any] = {}
+        __body: t.Dict[str, t.Any] = body if body is not None else {}
         if error_trace is not None:
             __query["error_trace"] = error_trace
         if filter_path is not None:
             __query["filter_path"] = filter_path
         if human is not None:
             __query["human"] = human
-        if leader_index is not None:
-            __body["leader_index"] = leader_index
-        if max_outstanding_read_requests is not None:
-            __body["max_outstanding_read_requests"] = max_outstanding_read_requests
-        if max_outstanding_write_requests is not None:
-            __body["max_outstanding_write_requests"] = max_outstanding_write_requests
-        if max_read_request_operation_count is not None:
-            __body[
-                "max_read_request_operation_count"
-            ] = max_read_request_operation_count
-        if max_read_request_size is not None:
-            __body["max_read_request_size"] = max_read_request_size
-        if max_retry_delay is not None:
-            __body["max_retry_delay"] = max_retry_delay
-        if max_write_buffer_count is not None:
-            __body["max_write_buffer_count"] = max_write_buffer_count
-        if max_write_buffer_size is not None:
-            __body["max_write_buffer_size"] = max_write_buffer_size
-        if max_write_request_operation_count is not None:
-            __body[
-                "max_write_request_operation_count"
-            ] = max_write_request_operation_count
-        if max_write_request_size is not None:
-            __body["max_write_request_size"] = max_write_request_size
         if pretty is not None:
             __query["pretty"] = pretty
-        if read_poll_timeout is not None:
-            __body["read_poll_timeout"] = read_poll_timeout
-        if remote_cluster is not None:
-            __body["remote_cluster"] = remote_cluster
         if wait_for_active_shards is not None:
             __query["wait_for_active_shards"] = wait_for_active_shards
+        if not __body:
+            if leader_index is not None:
+                __body["leader_index"] = leader_index
+            if max_outstanding_read_requests is not None:
+                __body["max_outstanding_read_requests"] = max_outstanding_read_requests
+            if max_outstanding_write_requests is not None:
+                __body[
+                    "max_outstanding_write_requests"
+                ] = max_outstanding_write_requests
+            if max_read_request_operation_count is not None:
+                __body[
+                    "max_read_request_operation_count"
+                ] = max_read_request_operation_count
+            if max_read_request_size is not None:
+                __body["max_read_request_size"] = max_read_request_size
+            if max_retry_delay is not None:
+                __body["max_retry_delay"] = max_retry_delay
+            if max_write_buffer_count is not None:
+                __body["max_write_buffer_count"] = max_write_buffer_count
+            if max_write_buffer_size is not None:
+                __body["max_write_buffer_size"] = max_write_buffer_size
+            if max_write_request_operation_count is not None:
+                __body[
+                    "max_write_request_operation_count"
+                ] = max_write_request_operation_count
+            if max_write_request_size is not None:
+                __body["max_write_request_size"] = max_write_request_size
+            if read_poll_timeout is not None:
+                __body["read_poll_timeout"] = read_poll_timeout
+            if remote_cluster is not None:
+                __body["remote_cluster"] = remote_cluster
         __headers = {"accept": "application/json", "content-type": "application/json"}
         return self.perform_request(  # type: ignore[return-value]
             "PUT", __path, params=__query, headers=__headers, body=__body
@@ -174,7 +191,7 @@ class CcrClient(NamespacedClient):
         Retrieves information about all follower indices, including parameters and status
         for each follower index
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/ccr-get-follow-info.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.12/ccr-get-follow-info.html>`_
 
         :param index: A comma-separated list of index patterns; use `_all` to perform
             the operation on all indices
@@ -210,7 +227,7 @@ class CcrClient(NamespacedClient):
         Retrieves follower stats. return shard-level stats about the following tasks
         associated with each shard for the specified indices.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/ccr-get-follow-stats.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.12/ccr-get-follow-stats.html>`_
 
         :param index: A comma-separated list of index patterns; use `_all` to perform
             the operation on all indices
@@ -233,7 +250,12 @@ class CcrClient(NamespacedClient):
         )
 
     @_rewrite_parameters(
-        body_fields=True,
+        body_fields=(
+            "follower_cluster",
+            "follower_index",
+            "follower_index_uuid",
+            "leader_remote_cluster",
+        ),
     )
     def forget_follower(
         self,
@@ -247,11 +269,12 @@ class CcrClient(NamespacedClient):
         human: t.Optional[bool] = None,
         leader_remote_cluster: t.Optional[str] = None,
         pretty: t.Optional[bool] = None,
+        body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
         Removes the follower retention leases from the leader.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/ccr-post-forget-follower.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.12/ccr-post-forget-follower.html>`_
 
         :param index: the name of the leader index for which specified follower retention
             leases should be removed
@@ -264,23 +287,24 @@ class CcrClient(NamespacedClient):
             raise ValueError("Empty value passed for parameter 'index'")
         __path = f"/{_quote(index)}/_ccr/forget_follower"
         __query: t.Dict[str, t.Any] = {}
-        __body: t.Dict[str, t.Any] = {}
+        __body: t.Dict[str, t.Any] = body if body is not None else {}
         if error_trace is not None:
             __query["error_trace"] = error_trace
         if filter_path is not None:
             __query["filter_path"] = filter_path
-        if follower_cluster is not None:
-            __body["follower_cluster"] = follower_cluster
-        if follower_index is not None:
-            __body["follower_index"] = follower_index
-        if follower_index_uuid is not None:
-            __body["follower_index_uuid"] = follower_index_uuid
         if human is not None:
             __query["human"] = human
-        if leader_remote_cluster is not None:
-            __body["leader_remote_cluster"] = leader_remote_cluster
         if pretty is not None:
             __query["pretty"] = pretty
+        if not __body:
+            if follower_cluster is not None:
+                __body["follower_cluster"] = follower_cluster
+            if follower_index is not None:
+                __body["follower_index"] = follower_index
+            if follower_index_uuid is not None:
+                __body["follower_index_uuid"] = follower_index_uuid
+            if leader_remote_cluster is not None:
+                __body["leader_remote_cluster"] = leader_remote_cluster
         __headers = {"accept": "application/json", "content-type": "application/json"}
         return self.perform_request(  # type: ignore[return-value]
             "POST", __path, params=__query, headers=__headers, body=__body
@@ -300,7 +324,7 @@ class CcrClient(NamespacedClient):
         Gets configured auto-follow patterns. Returns the specified auto-follow pattern
         collection.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/ccr-get-auto-follow-pattern.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.12/ccr-get-auto-follow-pattern.html>`_
 
         :param name: Specifies the auto-follow pattern collection that you want to retrieve.
             If you do not specify a name, the API returns information for all collections.
@@ -336,7 +360,7 @@ class CcrClient(NamespacedClient):
         """
         Pauses an auto-follow pattern
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/ccr-pause-auto-follow-pattern.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.12/ccr-pause-auto-follow-pattern.html>`_
 
         :param name: The name of the auto follow pattern that should pause discovering
             new indices to follow.
@@ -372,7 +396,7 @@ class CcrClient(NamespacedClient):
         Pauses a follower index. The follower index will not fetch any additional operations
         from the leader index.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/ccr-post-pause-follow.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.12/ccr-post-pause-follow.html>`_
 
         :param index: The name of the follower index that should pause following its
             leader index.
@@ -395,13 +419,29 @@ class CcrClient(NamespacedClient):
         )
 
     @_rewrite_parameters(
-        body_fields=True,
+        body_fields=(
+            "remote_cluster",
+            "follow_index_pattern",
+            "leader_index_exclusion_patterns",
+            "leader_index_patterns",
+            "max_outstanding_read_requests",
+            "max_outstanding_write_requests",
+            "max_read_request_operation_count",
+            "max_read_request_size",
+            "max_retry_delay",
+            "max_write_buffer_count",
+            "max_write_buffer_size",
+            "max_write_request_operation_count",
+            "max_write_request_size",
+            "read_poll_timeout",
+            "settings",
+        ),
     )
     def put_auto_follow_pattern(
         self,
         *,
         name: str,
-        remote_cluster: str,
+        remote_cluster: t.Optional[str] = None,
         error_trace: t.Optional[bool] = None,
         filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
         follow_index_pattern: t.Optional[str] = None,
@@ -424,13 +464,14 @@ class CcrClient(NamespacedClient):
             t.Union["t.Literal[-1]", "t.Literal[0]", str]
         ] = None,
         settings: t.Optional[t.Mapping[str, t.Any]] = None,
+        body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
         Creates a new named collection of auto-follow patterns against a specified remote
         cluster. Newly created indices on the remote cluster matching any of the specified
         patterns will be automatically configured as follower indices.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/ccr-put-auto-follow-pattern.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.12/ccr-put-auto-follow-pattern.html>`_
 
         :param name: The name of the collection of auto-follow patterns.
         :param remote_cluster: The remote cluster containing the leader indices to match
@@ -477,53 +518,58 @@ class CcrClient(NamespacedClient):
         """
         if name in SKIP_IN_PATH:
             raise ValueError("Empty value passed for parameter 'name'")
-        if remote_cluster is None:
+        if remote_cluster is None and body is None:
             raise ValueError("Empty value passed for parameter 'remote_cluster'")
         __path = f"/_ccr/auto_follow/{_quote(name)}"
-        __body: t.Dict[str, t.Any] = {}
         __query: t.Dict[str, t.Any] = {}
-        if remote_cluster is not None:
-            __body["remote_cluster"] = remote_cluster
+        __body: t.Dict[str, t.Any] = body if body is not None else {}
         if error_trace is not None:
             __query["error_trace"] = error_trace
         if filter_path is not None:
             __query["filter_path"] = filter_path
-        if follow_index_pattern is not None:
-            __body["follow_index_pattern"] = follow_index_pattern
         if human is not None:
             __query["human"] = human
-        if leader_index_exclusion_patterns is not None:
-            __body["leader_index_exclusion_patterns"] = leader_index_exclusion_patterns
-        if leader_index_patterns is not None:
-            __body["leader_index_patterns"] = leader_index_patterns
-        if max_outstanding_read_requests is not None:
-            __body["max_outstanding_read_requests"] = max_outstanding_read_requests
-        if max_outstanding_write_requests is not None:
-            __body["max_outstanding_write_requests"] = max_outstanding_write_requests
-        if max_read_request_operation_count is not None:
-            __body[
-                "max_read_request_operation_count"
-            ] = max_read_request_operation_count
-        if max_read_request_size is not None:
-            __body["max_read_request_size"] = max_read_request_size
-        if max_retry_delay is not None:
-            __body["max_retry_delay"] = max_retry_delay
-        if max_write_buffer_count is not None:
-            __body["max_write_buffer_count"] = max_write_buffer_count
-        if max_write_buffer_size is not None:
-            __body["max_write_buffer_size"] = max_write_buffer_size
-        if max_write_request_operation_count is not None:
-            __body[
-                "max_write_request_operation_count"
-            ] = max_write_request_operation_count
-        if max_write_request_size is not None:
-            __body["max_write_request_size"] = max_write_request_size
         if pretty is not None:
             __query["pretty"] = pretty
-        if read_poll_timeout is not None:
-            __body["read_poll_timeout"] = read_poll_timeout
-        if settings is not None:
-            __body["settings"] = settings
+        if not __body:
+            if remote_cluster is not None:
+                __body["remote_cluster"] = remote_cluster
+            if follow_index_pattern is not None:
+                __body["follow_index_pattern"] = follow_index_pattern
+            if leader_index_exclusion_patterns is not None:
+                __body[
+                    "leader_index_exclusion_patterns"
+                ] = leader_index_exclusion_patterns
+            if leader_index_patterns is not None:
+                __body["leader_index_patterns"] = leader_index_patterns
+            if max_outstanding_read_requests is not None:
+                __body["max_outstanding_read_requests"] = max_outstanding_read_requests
+            if max_outstanding_write_requests is not None:
+                __body[
+                    "max_outstanding_write_requests"
+                ] = max_outstanding_write_requests
+            if max_read_request_operation_count is not None:
+                __body[
+                    "max_read_request_operation_count"
+                ] = max_read_request_operation_count
+            if max_read_request_size is not None:
+                __body["max_read_request_size"] = max_read_request_size
+            if max_retry_delay is not None:
+                __body["max_retry_delay"] = max_retry_delay
+            if max_write_buffer_count is not None:
+                __body["max_write_buffer_count"] = max_write_buffer_count
+            if max_write_buffer_size is not None:
+                __body["max_write_buffer_size"] = max_write_buffer_size
+            if max_write_request_operation_count is not None:
+                __body[
+                    "max_write_request_operation_count"
+                ] = max_write_request_operation_count
+            if max_write_request_size is not None:
+                __body["max_write_request_size"] = max_write_request_size
+            if read_poll_timeout is not None:
+                __body["read_poll_timeout"] = read_poll_timeout
+            if settings is not None:
+                __body["settings"] = settings
         __headers = {"accept": "application/json", "content-type": "application/json"}
         return self.perform_request(  # type: ignore[return-value]
             "PUT", __path, params=__query, headers=__headers, body=__body
@@ -542,7 +588,7 @@ class CcrClient(NamespacedClient):
         """
         Resumes an auto-follow pattern that has been paused
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/ccr-resume-auto-follow-pattern.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.12/ccr-resume-auto-follow-pattern.html>`_
 
         :param name: The name of the auto follow pattern to resume discovering new indices
             to follow.
@@ -565,7 +611,18 @@ class CcrClient(NamespacedClient):
         )
 
     @_rewrite_parameters(
-        body_fields=True,
+        body_fields=(
+            "max_outstanding_read_requests",
+            "max_outstanding_write_requests",
+            "max_read_request_operation_count",
+            "max_read_request_size",
+            "max_retry_delay",
+            "max_write_buffer_count",
+            "max_write_buffer_size",
+            "max_write_request_operation_count",
+            "max_write_request_size",
+            "read_poll_timeout",
+        ),
     )
     def resume_follow(
         self,
@@ -589,11 +646,12 @@ class CcrClient(NamespacedClient):
         read_poll_timeout: t.Optional[
             t.Union["t.Literal[-1]", "t.Literal[0]", str]
         ] = None,
+        body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
         Resumes a follower index that has been paused
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/ccr-post-resume-follow.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.12/ccr-post-resume-follow.html>`_
 
         :param index: The name of the follow index to resume following.
         :param max_outstanding_read_requests:
@@ -611,39 +669,42 @@ class CcrClient(NamespacedClient):
             raise ValueError("Empty value passed for parameter 'index'")
         __path = f"/{_quote(index)}/_ccr/resume_follow"
         __query: t.Dict[str, t.Any] = {}
-        __body: t.Dict[str, t.Any] = {}
+        __body: t.Dict[str, t.Any] = body if body is not None else {}
         if error_trace is not None:
             __query["error_trace"] = error_trace
         if filter_path is not None:
             __query["filter_path"] = filter_path
         if human is not None:
             __query["human"] = human
-        if max_outstanding_read_requests is not None:
-            __body["max_outstanding_read_requests"] = max_outstanding_read_requests
-        if max_outstanding_write_requests is not None:
-            __body["max_outstanding_write_requests"] = max_outstanding_write_requests
-        if max_read_request_operation_count is not None:
-            __body[
-                "max_read_request_operation_count"
-            ] = max_read_request_operation_count
-        if max_read_request_size is not None:
-            __body["max_read_request_size"] = max_read_request_size
-        if max_retry_delay is not None:
-            __body["max_retry_delay"] = max_retry_delay
-        if max_write_buffer_count is not None:
-            __body["max_write_buffer_count"] = max_write_buffer_count
-        if max_write_buffer_size is not None:
-            __body["max_write_buffer_size"] = max_write_buffer_size
-        if max_write_request_operation_count is not None:
-            __body[
-                "max_write_request_operation_count"
-            ] = max_write_request_operation_count
-        if max_write_request_size is not None:
-            __body["max_write_request_size"] = max_write_request_size
         if pretty is not None:
             __query["pretty"] = pretty
-        if read_poll_timeout is not None:
-            __body["read_poll_timeout"] = read_poll_timeout
+        if not __body:
+            if max_outstanding_read_requests is not None:
+                __body["max_outstanding_read_requests"] = max_outstanding_read_requests
+            if max_outstanding_write_requests is not None:
+                __body[
+                    "max_outstanding_write_requests"
+                ] = max_outstanding_write_requests
+            if max_read_request_operation_count is not None:
+                __body[
+                    "max_read_request_operation_count"
+                ] = max_read_request_operation_count
+            if max_read_request_size is not None:
+                __body["max_read_request_size"] = max_read_request_size
+            if max_retry_delay is not None:
+                __body["max_retry_delay"] = max_retry_delay
+            if max_write_buffer_count is not None:
+                __body["max_write_buffer_count"] = max_write_buffer_count
+            if max_write_buffer_size is not None:
+                __body["max_write_buffer_size"] = max_write_buffer_size
+            if max_write_request_operation_count is not None:
+                __body[
+                    "max_write_request_operation_count"
+                ] = max_write_request_operation_count
+            if max_write_request_size is not None:
+                __body["max_write_request_size"] = max_write_request_size
+            if read_poll_timeout is not None:
+                __body["read_poll_timeout"] = read_poll_timeout
         if not __body:
             __body = None  # type: ignore[assignment]
         __headers = {"accept": "application/json"}
@@ -665,7 +726,7 @@ class CcrClient(NamespacedClient):
         """
         Gets all stats related to cross-cluster replication.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/ccr-get-stats.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.12/ccr-get-stats.html>`_
         """
         __path = "/_ccr/stats"
         __query: t.Dict[str, t.Any] = {}
@@ -696,7 +757,7 @@ class CcrClient(NamespacedClient):
         Stops the following task associated with a follower index and removes index metadata
         and settings associated with cross-cluster replication.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.11/ccr-post-unfollow.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.12/ccr-post-unfollow.html>`_
 
         :param index: The name of the follower index that should be turned into a regular
             index.