elasticsearch-api 7.13.3 → 8.14.0

data/lib/elasticsearch/api/actions/machine_learning/put_trained_model_alias.rb

@@ -0,0 +1,65 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
+# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
+#
+module Elasticsearch
+  module API
+    module MachineLearning
+      module Actions
+        # Creates a new model alias (or reassigns an existing one) to refer to the trained model
+        #
+        # @option arguments [String] :model_alias The trained model alias to update
+        # @option arguments [String] :model_id The trained model where the model alias should be assigned
+        # @option arguments [Boolean] :reassign If the model_alias already exists and points to a separate model_id, this parameter must be true. Defaults to false.
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.14/put-trained-models-aliases.html
+        #
+        def put_trained_model_alias(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'ml.put_trained_model_alias' }
+
+          defined_params = %i[model_id model_alias].each_with_object({}) do |variable, set_variables|
+            set_variables[variable] = arguments[variable] if arguments.key?(variable)
+          end
+          request_opts[:defined_params] = defined_params unless defined_params.empty?
+
+          raise ArgumentError, "Required argument 'model_id' missing" unless arguments[:model_id]
+          raise ArgumentError, "Required argument 'model_alias' missing" unless arguments[:model_alias]
+
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          _model_alias = arguments.delete(:model_alias)
+
+          _model_id = arguments.delete(:model_id)
+
+          method = Elasticsearch::API::HTTP_PUT
+          path   = "_ml/trained_models/#{Utils.__listify(_model_id)}/model_aliases/#{Utils.__listify(_model_alias)}"
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers, request_opts)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/machine_learning/put_trained_model_definition_part.rb

@@ -0,0 +1,66 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
+# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
+#
+module Elasticsearch
+  module API
+    module MachineLearning
+      module Actions
+        # Creates part of a trained model definition
+        #
+        # @option arguments [String] :model_id The ID of the trained model for this definition part
+        # @option arguments [Integer] :part The part number
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body The trained model definition part (*Required*)
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.14/put-trained-model-definition-part.html
+        #
+        def put_trained_model_definition_part(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'ml.put_trained_model_definition_part' }
+
+          defined_params = %i[model_id part].each_with_object({}) do |variable, set_variables|
+            set_variables[variable] = arguments[variable] if arguments.key?(variable)
+          end
+          request_opts[:defined_params] = defined_params unless defined_params.empty?
+
+          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+          raise ArgumentError, "Required argument 'model_id' missing" unless arguments[:model_id]
+          raise ArgumentError, "Required argument 'part' missing" unless arguments[:part]
+
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body = arguments.delete(:body)
+
+          _model_id = arguments.delete(:model_id)
+
+          _part = arguments.delete(:part)
+
+          method = Elasticsearch::API::HTTP_PUT
+          path   = "_ml/trained_models/#{Utils.__listify(_model_id)}/definition/#{Utils.__listify(_part)}"
+          params = {}
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers, request_opts)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/machine_learning/put_trained_model_vocabulary.rb

@@ -0,0 +1,62 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
+# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
+#
+module Elasticsearch
+  module API
+    module MachineLearning
+      module Actions
+        # Creates a trained model vocabulary
+        #
+        # @option arguments [String] :model_id The ID of the trained model for this vocabulary
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body The trained model vocabulary (*Required*)
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.14/put-trained-model-vocabulary.html
+        #
+        def put_trained_model_vocabulary(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'ml.put_trained_model_vocabulary' }
+
+          defined_params = [:model_id].each_with_object({}) do |variable, set_variables|
+            set_variables[variable] = arguments[variable] if arguments.key?(variable)
+          end
+          request_opts[:defined_params] = defined_params unless defined_params.empty?
+
+          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+          raise ArgumentError, "Required argument 'model_id' missing" unless arguments[:model_id]
+
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body = arguments.delete(:body)
+
+          _model_id = arguments.delete(:model_id)
+
+          method = Elasticsearch::API::HTTP_PUT
+          path   = "_ml/trained_models/#{Utils.__listify(_model_id)}/vocabulary"
+          params = {}
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers, request_opts)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/machine_learning/reset_job.rb

