elasticsearch-xpack 7.12.0 → 7.13.0.pre

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

@@ -28,7 +28,7 @@ module Elasticsearch
           # @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/7.12/ml-get-datafeed.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/ml-get-datafeed.html
           #
           def get_datafeeds(arguments = {})
             headers = arguments.delete(:headers) || {}

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

@@ -27,7 +27,7 @@ module Elasticsearch
           # @option arguments [Int] :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/7.12/ml-get-filter.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/ml-get-filter.html
           #
           def get_filters(arguments = {})
             headers = arguments.delete(:headers) || {}

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

@@ -34,7 +34,7 @@ module Elasticsearch
           # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body Influencer selection criteria
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/ml-get-influencer.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/ml-get-influencer.html
           #
           def get_influencers(arguments = {})
             raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]

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

@@ -27,7 +27,7 @@ module Elasticsearch
           # @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/7.12/ml-get-job-stats.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/ml-get-job-stats.html
           #
           def get_job_stats(arguments = {})
             headers = arguments.delete(:headers) || {}

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

@@ -28,7 +28,7 @@ module Elasticsearch
           # @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/7.12/ml-get-job.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/ml-get-job.html
           #
           def get_jobs(arguments = {})
             headers = arguments.delete(:headers) || {}

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

@@ -33,7 +33,7 @@ module Elasticsearch
           # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body Model snapshot selection criteria
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/ml-get-snapshot.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/ml-get-snapshot.html
           #
           def get_model_snapshots(arguments = {})
             raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]

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

@@ -34,7 +34,7 @@ module Elasticsearch
           # @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/7.12/ml-get-overall-buckets.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/ml-get-overall-buckets.html
           #
           def get_overall_buckets(arguments = {})
             raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]

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

@@ -34,7 +34,7 @@ module Elasticsearch
           # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body Record selection criteria
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/ml-get-record.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/ml-get-record.html
           #
           def get_records(arguments = {})
             raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]

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

@@ -21,10 +21,6 @@ module Elasticsearch
       module MachineLearning
         module Actions
           # Retrieves configuration information for a trained inference model.
-          # This functionality is in Beta and is subject to change. The design and
-          # code is less mature than official GA features and is being provided
-          # as-is with no warranties. Beta features are not subject to the support
-          # SLA of official GA features.
           #
           # @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)
@@ -37,7 +33,7 @@ module Elasticsearch
           # @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/7.12/get-trained-models.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/get-trained-models.html
           #
           def get_trained_models(arguments = {})
             headers = arguments.delete(:headers) || {}

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

@@ -21,10 +21,6 @@ module Elasticsearch
       module MachineLearning
         module Actions
           # Retrieves usage information for trained inference models.
-          # This functionality is in Beta and is subject to change. The design and
-          # code is less mature than official GA features and is being provided
-          # as-is with no warranties. Beta features are not subject to the support
-          # SLA of official GA features.
           #
           # @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)
@@ -32,7 +28,7 @@ module Elasticsearch
           # @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.12/get-trained-models-stats.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/get-trained-models-stats.html
           #
           def get_trained_models_stats(arguments = {})
             headers = arguments.delete(:headers) || {}

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

@@ -24,7 +24,7 @@ module Elasticsearch
           #
           # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/get-ml-info.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/get-ml-info.html
           #
           def info(arguments = {})
             headers = arguments.delete(:headers) || {}

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

@@ -25,7 +25,7 @@ module Elasticsearch
           # @option arguments [String] :job_id The ID of the job to open
           # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/ml-open-job.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/ml-open-job.html
           #
           def open_job(arguments = {})
             raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]

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

@@ -26,7 +26,7 @@ module Elasticsearch
           # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body A list of events (*Required*)
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/ml-post-calendar-event.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/ml-post-calendar-event.html
           #
           def post_calendar_events(arguments = {})
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]

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

