elasticsearch-api 7.17.11 → 9.0.2

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

@@ -0,0 +1,80 @@
+# 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.
+#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
+module Elasticsearch
+  module API
+    module MachineLearning
+      module Actions
+        # Delete forecasts from a job.
+        # By default, forecasts are retained for 14 days. You can specify a
+        # different retention period with the +expires_in+ parameter in the forecast
+        # jobs API. The delete forecast API enables you to delete one or more
+        # forecasts before they expire.
+        #
+        # @option arguments [String] :job_id Identifier for the anomaly detection job. (*Required*)
+        # @option arguments [String] :forecast_id A comma-separated list of forecast identifiers. If you do not specify
+        #  this optional parameter or if you specify +_all+ or +*+ the API deletes
+        #  all forecasts from the job.
+        # @option arguments [Boolean] :allow_no_forecasts Specifies whether an error occurs when there are no forecasts. In
+        #  particular, if this parameter is set to +false+ and there are no
+        #  forecasts associated with the job, attempts to delete all forecasts
+        #  return an error. Server default: true.
+        # @option arguments [Time] :timeout Specifies the period of time to wait for the completion of the delete
+        #  operation. When this period of time elapses, the API fails and returns an
+        #  error. Server default: 30s.
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-delete-forecast
+        #
+        def delete_forecast(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'ml.delete_forecast' }
+
+          defined_params = [:job_id, :forecast_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)
+
+          _forecast_id = arguments.delete(:forecast_id)
+
+          method = Elasticsearch::API::HTTP_DELETE
+          path   = if _job_id && _forecast_id
+                     "_ml/anomaly_detectors/#{Utils.listify(_job_id)}/_forecast/#{Utils.listify(_forecast_id)}"
+                   else
+                     "_ml/anomaly_detectors/#{Utils.listify(_job_id)}/_forecast"
+                   end
+          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/delete_job.rb

