elasticsearch-xpack 7.5.0 → 7.8.0.pre

data/lib/elasticsearch/xpack/api/actions/machine_learning/get_jobs.rb

@@ -1,22 +1,36 @@
-# Licensed to Elasticsearch B.V under one or more agreements.
-# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
-# See the LICENSE file in the project root for more information
+# 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 XPack
     module API
       module MachineLearning
         module Actions
-          # TODO: Description
-
+          # Retrieves configuration information for anomaly detection jobs.
           #
           # @option arguments [String] :job_id The ID of the jobs to fetch
           # @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)
-
+          # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/ml-get-job.html
           #
           def get_jobs(arguments = {})
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _job_id = arguments.delete(:job_id)
@@ -26,11 +40,11 @@ module Elasticsearch
                        "_ml/anomaly_detectors/#{Elasticsearch::API::Utils.__listify(_job_id)}"
                      else
                        "_ml/anomaly_detectors"
-  end
+            end
             params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
             body = nil
-            perform_request(method, path, params, body).body
+            perform_request(method, path, params, body, headers).body
           end
 
           # Register this action with its valid params when the module is loaded.

data/lib/elasticsearch/xpack/api/actions/machine_learning/get_model_snapshots.rb

@@ -1,14 +1,26 @@
-# Licensed to Elasticsearch B.V under one or more agreements.
-# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
-# See the LICENSE file in the project root for more information
+# 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 XPack
     module API
       module MachineLearning
         module Actions
-          # TODO: Description
-
+          # 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
@@ -18,14 +30,16 @@ module Elasticsearch
           # @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 http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-snapshot.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/ml-get-snapshot.html
           #
           def get_model_snapshots(arguments = {})
             raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]
 
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _job_id = arguments.delete(:job_id)
@@ -41,7 +55,7 @@ module Elasticsearch
             params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
             body = arguments[:body]
-            perform_request(method, path, params, body).body
+            perform_request(method, path, params, body, headers).body
           end
 
           # Register this action with its valid params when the module is loaded.

data/lib/elasticsearch/xpack/api/actions/machine_learning/get_overall_buckets.rb

@@ -1,14 +1,26 @@
-# Licensed to Elasticsearch B.V under one or more agreements.
-# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
-# See the LICENSE file in the project root for more information
+# 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 XPack
     module API
       module MachineLearning
         module Actions
-          # TODO: Description
-
+          # 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 [Int] :top_n The number of top job bucket scores to be used in the overall_score calculation
@@ -18,14 +30,16 @@ module Elasticsearch
           # @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_jobs Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified)
-
+          # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body Overall bucket selection details if not provided in URI
           #
-          # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-overall-buckets.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/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) || {}
+
             arguments = arguments.clone
 
             _job_id = arguments.delete(:job_id)
@@ -35,7 +49,7 @@ module Elasticsearch
             params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
             body = arguments[:body]
-            perform_request(method, path, params, body).body
+            perform_request(method, path, params, body, headers).body
           end
 
           # Register this action with its valid params when the module is loaded.

data/lib/elasticsearch/xpack/api/actions/machine_learning/get_records.rb

@@ -1,32 +1,46 @@
-# Licensed to Elasticsearch B.V under one or more agreements.
-# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
-# See the LICENSE file in the project root for more information
+# 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 XPack
     module API
       module MachineLearning
         module Actions
-          # TODO: Description
-
+          # Retrieves anomaly records for an anomaly detection job.
           #
-          # @option arguments [String] :job_id [TODO]
+          # @option arguments [String] :job_id The ID of the job
           # @option arguments [Boolean] :exclude_interim Exclude interim results
           # @option arguments [Int] :from skips a number of records
           # @option arguments [Int] :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 [TODO]
+          # @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 http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-record.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/ml-get-record.html
           #
           def get_records(arguments = {})
             raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]
 
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _job_id = arguments.delete(:job_id)
@@ -36,7 +50,7 @@ module Elasticsearch
             params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
             body = arguments[:body]
