Auto-generated API code

Author: elasticmachine

elasticsearch/_async/client/ilm.py

@@ -363,7 +363,7 @@ async def move_to_step(
     async def put_lifecycle(
         self,
         *,
-        name: str,
+        name: 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,
@@ -388,8 +388,6 @@ async def put_lifecycle(
         :param timeout: Period to wait for a response. If no response is received before
             the timeout expires, the request fails and returns an error.
         """
-        if name in SKIP_IN_PATH:
-            raise ValueError("Empty value passed for parameter 'name'")
         __path_parts: t.Dict[str, str] = {"policy": _quote(name)}
         __path = f'/_ilm/policy/{__path_parts["policy"]}'
         __query: t.Dict[str, t.Any] = {}

elasticsearch/_async/client/indices.py

@@ -4004,91 +4004,37 @@ async def shrink(
             path_parts=__path_parts,
         )
 
-    @_rewrite_parameters(
-        body_fields=(
-            "allow_auto_create",
-            "composed_of",
-            "data_stream",
-            "index_patterns",
-            "meta",
-            "priority",
-            "template",
-            "version",
-        ),
-        parameter_aliases={"_meta": "meta"},
-    )
+    @_rewrite_parameters()
     async def simulate_index_template(
         self,
         *,
         name: str,
-        allow_auto_create: t.Optional[bool] = None,
-        composed_of: t.Optional[t.Sequence[str]] = None,
-        create: t.Optional[bool] = None,
-        data_stream: t.Optional[t.Mapping[str, t.Any]] = None,
         error_trace: t.Optional[bool] = None,
         filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
         human: t.Optional[bool] = None,
         include_defaults: t.Optional[bool] = None,
-        index_patterns: t.Optional[t.Union[str, t.Sequence[str]]] = None,
         master_timeout: t.Optional[
             t.Union["t.Literal[-1]", "t.Literal[0]", str]
         ] = None,
-        meta: t.Optional[t.Mapping[str, t.Any]] = None,
         pretty: t.Optional[bool] = None,
-        priority: t.Optional[int] = None,
-        template: t.Optional[t.Mapping[str, t.Any]] = None,
-        version: t.Optional[int] = None,
-        body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
         Simulate matching the given index name against the index templates in the system
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-simulate-index.html>`_
 
-        :param name: Index or template name to simulate
-        :param allow_auto_create: This setting overrides the value of the `action.auto_create_index`
-            cluster setting. If set to `true` in a template, then indices can be automatically
-            created using that template even if auto-creation of indices is disabled
-            via `actions.auto_create_index`. If set to `false`, then indices or data
-            streams matching the template must always be explicitly created, and may
-            never be automatically created.
-        :param composed_of: An ordered list of component template names. Component templates
-            are merged in the order specified, meaning that the last component template
-            specified has the highest precedence.
-        :param create: If `true`, the template passed in the body is only used if no
-            existing templates match the same index patterns. If `false`, the simulation
-            uses the template with the highest priority. Note that the template is not
-            permanently added or updated in either case; it is only used for the simulation.
-        :param data_stream: If this object is included, the template is used to create
-            data streams and their backing indices. Supports an empty object. Data streams
-            require a matching index template with a `data_stream` object.
+        :param name: Name of the index to simulate
         :param include_defaults: If true, returns all relevant default configurations
             for the index template.
-        :param index_patterns: Array of wildcard (`*`) expressions used to match the
-            names of data streams and indices during creation.
         :param master_timeout: Period to wait for a connection to the master node. If
             no response is received before the timeout expires, the request fails and
             returns an error.
-        :param meta: Optional user metadata about the index template. May have any contents.
-            This map is not automatically generated by Elasticsearch.
-        :param priority: Priority to determine index template precedence when a new data
-            stream or index is created. The index template with the highest priority
-            is chosen. If no priority is specified the template is treated as though
-            it is of priority 0 (lowest priority). This number is not automatically generated
-            by Elasticsearch.
-        :param template: Template to be applied. It may optionally include an `aliases`,
-            `mappings`, or `settings` configuration.
-        :param version: Version number used to manage index templates externally. This
-            number is not automatically generated by Elasticsearch.
         """
         if name in SKIP_IN_PATH:
             raise ValueError("Empty value passed for parameter 'name'")
         __path_parts: t.Dict[str, str] = {"name": _quote(name)}
         __path = f'/_index_template/_simulate_index/{__path_parts["name"]}'
         __query: t.Dict[str, t.Any] = {}
-        __body: t.Dict[str, t.Any] = body if body is not None else {}
-        if create is not None:
-            __query["create"] = create
         if error_trace is not None:
             __query["error_trace"] = error_trace
         if filter_path is not None:
@@ -4101,56 +4047,53 @@ async def simulate_index_template(
             __query["master_timeout"] = master_timeout
         if pretty is not None:
             __query["pretty"] = pretty
-        if not __body:
-            if allow_auto_create is not None:
-                __body["allow_auto_create"] = allow_auto_create
-            if composed_of is not None:
-                __body["composed_of"] = composed_of
-            if data_stream is not None:
-                __body["data_stream"] = data_stream
-            if index_patterns is not None:
-                __body["index_patterns"] = index_patterns
-            if meta is not None:
-                __body["_meta"] = meta
-            if priority is not None:
-                __body["priority"] = priority
-            if template is not None:
-                __body["template"] = template
-            if version is not None:
-                __body["version"] = version
-        if not __body:
-            __body = None  # type: ignore[assignment]
         __headers = {"accept": "application/json"}
-        if __body is not None:
-            __headers["content-type"] = "application/json"
         return await self.perform_request(  # type: ignore[return-value]
             "POST",
             __path,
             params=__query,
             headers=__headers,
-            body=__body,
             endpoint_id="indices.simulate_index_template",
             path_parts=__path_parts,
         )
 
     @_rewrite_parameters(
-        body_name="template",
+        body_fields=(
+            "allow_auto_create",
+            "composed_of",
+            "data_stream",
+            "ignore_missing_component_templates",
+            "index_patterns",
+            "meta",
+            "priority",
+            "template",
+            "version",
+        ),
+        parameter_aliases={"_meta": "meta"},
     )
     async def simulate_template(
         self,
         *,
         name: t.Optional[str] = None,
+        allow_auto_create: t.Optional[bool] = None,
+        composed_of: t.Optional[t.Sequence[str]] = None,
         create: t.Optional[bool] = None,
+        data_stream: t.Optional[t.Mapping[str, t.Any]] = None,
         error_trace: t.Optional[bool] = None,
         filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
         human: t.Optional[bool] = None,
+        ignore_missing_component_templates: t.Optional[t.Sequence[str]] = None,
         include_defaults: t.Optional[bool] = None,
+        index_patterns: t.Optional[t.Union[str, t.Sequence[str]]] = None,
         master_timeout: t.Optional[
             t.Union["t.Literal[-1]", "t.Literal[0]", str]
         ] = None,
+        meta: t.Optional[t.Mapping[str, t.Any]] = None,
         pretty: t.Optional[bool] = None,
+        priority: t.Optional[int] = None,
         template: t.Optional[t.Mapping[str, t.Any]] = None,
-        body: t.Optional[t.Mapping[str, t.Any]] = None,
+        version: t.Optional[int] = None,
+        body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
         Simulate resolving the given template name or body
@@ -4160,23 +4103,44 @@ async def simulate_template(
         :param name: Name of the index template to simulate. To test a template configuration
             before you add it to the cluster, omit this parameter and specify the template
             configuration in the request body.
+        :param allow_auto_create: This setting overrides the value of the `action.auto_create_index`
+            cluster setting. If set to `true` in a template, then indices can be automatically
+            created using that template even if auto-creation of indices is disabled
+            via `actions.auto_create_index`. If set to `false`, then indices or data
+            streams matching the template must always be explicitly created, and may
+            never be automatically created.
+        :param composed_of: An ordered list of component template names. Component templates
+            are merged in the order specified, meaning that the last component template
+            specified has the highest precedence.
         :param create: If true, the template passed in the body is only used if no existing
             templates match the same index patterns. If false, the simulation uses the
             template with the highest priority. Note that the template is not permanently
             added or updated in either case; it is only used for the simulation.
+        :param data_stream: If this object is included, the template is used to create
+            data streams and their backing indices. Supports an empty object. Data streams
+            require a matching index template with a `data_stream` object.
+        :param ignore_missing_component_templates: The configuration option ignore_missing_component_templates
+            can be used when an index template references a component template that might
+            not exist
         :param include_defaults: If true, returns all relevant default configurations
             for the index template.
+        :param index_patterns: Array of wildcard (`*`) expressions used to match the
+            names of data streams and indices during creation.
         :param master_timeout: Period to wait for a connection to the master node. If
             no response is received before the timeout expires, the request fails and
             returns an error.
-        :param template:
+        :param meta: Optional user metadata about the index template. May have any contents.
+            This map is not automatically generated by Elasticsearch.
+        :param priority: Priority to determine index template precedence when a new data
+            stream or index is created. The index template with the highest priority
+            is chosen. If no priority is specified the template is treated as though
+            it is of priority 0 (lowest priority). This number is not automatically generated
+            by Elasticsearch.
+        :param template: Template to be applied. It may optionally include an `aliases`,
+            `mappings`, or `settings` configuration.
+        :param version: Version number used to manage index templates externally. This
+            number is not automatically generated by Elasticsearch.
         """
-        if template is None and body is None:
-            raise ValueError(
-                "Empty value passed for parameters 'template' and 'body', one of them should be set."
-            )
-        elif template is not None and body is not None:
-            raise ValueError("Cannot set both 'template' and 'body'")
         __path_parts: t.Dict[str, str]
         if name not in SKIP_IN_PATH:
             __path_parts = {"name": _quote(name)}
@@ -4185,6 +4149,7 @@ async def simulate_template(
             __path_parts = {}
             __path = "/_index_template/_simulate"
         __query: t.Dict[str, t.Any] = {}
+        __body: t.Dict[str, t.Any] = body if body is not None else {}
         if create is not None:
             __query["create"] = create
         if error_trace is not None:
@@ -4199,9 +4164,29 @@ async def simulate_template(
             __query["master_timeout"] = master_timeout
         if pretty is not None:
             __query["pretty"] = pretty
-        __body = template if template is not None else body
         if not __body:
-            __body = None
+            if allow_auto_create is not None:
+                __body["allow_auto_create"] = allow_auto_create
+            if composed_of is not None:
+                __body["composed_of"] = composed_of
+            if data_stream is not None:
+                __body["data_stream"] = data_stream
+            if ignore_missing_component_templates is not None:
+                __body["ignore_missing_component_templates"] = (
+                    ignore_missing_component_templates
+                )
+            if index_patterns is not None:
+                __body["index_patterns"] = index_patterns
+            if meta is not None:
+                __body["_meta"] = meta
+            if priority is not None:
+                __body["priority"] = priority
+            if template is not None:
+                __body["template"] = template
+            if version is not None:
+                __body["version"] = version
+        if not __body:
+            __body = None  # type: ignore[assignment]
         __headers = {"accept": "application/json"}
         if __body is not None:
             __headers["content-type"] = "application/json"

elasticsearch/_sync/client/ilm.py

@@ -363,7 +363,7 @@ def move_to_step(
     def put_lifecycle(
         self,
         *,
-        name: str,
+        name: 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,
@@ -388,8 +388,6 @@ def put_lifecycle(
         :param timeout: Period to wait for a response. If no response is received before
             the timeout expires, the request fails and returns an error.
         """
-        if name in SKIP_IN_PATH:
-            raise ValueError("Empty value passed for parameter 'name'")
         __path_parts: t.Dict[str, str] = {"policy": _quote(name)}
         __path = f'/_ilm/policy/{__path_parts["policy"]}'
         __query: t.Dict[str, t.Any] = {}