elasticsearch-api 7.17.11 → 9.0.2

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

@@ -0,0 +1,77 @@
+# 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
+        # Predict future behavior of a time series.
+        # Forecasts are not supported for jobs that perform population analysis; an
+        # error occurs if you try to create a forecast for a job that has an
+        # +over_field_name+ in its configuration. Forcasts predict future behavior
+        # based on historical data.
+        #
+        # @option arguments [String] :job_id Identifier for the anomaly detection job. The job must be open when you
+        #  create a forecast; otherwise, an error occurs. (*Required*)
+        # @option arguments [Time] :duration A period of time that indicates how far into the future to forecast. For
+        #  example, +30d+ corresponds to 30 days. The forecast starts at the last
+        #  record that was processed. Server default: 1d.
+        # @option arguments [Time] :expires_in The period of time that forecast results are retained. After a forecast
+        #  expires, the results are deleted. If set to a value of 0, the forecast is
+        #  never automatically deleted. Server default: 14d.
+        # @option arguments [String] :max_model_memory The maximum memory the forecast can use. If the forecast needs to use
+        #  more than the provided amount, it will spool to disk. Default is 20mb,
+        #  maximum is 500mb and minimum is 1mb. If set to 40% or more of the job’s
+        #  configured memory limit, it is automatically reduced to below that
+        #  amount. Server default: 20mb.
+        # @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-forecast
+        #
+        def forecast(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'ml.forecast' }
+
+          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)}/_forecast"
+          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/get_buckets.rb