-            perform_request(method, path, params, body).body
+            perform_request(method, path, params, body, headers).body
           end
 
           # Register this action with its valid params when the module is loaded.

data/lib/elasticsearch/xpack/api/actions/machine_learning/get_trained_models.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 XPack
+    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 [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.
+          # @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 [Int] :from skips a number of trained models
+          # @option arguments [Int] :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 [Hash] :headers Custom HTTP headers
+          #
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/get-inference.html
+          #
+          def get_trained_models(arguments = {})
+            headers = arguments.delete(:headers) || {}
+
+            arguments = arguments.clone
+
+            _model_id = arguments.delete(:model_id)
+
+            method = Elasticsearch::API::HTTP_GET
+            path   = if _model_id
+                       "_ml/inference/#{Elasticsearch::API::Utils.__listify(_model_id)}"
+                     else
+                       "_ml/inference"
+            end
+            params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+
+            body = nil
+            perform_request(method, path, params, body, headers).body
+          end
+
+          # Register this action with its valid params when the module is loaded.
+          #
+          # @since 6.2.0
+          ParamsRegistry.register(:get_trained_models, [
+            :allow_no_match,
+            :include_model_definition,
+            :decompress_definition,
+            :from,
+            :size,
+            :tags
+          ].freeze)
+      end
+    end
+    end
+  end
+end

data/lib/elasticsearch/xpack/api/actions/machine_learning/get_trained_models_stats.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.
+
+module Elasticsearch
+  module XPack
+    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 [Int] :from skips a number of trained models
+          # @option arguments [Int] :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/7.8/get-inference-stats.html
+          #
+          def get_trained_models_stats(arguments = {})
+            headers = arguments.delete(:headers) || {}
+
+            arguments = arguments.clone
+
+            _model_id = arguments.delete(:model_id)
+
+            method = Elasticsearch::API::HTTP_GET
+            path   = if _model_id
+                       "_ml/inference/#{Elasticsearch::API::Utils.__listify(_model_id)}/_stats"
+                     else
+                       "_ml/inference/_stats"
+            end
+            params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+
+            body = nil
+            perform_request(method, path, params, body, headers).body
+          end
+
+          # Register this action with its valid params when the module is loaded.
+          #
+          # @since 6.2.0
+          ParamsRegistry.register(:get_trained_models_stats, [
+            :allow_no_match,
+            :from,
+            :size
+          ].freeze)
+      end
+    end
+    end
+  end
+end

data/lib/elasticsearch/xpack/api/actions/machine_learning/info.rb

@@ -1,18 +1,34 @@
-# Licensed to Elasticsearch B.V under one or more agreements.
-# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
-# See the LICENSE file in the project root for more information
+# 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 XPack
     module API
       module MachineLearning
         module Actions
-          # TODO: Description
-
+          # Returns defaults and limits used by machine learning.
+          #
+          # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see [TODO]
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/get-ml-info.html
           #
           def info(arguments = {})
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             method = Elasticsearch::API::HTTP_GET
@@ -20,7 +36,7 @@ module Elasticsearch
             params = {}
 
             body = nil
-            perform_request(method, path, params, body).body
+            perform_request(method, path, params, body, headers).body
           end
       end
     end

data/lib/elasticsearch/xpack/api/actions/machine_learning/open_job.rb

@@ -1,23 +1,37 @@
-# Licensed to Elasticsearch B.V under one or more agreements.
-# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
-# See the LICENSE file in the project root for more information
+# 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 XPack
     module API
       module MachineLearning
         module Actions
-          # TODO: Description
-
+          # Opens one or more anomaly detection jobs.
           #
           # @option arguments [String] :job_id The ID of the job to open
-
+          # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-open-job.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/ml-open-job.html
           #
           def open_job(arguments = {})
             raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]
 
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _job_id = arguments.delete(:job_id)
@@ -27,7 +41,7 @@ module Elasticsearch
             params = {}
 
             body = nil
-            perform_request(method, path, params, body).body
+            perform_request(method, path, params, body, headers).body
           end
       end
     end