@@ -0,0 +1,62 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
+# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
+#
+module Elasticsearch
+  module API
+    module MachineLearning
+      module Actions
+        # Resets an existing anomaly detection job.
+        #
+        # @option arguments [String] :job_id The ID of the job to reset
+        # @option arguments [Boolean] :wait_for_completion Should this request wait until the operation has completed before returning
+        # @option arguments [Boolean] :delete_user_annotations Should annotations added by the user be deleted
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.14/ml-reset-job.html
+        #
+        def reset_job(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'ml.reset_job' }
+
+          defined_params = [:job_id].each_with_object({}) do |variable, set_variables|
+            set_variables[variable] = arguments[variable] if arguments.key?(variable)
+          end
+          request_opts[:defined_params] = defined_params unless defined_params.empty?
+
+          raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]
+
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          _job_id = arguments.delete(:job_id)
+
+          method = Elasticsearch::API::HTTP_POST
+          path   = "_ml/anomaly_detectors/#{Utils.__listify(_job_id)}/_reset"
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers, request_opts)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/machine_learning/revert_model_snapshot.rb

@@ -0,0 +1,66 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
+# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
+#
+module Elasticsearch
+  module API
+    module MachineLearning
+      module Actions
+        # Reverts to a specific snapshot.
+        #
+        # @option arguments [String] :job_id The ID of the job to fetch
+        # @option arguments [String] :snapshot_id The ID of the snapshot to revert to
+        # @option arguments [Boolean] :delete_intervening_results Should we reset the results back to the time of the snapshot?
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body Reversion options
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.14/ml-revert-snapshot.html
+        #
+        def revert_model_snapshot(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'ml.revert_model_snapshot' }
+
+          defined_params = %i[job_id snapshot_id].each_with_object({}) do |variable, set_variables|
+            set_variables[variable] = arguments[variable] if arguments.key?(variable)
+          end
+          request_opts[:defined_params] = defined_params unless defined_params.empty?
+
+          raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]
+          raise ArgumentError, "Required argument 'snapshot_id' missing" unless arguments[:snapshot_id]
+
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body = arguments.delete(:body)
+
+          _job_id = arguments.delete(:job_id)
+
+          _snapshot_id = arguments.delete(:snapshot_id)
+
+          method = Elasticsearch::API::HTTP_POST
+          path   = "_ml/anomaly_detectors/#{Utils.__listify(_job_id)}/model_snapshots/#{Utils.__listify(_snapshot_id)}/_revert"
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers, request_opts)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/machine_learning/set_upgrade_mode.rb

@@ -0,0 +1,52 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
+# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
+#
+module Elasticsearch
+  module API
+    module MachineLearning
+      module Actions
+        # Sets a cluster wide upgrade_mode setting that prepares machine learning indices for an upgrade.
+        #
+        # @option arguments [Boolean] :enabled Whether to enable upgrade_mode ML setting or not. Defaults to false.
+        # @option arguments [Time] :timeout Controls the time to wait before action times out. Defaults to 30 seconds
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.14/ml-set-upgrade-mode.html
+        #
+        def set_upgrade_mode(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'ml.set_upgrade_mode' }
+
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body   = nil
+
+          method = Elasticsearch::API::HTTP_POST
+          path   = '_ml/set_upgrade_mode'
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers, request_opts)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/machine_learning/start_data_frame_analytics.rb

@@ -0,0 +1,62 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
+# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
+#
+module Elasticsearch
+  module API
+    module MachineLearning
+      module Actions
+        # Starts a data frame analytics job.
+        #
+        # @option arguments [String] :id The ID of the data frame analytics to start
+        # @option arguments [Time] :timeout Controls the time to wait until the task has started. Defaults to 20 seconds
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body The start data frame analytics parameters
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.14/start-dfanalytics.html
+        #
+        def start_data_frame_analytics(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'ml.start_data_frame_analytics' }
+
+          defined_params = [:id].each_with_object({}) do |variable, set_variables|
+            set_variables[variable] = arguments[variable] if arguments.key?(variable)
+          end
+          request_opts[:defined_params] = defined_params unless defined_params.empty?
+
+          raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
+
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body = arguments.delete(:body)
+
+          _id = arguments.delete(:id)
+
+          method = Elasticsearch::API::HTTP_POST
+          path   = "_ml/data_frame/analytics/#{Utils.__listify(_id)}/_start"
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers, request_opts)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/machine_learning/start_datafeed.rb