@@ -0,0 +1,86 @@
+# 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
+        # Get anomaly detection job results for buckets.
+        # The API presents a chronological view of the records, grouped by bucket.
+        #
+        # @option arguments [String] :job_id Identifier for the anomaly detection job. (*Required*)
+        # @option arguments [String, Time] :timestamp The timestamp of a single bucket result. If you do not specify this
+        #  parameter, the API returns information about all buckets.
+        # @option arguments [Float] :anomaly_score Returns buckets with anomaly scores greater or equal than this value. Server default: 0.
+        # @option arguments [Boolean] :desc If +true+, the buckets are sorted in descending order.
+        # @option arguments [String, Time] :end Returns buckets with timestamps earlier than this time. +-1+ means it is
+        #  unset and results are not limited to specific timestamps. Server default: -1.
+        # @option arguments [Boolean] :exclude_interim If +true+, the output excludes interim results.
+        # @option arguments [Boolean] :expand If true, the output includes anomaly records.
+        # @option arguments [Integer] :from Skips the specified number of buckets. Server default: 0.
+        # @option arguments [Integer] :size Specifies the maximum number of buckets to obtain. Server default: 100.
+        # @option arguments [String] :sort Specifies the sort field for the requested buckets. Server default: timestamp.
+        # @option arguments [String, Time] :start Returns buckets with timestamps after this time. +-1+ means it is unset
+        #  and results are not limited to specific timestamps. Server default: -1.
+        # @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-get-buckets
+        #
+        def get_buckets(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'ml.get_buckets' }
+
+          defined_params = [:job_id, :timestamp].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)
+
+          _timestamp = arguments.delete(:timestamp)
+
+          method = if body
+                     Elasticsearch::API::HTTP_POST
+                   else
+                     Elasticsearch::API::HTTP_GET
+                   end
+
+          path   = if _job_id && _timestamp
+                     "_ml/anomaly_detectors/#{Utils.listify(_job_id)}/results/buckets/#{Utils.listify(_timestamp)}"
+                   else
+                     "_ml/anomaly_detectors/#{Utils.listify(_job_id)}/results/buckets"
+                   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/get_calendar_events.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.
+#
+# 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
+        # Get info about events in calendars.
+        #
+        # @option arguments [String] :calendar_id A string that uniquely identifies a calendar. You can get information for multiple calendars by using a comma-separated list of ids or a wildcard expression. You can get information for all calendars by using +_all+ or +*+ or by omitting the calendar identifier. (*Required*)
+        # @option arguments [String, Time] :end Specifies to get events with timestamps earlier than this time.
+        # @option arguments [Integer] :from Skips the specified number of events. Server default: 0.
+        # @option arguments [String] :job_id Specifies to get events for a specific anomaly detection job identifier or job group. It must be used with a calendar identifier of +_all+ or +*+.
+        # @option arguments [Integer] :size Specifies the maximum number of events to obtain. Server default: 100.
+        # @option arguments [String, Time] :start Specifies to get events with timestamps after this time.
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-get-calendar-events
+        #
+        def get_calendar_events(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'ml.get_calendar_events' }
+
+          defined_params = [:calendar_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 'calendar_id' missing" unless arguments[:calendar_id]
+
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          _calendar_id = arguments.delete(:calendar_id)
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = "_ml/calendars/#{Utils.listify(_calendar_id)}/events"
+          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/get_calendars.rb

@@ -0,0 +1,70 @@
+# 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
+        # Get calendar configuration info.
+        #
+        # @option arguments [String] :calendar_id A string that uniquely identifies a calendar. You can get information for multiple calendars by using a comma-separated list of ids or a wildcard expression. You can get information for all calendars by using +_all+ or +*+ or by omitting the calendar identifier.
+        # @option arguments [Integer] :from Skips the specified number of calendars. This parameter is supported only when you omit the calendar identifier. Server default: 0.
+        # @option arguments [Integer] :size Specifies the maximum number of calendars to obtain. This parameter is supported only when you omit the calendar identifier. Server default: 10000.
+        # @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-get-calendars
+        #
+        def get_calendars(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'ml.get_calendars' }
+
+          defined_params = [:calendar_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)
+
+          _calendar_id = arguments.delete(:calendar_id)
+
+          method = if body
+                     Elasticsearch::API::HTTP_POST
+                   else
+                     Elasticsearch::API::HTTP_GET
+                   end
+
+          path   = if _calendar_id
+                     "_ml/calendars/#{Utils.listify(_calendar_id)}"
+                   else
+                     '_ml/calendars'
+                   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/get_categories.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
+        # Get anomaly detection job results for categories.
+        #
+        # @option arguments [String] :job_id Identifier for the anomaly detection job. (*Required*)
+        # @option arguments [String] :category_id Identifier for the category, which is unique in the job. If you specify
+        #  neither the category ID nor the partition_field_value, the API returns
+        #  information about all categories. If you specify only the
+        #  partition_field_value, it returns information about all categories for
+        #  the specified partition.
+        # @option arguments [Integer] :from Skips the specified number of categories. Server default: 0.
+        # @option arguments [String] :partition_field_value Only return categories for the specified partition.
+        # @option arguments [Integer] :size Specifies the maximum number of categories to obtain. Server default: 100.
+        # @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-get-categories
+        #
+        def get_categories(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'ml.get_categories' }
+
+          defined_params = [:job_id, :category_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)
+
+          _category_id = arguments.delete(:category_id)
+
+          method = if body
+                     Elasticsearch::API::HTTP_POST
+                   else
+                     Elasticsearch::API::HTTP_GET
+                   end
+
+          path   = if _job_id && _category_id
+                     "_ml/anomaly_detectors/#{Utils.listify(_job_id)}/results/categories/#{Utils.listify(_category_id)}"
+                   else
+                     "_ml/anomaly_detectors/#{Utils.listify(_job_id)}/results/categories"
+                   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/get_data_frame_analytics.rb

@@ -0,0 +1,81 @@
+# 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
+        # Get data frame analytics job configuration info.
+        # You can get information for multiple data frame analytics jobs in a single
+        # API request by using a comma-separated list of data frame analytics jobs or a
+        # wildcard expression.
+        #
+        # @option arguments [String] :id Identifier for the data frame analytics job. If you do not specify this
+        #  option, the API returns information for the first hundred data frame
+        #  analytics jobs.
+        # @option arguments [Boolean] :allow_no_match Specifies what to do when the request:
+        #  - Contains wildcard expressions and there are no data frame analytics
+        #  jobs that match.
+        #  - Contains the +_all+ string or no identifiers and there are no matches.
+        #  - Contains wildcard expressions and there are only partial matches.
+        #  The default value returns an empty data_frame_analytics array when there
+        #  are no matches and the subset of results when there are partial matches.
+        #  If this parameter is +false+, the request returns a 404 status code when
+        #  there are no matches or only partial matches. Server default: true.
+        # @option arguments [Integer] :from Skips the specified number of data frame analytics jobs. Server default: 0.
+        # @option arguments [Integer] :size Specifies the maximum number of data frame analytics jobs to obtain. Server default: 100.
+        # @option arguments [Boolean] :exclude_generated Indicates if certain fields should be removed from the configuration on
+        #  retrieval. This allows the configuration to be in an acceptable format to
+        #  be retrieved and then added to another cluster.
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-get-data-frame-analytics
+        #
+        def get_data_frame_analytics(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'ml.get_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 = nil
+
+          _id = arguments.delete(:id)
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = if _id
+                     "_ml/data_frame/analytics/#{Utils.listify(_id)}"
+                   else
+                     '_ml/data_frame/analytics'
+                   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/get_data_frame_analytics_stats.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
+        # Get data frame analytics jobs usage info.
+        #
+        # @option arguments [String] :id Identifier for the data frame analytics job. If you do not specify this
+        #  option, the API returns information for the first hundred data frame
+        #  analytics jobs.
+        # @option arguments [Boolean] :allow_no_match Specifies what to do when the request:
+        #  - Contains wildcard expressions and there are no data frame analytics
+        #  jobs that match.
+        #  - Contains the +_all+ string or no identifiers and there are no matches.
+        #  - Contains wildcard expressions and there are only partial matches.
+        #  The default value returns an empty data_frame_analytics array when there
+        #  are no matches and the subset of results when there are partial matches.
+        #  If this parameter is +false+, the request returns a 404 status code when
+        #  there are no matches or only partial matches. Server default: true.
+        # @option arguments [Integer] :from Skips the specified number of data frame analytics jobs. Server default: 0.
+        # @option arguments [Integer] :size Specifies the maximum number of data frame analytics jobs to obtain. Server default: 100.
+        # @option arguments [Boolean] :verbose Defines whether the stats response should be verbose.
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-get-data-frame-analytics-stats
+        #
+        def get_data_frame_analytics_stats(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'ml.get_data_frame_analytics_stats' }
+
+          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 = nil
+
+          _id = arguments.delete(:id)
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = if _id
+                     "_ml/data_frame/analytics/#{Utils.listify(_id)}/_stats"
+                   else
+                     '_ml/data_frame/analytics/_stats'
+                   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/get_datafeed_stats.rb

@@ -0,0 +1,78 @@
+# 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
+        # Get datafeeds usage info.
+        # You can get statistics for multiple datafeeds in a single API request by
+        # using a comma-separated list of datafeeds or a wildcard expression. You can
+        # get statistics for all datafeeds by using +_all+, by specifying +*+ as the
+        # +<feed_id>+, or by omitting the +<feed_id>+. If the datafeed is stopped, the
+        # only information you receive is the +datafeed_id+ and the +state+.
+        # This API returns a maximum of 10,000 datafeeds.
+        #
+        # @option arguments [String, Array] :datafeed_id Identifier for the datafeed. It can be a datafeed identifier or a
+        #  wildcard expression. If you do not specify one of these options, the API
+        #  returns information about all datafeeds.
+        # @option arguments [Boolean] :allow_no_match Specifies what to do when the request:
+        #  - Contains wildcard expressions and there are no datafeeds that match.
+        #  - Contains the +_all+ string or no identifiers and there are no matches.
+        #  - Contains wildcard expressions and there are only partial matches.
+        #  The default value is +true+, which returns an empty +datafeeds+ array
+        #  when there are no matches and the subset of results when there are
+        #  partial matches. If this parameter is +false+, the request returns a
+        #  +404+ status code when there are no matches or only partial matches.
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-get-datafeed-stats
+        #
+        def get_datafeed_stats(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'ml.get_datafeed_stats' }
+
+          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?
+
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          _datafeed_id = arguments.delete(:datafeed_id)
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = if _datafeed_id
+                     "_ml/datafeeds/#{Utils.listify(_datafeed_id)}/_stats"
+                   else
+                     '_ml/datafeeds/_stats'
+                   end
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers, request_opts)
+          )
+        end
+      end
+    end
+  end
+end