Auto-generated API code

Author: elasticmachine

elasticsearch_serverless/_async/client/esql.py

@@ -42,7 +42,7 @@ async def close_job(
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Close anomaly detection jobs A job can be opened and closed multiple times throughout
+        Close anomaly detection jobs. A job can be opened and closed multiple times throughout
         its lifecycle. A closed job cannot receive data or perform analysis operations,
         but you can still explore and navigate results. When you close a job, it runs
         housekeeping tasks such as pruning the model history, flushing buffers, calculating
@@ -393,7 +393,7 @@ async def delete_job(
         wait_for_completion: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Deletes an anomaly detection job. All job configuration, model state and results
+        Delete an anomaly detection job. All job configuration, model state and results
         are deleted. It is not currently possible to delete multiple jobs using wildcards
         or a comma separated list. If you delete a job that has a datafeed, the request
         first tries to delete the datafeed. This behavior is equivalent to calling the
@@ -1665,12 +1665,12 @@ async def open_job(
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Opens one or more anomaly detection jobs. An anomaly detection job must be opened
-        in order for it to be ready to receive and analyze data. It can be opened and
-        closed multiple times throughout its lifecycle. When you open a new job, it starts
-        with an empty model. When you open an existing job, the most recent model state
-        is automatically loaded. The job is ready to resume its analysis from where it
-        left off, once new data is received.
+        Open anomaly detection jobs. An anomaly detection job must be opened in order
+        for it to be ready to receive and analyze data. It can be opened and closed multiple
+        times throughout its lifecycle. When you open a new job, it starts with an empty
+        model. When you open an existing job, the most recent model state is automatically
+        loaded. The job is ready to resume its analysis from where it left off, once
+        new data is received.
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/master/ml-open-job.html>`_
 
@@ -2471,8 +2471,8 @@ async def put_job(
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Instantiates an anomaly detection job. If you include a `datafeed_config`, you
-        must have read index privileges on the source index.
+        Create an anomaly detection job. If you include a `datafeed_config`, you must
+        have read index privileges on the source index.
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/master/ml-put-job.html>`_
 

elasticsearch_serverless/_async/client/ml.py

@@ -251,20 +251,23 @@ async def list_rulesets(
         )
 
     @_rewrite_parameters(
-        body_fields=("actions", "criteria", "type"),
+        body_fields=("actions", "criteria", "type", "priority"),
     )
     async def put_rule(
         self,
         *,
         ruleset_id: str,
         rule_id: str,
         actions: t.Optional[t.Mapping[str, t.Any]] = None,
-        criteria: t.Optional[t.Sequence[t.Mapping[str, t.Any]]] = None,
+        criteria: t.Optional[
+            t.Union[t.Mapping[str, t.Any], t.Sequence[t.Mapping[str, t.Any]]]
+        ] = None,
         type: t.Optional[t.Union["t.Literal['pinned']", str]] = None,
         error_trace: t.Optional[bool] = None,
         filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
         human: t.Optional[bool] = None,
         pretty: t.Optional[bool] = None,
+        priority: t.Optional[int] = None,
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
@@ -279,6 +282,7 @@ async def put_rule(
         :param actions:
         :param criteria:
         :param type:
+        :param priority:
         """
         if ruleset_id in SKIP_IN_PATH:
             raise ValueError("Empty value passed for parameter 'ruleset_id'")
@@ -312,6 +316,8 @@ async def put_rule(
                 __body["criteria"] = criteria
             if type is not None:
                 __body["type"] = type
+            if priority is not None:
+                __body["priority"] = priority
         __headers = {"accept": "application/json", "content-type": "application/json"}
         return await self.perform_request(  # type: ignore[return-value]
             "PUT",
@@ -330,7 +336,9 @@ async def put_ruleset(
         self,
         *,
         ruleset_id: str,
-        rules: t.Optional[t.Sequence[t.Mapping[str, t.Any]]] = None,
+        rules: t.Optional[
+            t.Union[t.Mapping[str, t.Any], t.Sequence[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,

elasticsearch_serverless/_async/client/query_rules.py

@@ -241,7 +241,7 @@ async def has_privileges(
         cluster: t.Optional[
             t.Sequence[
                 t.Union[
-                    "t.Literal['all', 'cancel_task', 'create_snapshot', 'cross_cluster_replication', 'cross_cluster_search', 'delegate_pki', 'grant_api_key', 'manage', 'manage_api_key', 'manage_autoscaling', 'manage_behavioral_analytics', 'manage_ccr', 'manage_data_frame_transforms', 'manage_data_stream_global_retention', 'manage_enrich', 'manage_ilm', 'manage_index_templates', 'manage_inference', 'manage_ingest_pipelines', 'manage_logstash_pipelines', 'manage_ml', 'manage_oidc', 'manage_own_api_key', 'manage_pipeline', 'manage_rollup', 'manage_saml', 'manage_search_application', 'manage_search_query_rules', 'manage_search_synonyms', 'manage_security', 'manage_service_account', 'manage_slm', 'manage_token', 'manage_transform', 'manage_user_profile', 'manage_watcher', 'monitor', 'monitor_data_frame_transforms', 'monitor_data_stream_global_retention', 'monitor_enrich', 'monitor_inference', 'monitor_ml', 'monitor_rollup', 'monitor_snapshot', 'monitor_text_structure', 'monitor_transform', 'monitor_watcher', 'none', 'post_behavioral_analytics_event', 'read_ccr', 'read_connector_secrets', 'read_fleet_secrets', 'read_ilm', 'read_pipeline', 'read_security', 'read_slm', 'transport_client', 'write_connector_secrets', 'write_fleet_secrets']",
+                    "t.Literal['all', 'cancel_task', 'create_snapshot', 'cross_cluster_replication', 'cross_cluster_search', 'delegate_pki', 'grant_api_key', 'manage', 'manage_api_key', 'manage_autoscaling', 'manage_behavioral_analytics', 'manage_ccr', 'manage_data_frame_transforms', 'manage_data_stream_global_retention', 'manage_enrich', 'manage_ilm', 'manage_index_templates', 'manage_inference', 'manage_ingest_pipelines', 'manage_logstash_pipelines', 'manage_ml', 'manage_oidc', 'manage_own_api_key', 'manage_pipeline', 'manage_rollup', 'manage_saml', 'manage_search_application', 'manage_search_query_rules', 'manage_search_synonyms', 'manage_security', 'manage_service_account', 'manage_slm', 'manage_token', 'manage_transform', 'manage_user_profile', 'manage_watcher', 'monitor', 'monitor_data_frame_transforms', 'monitor_data_stream_global_retention', 'monitor_enrich', 'monitor_inference', 'monitor_ml', 'monitor_rollup', 'monitor_snapshot', 'monitor_text_structure', 'monitor_transform', 'monitor_watcher', 'none', 'post_behavioral_analytics_event', 'read_ccr', 'read_fleet_secrets', 'read_ilm', 'read_pipeline', 'read_security', 'read_slm', 'transport_client', 'write_connector_secrets', 'write_fleet_secrets']",
                     str,
                 ]
             ]

elasticsearch_serverless/_async/client/security.py

@@ -42,7 +42,7 @@ def close_job(
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Close anomaly detection jobs A job can be opened and closed multiple times throughout
+        Close anomaly detection jobs. A job can be opened and closed multiple times throughout
         its lifecycle. A closed job cannot receive data or perform analysis operations,
         but you can still explore and navigate results. When you close a job, it runs
         housekeeping tasks such as pruning the model history, flushing buffers, calculating
@@ -393,7 +393,7 @@ def delete_job(
         wait_for_completion: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Deletes an anomaly detection job. All job configuration, model state and results
+        Delete an anomaly detection job. All job configuration, model state and results
         are deleted. It is not currently possible to delete multiple jobs using wildcards
         or a comma separated list. If you delete a job that has a datafeed, the request
         first tries to delete the datafeed. This behavior is equivalent to calling the
@@ -1665,12 +1665,12 @@ def open_job(
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Opens one or more anomaly detection jobs. An anomaly detection job must be opened
-        in order for it to be ready to receive and analyze data. It can be opened and
-        closed multiple times throughout its lifecycle. When you open a new job, it starts
-        with an empty model. When you open an existing job, the most recent model state
-        is automatically loaded. The job is ready to resume its analysis from where it
-        left off, once new data is received.
+        Open anomaly detection jobs. An anomaly detection job must be opened in order
+        for it to be ready to receive and analyze data. It can be opened and closed multiple
+        times throughout its lifecycle. When you open a new job, it starts with an empty
+        model. When you open an existing job, the most recent model state is automatically
+        loaded. The job is ready to resume its analysis from where it left off, once
+        new data is received.
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/master/ml-open-job.html>`_
 
@@ -2471,8 +2471,8 @@ def put_job(
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Instantiates an anomaly detection job. If you include a `datafeed_config`, you
-        must have read index privileges on the source index.
+        Create an anomaly detection job. If you include a `datafeed_config`, you must
+        have read index privileges on the source index.
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/master/ml-put-job.html>`_
 

elasticsearch_serverless/_sync/client/ml.py

@@ -251,20 +251,23 @@ def list_rulesets(
         )
 
     @_rewrite_parameters(
-        body_fields=("actions", "criteria", "type"),
+        body_fields=("actions", "criteria", "type", "priority"),
     )
     def put_rule(
         self,
         *,
         ruleset_id: str,
         rule_id: str,
         actions: t.Optional[t.Mapping[str, t.Any]] = None,
-        criteria: t.Optional[t.Sequence[t.Mapping[str, t.Any]]] = None,
+        criteria: t.Optional[
+            t.Union[t.Mapping[str, t.Any], t.Sequence[t.Mapping[str, t.Any]]]
+        ] = None,
         type: t.Optional[t.Union["t.Literal['pinned']", str]] = None,
         error_trace: t.Optional[bool] = None,
         filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
         human: t.Optional[bool] = None,
         pretty: t.Optional[bool] = None,
+        priority: t.Optional[int] = None,
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
@@ -279,6 +282,7 @@ def put_rule(
         :param actions:
         :param criteria:
         :param type:
+        :param priority:
         """
         if ruleset_id in SKIP_IN_PATH:
             raise ValueError("Empty value passed for parameter 'ruleset_id'")
@@ -312,6 +316,8 @@ def put_rule(
                 __body["criteria"] = criteria
             if type is not None:
                 __body["type"] = type
+            if priority is not None:
+                __body["priority"] = priority
         __headers = {"accept": "application/json", "content-type": "application/json"}
         return self.perform_request(  # type: ignore[return-value]
             "PUT",
@@ -330,7 +336,9 @@ def put_ruleset(
         self,
         *,
         ruleset_id: str,
-        rules: t.Optional[t.Sequence[t.Mapping[str, t.Any]]] = None,
+        rules: t.Optional[
+            t.Union[t.Mapping[str, t.Any], t.Sequence[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,

elasticsearch_serverless/_sync/client/query_rules.py

@@ -241,7 +241,7 @@ def has_privileges(
         cluster: t.Optional[
             t.Sequence[
                 t.Union[
-                    "t.Literal['all', 'cancel_task', 'create_snapshot', 'cross_cluster_replication', 'cross_cluster_search', 'delegate_pki', 'grant_api_key', 'manage', 'manage_api_key', 'manage_autoscaling', 'manage_behavioral_analytics', 'manage_ccr', 'manage_data_frame_transforms', 'manage_data_stream_global_retention', 'manage_enrich', 'manage_ilm', 'manage_index_templates', 'manage_inference', 'manage_ingest_pipelines', 'manage_logstash_pipelines', 'manage_ml', 'manage_oidc', 'manage_own_api_key', 'manage_pipeline', 'manage_rollup', 'manage_saml', 'manage_search_application', 'manage_search_query_rules', 'manage_search_synonyms', 'manage_security', 'manage_service_account', 'manage_slm', 'manage_token', 'manage_transform', 'manage_user_profile', 'manage_watcher', 'monitor', 'monitor_data_frame_transforms', 'monitor_data_stream_global_retention', 'monitor_enrich', 'monitor_inference', 'monitor_ml', 'monitor_rollup', 'monitor_snapshot', 'monitor_text_structure', 'monitor_transform', 'monitor_watcher', 'none', 'post_behavioral_analytics_event', 'read_ccr', 'read_connector_secrets', 'read_fleet_secrets', 'read_ilm', 'read_pipeline', 'read_security', 'read_slm', 'transport_client', 'write_connector_secrets', 'write_fleet_secrets']",
+                    "t.Literal['all', 'cancel_task', 'create_snapshot', 'cross_cluster_replication', 'cross_cluster_search', 'delegate_pki', 'grant_api_key', 'manage', 'manage_api_key', 'manage_autoscaling', 'manage_behavioral_analytics', 'manage_ccr', 'manage_data_frame_transforms', 'manage_data_stream_global_retention', 'manage_enrich', 'manage_ilm', 'manage_index_templates', 'manage_inference', 'manage_ingest_pipelines', 'manage_logstash_pipelines', 'manage_ml', 'manage_oidc', 'manage_own_api_key', 'manage_pipeline', 'manage_rollup', 'manage_saml', 'manage_search_application', 'manage_search_query_rules', 'manage_search_synonyms', 'manage_security', 'manage_service_account', 'manage_slm', 'manage_token', 'manage_transform', 'manage_user_profile', 'manage_watcher', 'monitor', 'monitor_data_frame_transforms', 'monitor_data_stream_global_retention', 'monitor_enrich', 'monitor_inference', 'monitor_ml', 'monitor_rollup', 'monitor_snapshot', 'monitor_text_structure', 'monitor_transform', 'monitor_watcher', 'none', 'post_behavioral_analytics_event', 'read_ccr', 'read_fleet_secrets', 'read_ilm', 'read_pipeline', 'read_security', 'read_slm', 'transport_client', 'write_connector_secrets', 'write_fleet_secrets']",
                     str,
                 ]
             ]