@@ -0,0 +1,64 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
+# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
+#
+module Elasticsearch
+  module API
+    module MachineLearning
+      module Actions
+        # Starts one or more datafeeds.
+        #
+        # @option arguments [String] :datafeed_id The ID of the datafeed to start
+        # @option arguments [String] :start The start time from where the datafeed should begin
+        # @option arguments [String] :end The end time when the datafeed should stop. When not set, the datafeed continues in real time
+        # @option arguments [Time] :timeout Controls the time to wait until a datafeed has started. Default to 20 seconds
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body The start datafeed parameters
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.14/ml-start-datafeed.html
+        #
+        def start_datafeed(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'ml.start_datafeed' }
+
+          defined_params = [:datafeed_id].each_with_object({}) do |variable, set_variables|
+            set_variables[variable] = arguments[variable] if arguments.key?(variable)
+          end
+          request_opts[:defined_params] = defined_params unless defined_params.empty?
+
+          raise ArgumentError, "Required argument 'datafeed_id' missing" unless arguments[:datafeed_id]
+
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body = arguments.delete(:body)
+
+          _datafeed_id = arguments.delete(:datafeed_id)
+
+          method = Elasticsearch::API::HTTP_POST
+          path   = "_ml/datafeeds/#{Utils.__listify(_datafeed_id)}/_start"
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers, request_opts)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/machine_learning/start_trained_model_deployment.rb

@@ -0,0 +1,68 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
+# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
+#
+module Elasticsearch
+  module API
+    module MachineLearning
+      module Actions
+        # Start a trained model deployment.
+        #
+        # @option arguments [String] :model_id The unique identifier of the trained model. (*Required*)
+        # @option arguments [String] :cache_size A byte-size value for configuring the inference cache size. For example, 20mb.
+        # @option arguments [String] :deployment_id The Id of the new deployment. Defaults to the model_id if not set.
+        # @option arguments [Integer] :number_of_allocations The total number of allocations this model is assigned across machine learning nodes.
+        # @option arguments [Integer] :threads_per_allocation The number of threads used by each model allocation during inference.
+        # @option arguments [String] :priority The deployment priority.
+        # @option arguments [Integer] :queue_capacity Controls how many inference requests are allowed in the queue at a time.
+        # @option arguments [Time] :timeout Controls the amount of time to wait for the model to deploy.
+        # @option arguments [String] :wait_for The allocation status for which to wait (options: starting, started, fully_allocated)
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.14/start-trained-model-deployment.html
+        #
+        def start_trained_model_deployment(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'ml.start_trained_model_deployment' }
+
+          defined_params = [:model_id].each_with_object({}) do |variable, set_variables|
+            set_variables[variable] = arguments[variable] if arguments.key?(variable)
+          end
+          request_opts[:defined_params] = defined_params unless defined_params.empty?
+
+          raise ArgumentError, "Required argument 'model_id' missing" unless arguments[:model_id]
+
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          _model_id = arguments.delete(:model_id)
+
+          method = Elasticsearch::API::HTTP_POST
+          path   = "_ml/trained_models/#{Utils.__listify(_model_id)}/deployment/_start"
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers, request_opts)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/machine_learning/stop_data_frame_analytics.rb

@@ -0,0 +1,64 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
+# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
+#
+module Elasticsearch
+  module API
+    module MachineLearning
+      module Actions
+        # Stops one or more data frame analytics jobs.
+        #
+        # @option arguments [String] :id The ID of the data frame analytics to stop
+        # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no data frame analytics. (This includes `_all` string or when no data frame analytics have been specified)
+        # @option arguments [Boolean] :force True if the data frame analytics should be forcefully stopped
+        # @option arguments [Time] :timeout Controls the time to wait until the task has stopped. Defaults to 20 seconds
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body The stop data frame analytics parameters
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.14/stop-dfanalytics.html
+        #
+        def stop_data_frame_analytics(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'ml.stop_data_frame_analytics' }
+
+          defined_params = [:id].each_with_object({}) do |variable, set_variables|
+            set_variables[variable] = arguments[variable] if arguments.key?(variable)
+          end
+          request_opts[:defined_params] = defined_params unless defined_params.empty?
+
+          raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
+
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body = arguments.delete(:body)
+
+          _id = arguments.delete(:id)
+
+          method = Elasticsearch::API::HTTP_POST
+          path   = "_ml/data_frame/analytics/#{Utils.__listify(_id)}/_stop"
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers, request_opts)
+          )
+        end
+      end
+    end
+  end
+end