elasticsearch-api 7.17.7 → 8.0.0.pre1

data/lib/elasticsearch/api/actions/machine_learning/get_datafeeds.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.
+
+module Elasticsearch
+  module API
+    module MachineLearning
+      module Actions
+        # Retrieves configuration information for datafeeds.
+        #
+        # @option arguments [String] :datafeed_id The ID of the datafeeds to fetch
+        # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified)
+        # @option arguments [Boolean] :allow_no_datafeeds Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified) *Deprecated*
+        # @option arguments [Boolean] :exclude_generated Omits fields that are illegal to set on datafeed PUT
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed.html
+        #
+        def get_datafeeds(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          arguments = arguments.clone
+
+          _datafeed_id = arguments.delete(:datafeed_id)
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = if _datafeed_id
+                     "_ml/datafeeds/#{Utils.__listify(_datafeed_id)}"
+                   else
+                     "_ml/datafeeds"
+                   end
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,55 @@
+# 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.
+
+module Elasticsearch
+  module API
+    module MachineLearning
+      module Actions
+        # Retrieves filters.
+        #
+        # @option arguments [String] :filter_id The ID of the filter to fetch
+        # @option arguments [Integer] :from skips a number of filters
+        # @option arguments [Integer] :size specifies a max number of filters to get
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-filter.html
+        #
+        def get_filters(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          arguments = arguments.clone
+
+          _filter_id = arguments.delete(:filter_id)
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = if _filter_id
+                     "_ml/filters/#{Utils.__listify(_filter_id)}"
+                   else
+                     "_ml/filters"
+                   end
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/machine_learning/get_influencers.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.
+
+module Elasticsearch
+  module API
+    module MachineLearning
+      module Actions
+        # Retrieves anomaly detection job results for one or more influencers.
+        #
+        # @option arguments [String] :job_id Identifier for the anomaly detection job
+        # @option arguments [Boolean] :exclude_interim Exclude interim results
+        # @option arguments [Integer] :from skips a number of influencers
+        # @option arguments [Integer] :size specifies a max number of influencers to get
+        # @option arguments [String] :start start timestamp for the requested influencers
+        # @option arguments [String] :end end timestamp for the requested influencers
+        # @option arguments [Double] :influencer_score influencer score threshold for the requested influencers
+        # @option arguments [String] :sort sort field for the requested influencers
+        # @option arguments [Boolean] :desc whether the results should be sorted in decending order
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body Influencer selection criteria
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-influencer.html
+        #
+        def get_influencers(arguments = {})
+          raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]
+
+          headers = arguments.delete(:headers) || {}
+
+          body = arguments.delete(:body)
+
+          arguments = arguments.clone
+
+          _job_id = arguments.delete(:job_id)
+
+          method = if body
+                     Elasticsearch::API::HTTP_POST
+                   else
+                     Elasticsearch::API::HTTP_GET
+                   end
+
+          path   = "_ml/anomaly_detectors/#{Utils.__listify(_job_id)}/results/influencers"
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,55 @@
+# 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.
+
+module Elasticsearch
+  module API
+    module MachineLearning
+      module Actions
+        # Retrieves usage information for anomaly detection jobs.
+        #
+        # @option arguments [String] :job_id The ID of the jobs stats to fetch
+        # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified)
+        # @option arguments [Boolean] :allow_no_jobs Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified) *Deprecated*
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job-stats.html
+        #
+        def get_job_stats(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          arguments = arguments.clone
+
+          _job_id = arguments.delete(:job_id)
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = if _job_id
+                     "_ml/anomaly_detectors/#{Utils.__listify(_job_id)}/_stats"
+                   else
+                     "_ml/anomaly_detectors/_stats"
+                   end
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/machine_learning/get_jobs.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.
+
+module Elasticsearch
+  module API
+    module MachineLearning
+      module Actions
+        # Retrieves configuration information for anomaly detection jobs.
+        #
+        # @option arguments [String] :job_id The ID of the jobs to fetch
+        # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified)
+        # @option arguments [Boolean] :allow_no_jobs Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified) *Deprecated*
+        # @option arguments [Boolean] :exclude_generated Omits fields that are illegal to set on job PUT
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job.html
+        #
+        def get_jobs(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          arguments = arguments.clone
+
+          _job_id = arguments.delete(:job_id)
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = if _job_id
+                     "_ml/anomaly_detectors/#{Utils.__listify(_job_id)}"
+                   else
+                     "_ml/anomaly_detectors"
+                   end
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/machine_learning/get_model_snapshots.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.
+
+module Elasticsearch
+  module API
+    module MachineLearning
+      module Actions
+        # Retrieves information about model snapshots.
+        #
+        # @option arguments [String] :job_id The ID of the job to fetch
+        # @option arguments [String] :snapshot_id The ID of the snapshot to fetch
+        # @option arguments [Integer] :from Skips a number of documents
+        # @option arguments [Integer] :size The default number of documents returned in queries as a string.
+        # @option arguments [Date] :start The filter 'start' query parameter
+        # @option arguments [Date] :end The filter 'end' query parameter
+        # @option arguments [String] :sort Name of the field to sort on
+        # @option arguments [Boolean] :desc True if the results should be sorted in descending order
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body Model snapshot selection criteria
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-snapshot.html
+        #
+        def get_model_snapshots(arguments = {})
+          raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]
+
+          headers = arguments.delete(:headers) || {}
+
+          body = arguments.delete(:body)
+
+          arguments = arguments.clone
+
+          _job_id = arguments.delete(:job_id)
+
+          _snapshot_id = arguments.delete(:snapshot_id)
+
+          method = if body
+                     Elasticsearch::API::HTTP_POST
+                   else
+                     Elasticsearch::API::HTTP_GET
+                   end
+
+          path   = if _job_id && _snapshot_id
+                     "_ml/anomaly_detectors/#{Utils.__listify(_job_id)}/model_snapshots/#{Utils.__listify(_snapshot_id)}"
+                   else
+                     "_ml/anomaly_detectors/#{Utils.__listify(_job_id)}/model_snapshots"
+                   end
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/machine_learning/get_overall_buckets.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.
+
+module Elasticsearch
+  module API
+    module MachineLearning
+      module Actions
+        # Retrieves overall bucket results that summarize the bucket results of multiple anomaly detection jobs.
+        #
+        # @option arguments [String] :job_id The job IDs for which to calculate overall bucket results
+        # @option arguments [Integer] :top_n The number of top job bucket scores to be used in the overall_score calculation
+        # @option arguments [String] :bucket_span The span of the overall buckets. Defaults to the longest job bucket_span
+        # @option arguments [Double] :overall_score Returns overall buckets with overall scores higher than this value
+        # @option arguments [Boolean] :exclude_interim If true overall buckets that include interim buckets will be excluded
+        # @option arguments [String] :start Returns overall buckets with timestamps after this time
+        # @option arguments [String] :end Returns overall buckets with timestamps earlier than this time
+        # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified)
+        # @option arguments [Boolean] :allow_no_jobs Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified) *Deprecated*
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body Overall bucket selection details if not provided in URI
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-overall-buckets.html
+        #
+        def get_overall_buckets(arguments = {})
+          raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]
+
+          headers = arguments.delete(:headers) || {}
+
+          body = arguments.delete(:body)
+
+          arguments = arguments.clone
+
+          _job_id = arguments.delete(:job_id)
+
+          method = if body
+                     Elasticsearch::API::HTTP_POST
+                   else
+                     Elasticsearch::API::HTTP_GET
+                   end
+
+          path   = "_ml/anomaly_detectors/#{Utils.__listify(_job_id)}/results/overall_buckets"
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/machine_learning/get_records.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.
+
+module Elasticsearch
+  module API
+    module MachineLearning
+      module Actions
+        # Retrieves anomaly records for an anomaly detection job.
+        #
+        # @option arguments [String] :job_id The ID of the job
+        # @option arguments [Boolean] :exclude_interim Exclude interim results
+        # @option arguments [Integer] :from skips a number of records
+        # @option arguments [Integer] :size specifies a max number of records to get
+        # @option arguments [String] :start Start time filter for records
+        # @option arguments [String] :end End time filter for records
+        # @option arguments [Double] :record_score Returns records with anomaly scores greater or equal than this value
+        # @option arguments [String] :sort Sort records by a particular field
+        # @option arguments [Boolean] :desc Set the sort direction
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body Record selection criteria
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-record.html
+        #
+        def get_records(arguments = {})
+          raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]
+
+          headers = arguments.delete(:headers) || {}
+
+          body = arguments.delete(:body)
+
+          arguments = arguments.clone
+
+          _job_id = arguments.delete(:job_id)
+
+          method = if body
+                     Elasticsearch::API::HTTP_POST
+                   else
+                     Elasticsearch::API::HTTP_GET
+                   end
+
+          path   = "_ml/anomaly_detectors/#{Utils.__listify(_job_id)}/results/records"
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+# 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.
+
+module Elasticsearch
+  module API
+    module MachineLearning
+      module Actions
+        # Get information about trained model deployments.
+        #
+        # @option arguments [String] :model_id The ID of the trained model deployment stats to fetch
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-trained-model-deployment-stats.html
+        #
+        def get_trained_model_deployment_stats(arguments = {})
+          raise ArgumentError, "Required argument 'model_id' missing" unless arguments[:model_id]
+
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          arguments = arguments.clone
+
+          _model_id = arguments.delete(:model_id)
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = "_ml/trained_models/#{Utils.__listify(_model_id)}/deployment/_stats"
+          params = {}
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,61 @@
+# 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.
+
+module Elasticsearch
+  module API
+    module MachineLearning
+      module Actions
+        # Retrieves configuration information for a trained inference model.
+        #
+        # @option arguments [String] :model_id The ID of the trained models to fetch
+        # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no trained models. (This includes `_all` string or when no trained models have been specified)
+        # @option arguments [String] :include A comma-separate list of fields to optionally include. Valid options are 'definition' and 'total_feature_importance'. Default is none.
+        # @option arguments [Boolean] :include_model_definition Should the full model definition be included in the results. These definitions can be large. So be cautious when including them. Defaults to false. *Deprecated*
+        # @option arguments [Boolean] :decompress_definition Should the model definition be decompressed into valid JSON or returned in a custom compressed format. Defaults to true.
+        # @option arguments [Integer] :from skips a number of trained models
+        # @option arguments [Integer] :size specifies a max number of trained models to get
+        # @option arguments [List] :tags A comma-separated list of tags that the model must have.
+        # @option arguments [Boolean] :exclude_generated Omits fields that are illegal to set on model PUT
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/get-trained-models.html
+        #
+        def get_trained_models(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          arguments = arguments.clone
+
+          _model_id = arguments.delete(:model_id)
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = if _model_id
+                     "_ml/trained_models/#{Utils.__listify(_model_id)}"
+                   else
+                     "_ml/trained_models"
+                   end
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/machine_learning/get_trained_models_stats.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.
+
+module Elasticsearch
+  module API
+    module MachineLearning
+      module Actions
+        # Retrieves usage information for trained inference models.
+        #
+        # @option arguments [String] :model_id The ID of the trained models stats to fetch
+        # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no trained models. (This includes `_all` string or when no trained models have been specified)
+        # @option arguments [Integer] :from skips a number of trained models
+        # @option arguments [Integer] :size specifies a max number of trained models to get
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/get-trained-models-stats.html
+        #
+        def get_trained_models_stats(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          arguments = arguments.clone
+
+          _model_id = arguments.delete(:model_id)
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = if _model_id
+                     "_ml/trained_models/#{Utils.__listify(_model_id)}/_stats"
+                   else
+                     "_ml/trained_models/_stats"
+                   end
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end