@@ -28,7 +28,7 @@ module Elasticsearch
           # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body The data to process (*Required*)
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/ml-post-data.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/ml-post-data.html
           #
           def post_data(arguments = {})
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]

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

@@ -0,0 +1,58 @@
+# 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
+          # Previews that will be analyzed given a data frame analytics config.
+          #
+          # @option arguments [String] :id The ID of the data frame analytics to preview
+          # @option arguments [Hash] :headers Custom HTTP headers
+          # @option arguments [Hash] :body The data frame analytics config to preview
+          #
+          # @see http://www.elastic.co/guide/en/elasticsearch/reference/7.x/preview-dfanalytics.html
+          #
+          def preview_data_frame_analytics(arguments = {})
+            headers = arguments.delete(:headers) || {}
+
+            arguments = arguments.clone
+
+            _id = arguments.delete(:id)
+
+            method = if arguments[:body]
+                       Elasticsearch::API::HTTP_POST
+                     else
+                       Elasticsearch::API::HTTP_GET
+                     end
+
+            path = if _id
+                     "_ml/data_frame/analytics/#{Elasticsearch::API::Utils.__listify(_id)}/_preview"
+                   else
+                     "_ml/data_frame/analytics/_preview"
+                   end
+            params = {}
+
+            body = arguments[:body]
+            perform_request(method, path, params, body, headers).body
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -24,23 +24,31 @@ module Elasticsearch
           #
           # @option arguments [String] :datafeed_id The ID of the datafeed to preview
           # @option arguments [Hash] :headers Custom HTTP headers
+          # @option arguments [Hash] :body The datafeed config and job config with which to execute the preview
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/ml-preview-datafeed.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/ml-preview-datafeed.html
           #
           def preview_datafeed(arguments = {})
-            raise ArgumentError, "Required argument 'datafeed_id' missing" unless arguments[:datafeed_id]
-
             headers = arguments.delete(:headers) || {}
 
             arguments = arguments.clone
 
             _datafeed_id = arguments.delete(:datafeed_id)
 
-            method = Elasticsearch::API::HTTP_GET
-            path   = "_ml/datafeeds/#{Elasticsearch::API::Utils.__listify(_datafeed_id)}/_preview"
+            method = if arguments[:body]
+                       Elasticsearch::API::HTTP_POST
+                     else
+                       Elasticsearch::API::HTTP_GET
+                     end
+
+            path = if _datafeed_id
+                     "_ml/datafeeds/#{Elasticsearch::API::Utils.__listify(_datafeed_id)}/_preview"
+                   else
+                     "_ml/datafeeds/_preview"
+                   end
             params = {}
 
-            body = nil
+            body = arguments[:body]
             perform_request(method, path, params, body, headers).body
           end
         end

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

@@ -26,7 +26,7 @@ module Elasticsearch
           # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body The calendar details
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/ml-put-calendar.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/ml-put-calendar.html
           #
           def put_calendar(arguments = {})
             raise ArgumentError, "Required argument 'calendar_id' missing" unless arguments[:calendar_id]

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

@@ -26,7 +26,7 @@ module Elasticsearch
           # @option arguments [String] :job_id The ID of the job to add to the calendar
           # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/ml-put-calendar-job.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/ml-put-calendar-job.html
           #
           def put_calendar_job(arguments = {})
             raise ArgumentError, "Required argument 'calendar_id' missing" unless arguments[:calendar_id]

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

@@ -21,16 +21,12 @@ module Elasticsearch
       module MachineLearning
         module Actions
           # Instantiates a data frame analytics job.
-          # This functionality is in Beta and is subject to change. The design and
-          # code is less mature than official GA features and is being provided
-          # as-is with no warranties. Beta features are not subject to the support
-          # SLA of official GA features.
           #
           # @option arguments [String] :id The ID of the data frame analytics to create
           # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body The data frame analytics configuration (*Required*)
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/put-dfanalytics.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/put-dfanalytics.html
           #
           def put_data_frame_analytics(arguments = {})
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]

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