@@ -0,0 +1,73 @@
+# 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.
+#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
+module Elasticsearch
+  module API
+    module MachineLearning
+      module Actions
+        # 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 delete datafeed API with the same timeout and force parameters as the
+        # delete job request.
+        #
+        # @option arguments [String] :job_id Identifier for the anomaly detection job. (*Required*)
+        # @option arguments [Boolean] :force Use to forcefully delete an opened job; this method is quicker than
+        #  closing and deleting the job.
+        # @option arguments [Boolean] :delete_user_annotations Specifies whether annotations that have been added by the
+        #  user should be deleted along with any auto-generated annotations when the job is
+        #  reset.
+        # @option arguments [Boolean] :wait_for_completion Specifies whether the request should return immediately or wait until the
+        #  job deletion completes. Server default: true.
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-delete-job
+        #
+        def delete_job(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'ml.delete_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_DELETE
+          path   = "_ml/anomaly_detectors/#{Utils.listify(_job_id)}"
+          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/delete_model_snapshot.rb

@@ -0,0 +1,67 @@
+# 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.
+#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
+module Elasticsearch
+  module API
+    module MachineLearning
+      module Actions
+        # Delete a model snapshot.
+        # You cannot delete the active model snapshot. To delete that snapshot, first
+        # revert to a different one. To identify the active model snapshot, refer to
+        # the +model_snapshot_id+ in the results from the get jobs API.
+        #
+        # @option arguments [String] :job_id Identifier for the anomaly detection job. (*Required*)
+        # @option arguments [String] :snapshot_id Identifier for the model snapshot. (*Required*)
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-delete-model-snapshot
+        #
+        def delete_model_snapshot(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'ml.delete_model_snapshot' }
+
+          defined_params = [: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 = nil
+
+          _job_id = arguments.delete(:job_id)
+
+          _snapshot_id = arguments.delete(:snapshot_id)
+
+          method = Elasticsearch::API::HTTP_DELETE
+          path   = "_ml/anomaly_detectors/#{Utils.listify(_job_id)}/model_snapshots/#{Utils.listify(_snapshot_id)}"
+          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/delete_trained_model.rb

@@ -0,0 +1,63 @@
+# 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.
+#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
+module Elasticsearch
+  module API
+    module MachineLearning
+      module Actions
+        # Delete an unreferenced trained model.
+        # The request deletes a trained inference model that is not referenced by an ingest pipeline.
+        #
+        # @option arguments [String] :model_id The unique identifier of the trained model. (*Required*)
+        # @option arguments [Boolean] :force Forcefully deletes a trained model that is referenced by ingest pipelines or has a started deployment.
+        # @option arguments [Time] :timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-delete-trained-model
+        #
+        def delete_trained_model(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'ml.delete_trained_model' }
+
+          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_DELETE
+          path   = "_ml/trained_models/#{Utils.listify(_model_id)}"
+          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/delete_trained_model_alias.rb

@@ -0,0 +1,67 @@
+# 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.
+#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
+module Elasticsearch
+  module API
+    module MachineLearning
+      module Actions
+        # Delete a trained model alias.
+        # This API deletes an existing model alias that refers to a trained model. If
+        # the model alias is missing or refers to a model other than the one identified
+        # by the +model_id+, this API returns an error.
+        #
+        # @option arguments [String] :model_alias The model alias to delete. (*Required*)
+        # @option arguments [String] :model_id The trained model ID to which the model alias refers. (*Required*)
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-delete-trained-model-alias
+        #
+        def delete_trained_model_alias(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'ml.delete_trained_model_alias' }
+
+          defined_params = [: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_DELETE
+          path   = "_ml/trained_models/#{Utils.listify(_model_id)}/model_aliases/#{Utils.listify(_model_alias)}"
+          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/estimate_model_memory.rb

@@ -0,0 +1,56 @@
+# 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.
+#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
+module Elasticsearch
+  module API
+    module MachineLearning
+      module Actions
+        # Estimate job model memory usage.
+        # Make an estimation of the memory usage for an anomaly detection job model.
+        # The estimate is based on analysis configuration details for the job and cardinality
+        # estimates for the fields it references.
+        #
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body request body
+        #
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-estimate-model-memory
+        #
+        def estimate_model_memory(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'ml.estimate_model_memory' }
+
+          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body = arguments.delete(:body)
+
+          method = Elasticsearch::API::HTTP_POST
+          path   = '_ml/anomaly_detectors/_estimate_model_memory'
+          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/evaluate_data_frame.rb

@@ -0,0 +1,57 @@
+# 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.
+#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
+module Elasticsearch
+  module API
+    module MachineLearning
+      module Actions
+        # Evaluate data frame analytics.
+        # The API packages together commonly used evaluation metrics for various types
+        # of machine learning features. This has been designed for use on indexes
+        # created by data frame analytics. Evaluation requires both a ground truth
+        # field and an analytics result field to be present.
+        #
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body request body
+        #
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-evaluate-data-frame
+        #
+        def evaluate_data_frame(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'ml.evaluate_data_frame' }
+
+          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body = arguments.delete(:body)
+
+          method = Elasticsearch::API::HTTP_POST
+          path   = '_ml/data_frame/_evaluate'
+          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/explain_data_frame_analytics.rb

@@ -0,0 +1,76 @@
+# 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.
+#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
+module Elasticsearch
+  module API
+    module MachineLearning
+      module Actions
+        # Explain data frame analytics config.
+        # This API provides explanations for a data frame analytics config that either
+        # exists already or one that has not been created yet. The following
+        # explanations are provided:
+        # * which fields are included or not in the analysis and why,
+        # * how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on.
+        # If you have object fields or fields that are excluded via source filtering, they are not included in the explanation.
+        #
+        # @option arguments [String] :id Identifier for the data frame analytics job. This identifier can contain
+        #  lowercase alphanumeric characters (a-z and 0-9), hyphens, and
+        #  underscores. It must start and end with alphanumeric characters.
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body request body
+        #
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-explain-data-frame-analytics
+        #
+        def explain_data_frame_analytics(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'ml.explain_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?
+
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body = arguments.delete(:body)
+
+          _id = arguments.delete(:id)
+
+          method = if body
+                     Elasticsearch::API::HTTP_POST
+                   else
+                     Elasticsearch::API::HTTP_GET
+                   end
+
+          path   = if _id
+                     "_ml/data_frame/analytics/#{Utils.listify(_id)}/_explain"
+                   else
+                     '_ml/data_frame/analytics/_explain'
+                   end
+          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/flush_job.rb

@@ -0,0 +1,79 @@
+# 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.
+#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
+module Elasticsearch
+  module API
+    module MachineLearning
+      module Actions
+        # Force buffered data to be processed.
+        # The flush jobs API is only applicable when sending data for analysis using
+        # the post data API. Depending on the content of the buffer, then it might
+        # additionally calculate new results. Both flush and close operations are
+        # similar, however the flush is more efficient if you are expecting to send
+        # more data for analysis. When flushing, the job remains open and is available
+        # to continue analyzing data. A close operation additionally prunes and
+        # persists the model state to disk and the job must be opened again before
+        # analyzing further data.
+        #
+        # @option arguments [String] :job_id Identifier for the anomaly detection job. (*Required*)
+        # @option arguments [String, Time] :advance_time Specifies to advance to a particular time value. Results are generated
+        #  and the model is updated for data from the specified time interval.
+        # @option arguments [Boolean] :calc_interim If true, calculates the interim results for the most recent bucket or all
+        #  buckets within the latency period.
+        # @option arguments [String, Time] :end When used in conjunction with +calc_interim+ and +start+, specifies the
+        #  range of buckets on which to calculate interim results.
+        # @option arguments [String, Time] :skip_time Specifies to skip to a particular time value. Results are not generated
+        #  and the model is not updated for data from the specified time interval.
+        # @option arguments [String, Time] :start When used in conjunction with +calc_interim+, specifies the range of
+        #  buckets on which to calculate interim results.
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body request body
+        #
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-flush-job
+        #
+        def flush_job(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'ml.flush_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 = arguments.delete(:body)
+
+          _job_id = arguments.delete(:job_id)
+
+          method = Elasticsearch::API::HTTP_POST
+          path   = "_ml/anomaly_detectors/#{Utils.listify(_job_id)}/_flush"
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers, request_opts)
+          )
+        end
+      end
+    end
+  end
+end