@@ -30,7 +30,7 @@ module Elasticsearch
           # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body The datafeed config (*Required*)
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/ml-put-datafeed.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/ml-put-datafeed.html
           #
           def put_datafeed(arguments = {})
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]

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

@@ -26,7 +26,7 @@ module Elasticsearch
           # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body The filter details (*Required*)
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/ml-put-filter.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/ml-put-filter.html
           #
           def put_filter(arguments = {})
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]

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

@@ -26,7 +26,7 @@ module Elasticsearch
           # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body The job (*Required*)
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/ml-put-job.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/ml-put-job.html
           #
           def put_job(arguments = {})
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]

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

@@ -21,16 +21,12 @@ module Elasticsearch
       module MachineLearning
         module Actions
           # Creates an inference trained model.
-          # This functionality is in Beta and is subject to change. The design and
-          # code is less mature than official GA features and is being provided
-          # as-is with no warranties. Beta features are not subject to the support
-          # SLA of official GA features.
           #
           # @option arguments [String] :model_id The ID of the trained models to store
           # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body The trained model configuration (*Required*)
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/put-trained-models.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/put-trained-models.html
           #
           def put_trained_model(arguments = {})
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]

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

@@ -0,0 +1,62 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module Elasticsearch
+  module XPack
+    module API
+      module MachineLearning
+        module Actions
+          # Creates a new model alias (or reassigns an existing one) to refer to the trained model
+          #
+          # @option arguments [String] :model_alias The trained model alias to update
+          # @option arguments [String] :model_id The trained model where the model alias should be assigned
+          # @option arguments [Boolean] :reassign If the model_alias already exists and points to a separate model_id, this parameter must be true. Defaults to false.
+          # @option arguments [Hash] :headers Custom HTTP headers
+          #
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/put-trained-models-aliases.html
+          #
+          def put_trained_model_alias(arguments = {})
+            raise ArgumentError, "Required argument 'model_id' missing" unless arguments[:model_id]
+            raise ArgumentError, "Required argument 'model_alias' missing" unless arguments[:model_alias]
+
+            headers = arguments.delete(:headers) || {}
+
+            arguments = arguments.clone
+
+            _model_alias = arguments.delete(:model_alias)
+
+            _model_id = arguments.delete(:model_id)
+
+            method = Elasticsearch::API::HTTP_PUT
+            path   = "_ml/trained_models/#{Elasticsearch::API::Utils.__listify(_model_id)}/model_aliases/#{Elasticsearch::API::Utils.__listify(_model_alias)}"
+            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(:put_trained_model_alias, [
+            :reassign
+          ].freeze)
+        end
+      end
+    end
+  end
+end

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

@@ -28,7 +28,7 @@ module Elasticsearch
           # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body Reversion options
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/ml-revert-snapshot.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/ml-revert-snapshot.html
           #
           def revert_model_snapshot(arguments = {})
             raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]

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

@@ -26,7 +26,7 @@ module Elasticsearch
           # @option arguments [Time] :timeout Controls the time to wait before action times out. Defaults to 30 seconds
           # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/ml-set-upgrade-mode.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/ml-set-upgrade-mode.html
           #
           def set_upgrade_mode(arguments = {})
             headers = arguments.delete(:headers) || {}

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

@@ -21,17 +21,13 @@ module Elasticsearch
       module MachineLearning
         module Actions
           # Starts a data frame analytics job.
-          # This functionality is in Beta and is subject to change. The design and
-          # code is less mature than official GA features and is being provided
-          # as-is with no warranties. Beta features are not subject to the support
-          # SLA of official GA features.
           #
           # @option arguments [String] :id The ID of the data frame analytics to start
           # @option arguments [Time] :timeout Controls the time to wait until the task has started. Defaults to 20 seconds
           # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body The start data frame analytics parameters
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/start-dfanalytics.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/start-dfanalytics.html
           #
           def start_data_frame_analytics(arguments = {})
             raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]