elasticsearch-xpack 7.6.0 → 7.7.0.pre

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

@@ -7,21 +7,22 @@ module Elasticsearch
     module API
       module MachineLearning
         module Actions
-          # TODO: Description
-
+          # Reverts to a specific snapshot.
           #
           # @option arguments [String] :job_id The ID of the job to fetch
           # @option arguments [String] :snapshot_id The ID of the snapshot to revert to
           # @option arguments [Boolean] :delete_intervening_results Should we reset the results back to the time of the snapshot?
-
+          # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body Reversion options
           #
-          # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-revert-snapshot.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-revert-snapshot.html
           #
           def revert_model_snapshot(arguments = {})
             raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]
             raise ArgumentError, "Required argument 'snapshot_id' missing" unless arguments[:snapshot_id]
 
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _job_id = arguments.delete(:job_id)
@@ -33,7 +34,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/set_upgrade_mode.rb

@@ -7,16 +7,17 @@ module Elasticsearch
     module API
       module MachineLearning
         module Actions
-          # TODO: Description
-
+          # Sets a cluster wide upgrade_mode setting that prepares machine learning indices for an upgrade.
           #
           # @option arguments [Boolean] :enabled Whether to enable upgrade_mode ML setting or not. Defaults to false.
           # @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 http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-set-upgrade-mode.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-set-upgrade-mode.html
           #
           def set_upgrade_mode(arguments = {})
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             method = Elasticsearch::API::HTTP_POST
@@ -24,7 +25,7 @@ module Elasticsearch
             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/start_data_frame_analytics.rb

@@ -7,19 +7,20 @@ module Elasticsearch
     module API
       module MachineLearning
         module Actions
-          # TODO: Description
-
+          # Starts a data frame analytics job.
           #
           # @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 http://www.elastic.co/guide/en/elasticsearch/reference/current/start-dfanalytics.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/start-dfanalytics.html
           #
           def start_data_frame_analytics(arguments = {})
             raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
 
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _id = arguments.delete(:id)
@@ -29,7 +30,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/start_datafeed.rb

@@ -7,21 +7,22 @@ module Elasticsearch
     module API
       module MachineLearning
         module Actions
-          # TODO: Description
-
+          # Starts one or more datafeeds.
           #
           # @option arguments [String] :datafeed_id The ID of the datafeed to start
           # @option arguments [String] :start The start time from where the datafeed should begin
           # @option arguments [String] :end The end time when the datafeed should stop. When not set, the datafeed continues in real time
           # @option arguments [Time] :timeout Controls the time to wait until a datafeed has started. Default to 20 seconds
-
+          # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body The start datafeed parameters
           #
-          # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-start-datafeed.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-start-datafeed.html
           #
           def start_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)
@@ -31,7 +32,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/stop_data_frame_analytics.rb

@@ -7,21 +7,22 @@ module Elasticsearch
     module API
       module MachineLearning
         module Actions
-          # TODO: Description
-
+          # Stops one or more data frame analytics jobs.
           #
           # @option arguments [String] :id The ID of the data frame analytics to stop
           # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no data frame analytics. (This includes `_all` string or when no data frame analytics have been specified)
           # @option arguments [Boolean] :force True if the data frame analytics should be forcefully stopped
           # @option arguments [Time] :timeout Controls the time to wait until the task has stopped. Defaults to 20 seconds
-
+          # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body The stop data frame analytics parameters
           #
-          # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/stop-dfanalytics.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-dfanalytics.html
           #
           def stop_data_frame_analytics(arguments = {})
             raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
 
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _id = arguments.delete(:id)
@@ -31,7 +32,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/stop_datafeed.rb

@@ -7,20 +7,21 @@ module Elasticsearch
     module API
       module MachineLearning
         module Actions
-          # TODO: Description
-
+          # Stops one or more datafeeds.
           #
           # @option arguments [String] :datafeed_id The ID of the datafeed to stop
           # @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)
           # @option arguments [Boolean] :force True if the datafeed should be forcefully stopped.
           # @option arguments [Time] :timeout Controls the time to wait until a datafeed has stopped. Default to 20 seconds
-
+          # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-stop-datafeed.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-stop-datafeed.html
           #
           def stop_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)
@@ -30,7 +31,7 @@ module Elasticsearch
             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/update_datafeed.rb

@@ -7,30 +7,47 @@ module Elasticsearch
     module API
       module MachineLearning
         module Actions
-          # TODO: Description
-
+          # Updates certain properties of a datafeed.
           #
           # @option arguments [String] :datafeed_id The ID of the datafeed to update
+          # @option arguments [Boolean] :ignore_unavailable Ignore unavailable indexes (default: false)
+          # @option arguments [Boolean] :allow_no_indices Ignore if the source indices expressions resolves to no concrete indices (default: true)
+          # @option arguments [Boolean] :ignore_throttled Ignore indices that are marked as throttled (default: true)
+          # @option arguments [String] :expand_wildcards Whether source index expressions should get expanded to open or closed indices (default: open)
+          #   (options: open,closed,hidden,none,all)
 
+          # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body The datafeed update settings (*Required*)
           #
-          # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-datafeed.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-datafeed.html
           #
           def update_datafeed(arguments = {})
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
             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_POST
             path   = "_ml/datafeeds/#{Elasticsearch::API::Utils.__listify(_datafeed_id)}/_update"
-            params = {}
+            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.
+          #
+          # @since 6.2.0
+          ParamsRegistry.register(:update_datafeed, [
+            :ignore_unavailable,
+            :allow_no_indices,
+            :ignore_throttled,
+            :expand_wildcards
+          ].freeze)
       end
     end
     end

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

@@ -7,19 +7,20 @@ module Elasticsearch
     module API
       module MachineLearning
         module Actions
-          # TODO: Description
-
+          # Updates the description of a filter, adds items, or removes items.
           #
           # @option arguments [String] :filter_id The ID of the filter to update
-
+          # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body The filter update (*Required*)
           #
-          # @see [TODO]
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-filter.html
           #
           def update_filter(arguments = {})
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
             raise ArgumentError, "Required argument 'filter_id' missing" unless arguments[:filter_id]
 
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _filter_id = arguments.delete(:filter_id)
@@ -29,7 +30,7 @@ module Elasticsearch
             params = {}
 
             body = arguments[:body]
-            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/update_job.rb

@@ -7,19 +7,20 @@ module Elasticsearch
     module API
       module MachineLearning
         module Actions
-          # TODO: Description
-
+          # Updates certain properties of an anomaly detection job.
           #
           # @option arguments [String] :job_id The ID of the job to create
-
+          # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body The job update settings (*Required*)
           #
-          # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-job.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-job.html
           #
           def update_job(arguments = {})
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
             raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]
 
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _job_id = arguments.delete(:job_id)
@@ -29,7 +30,7 @@ module Elasticsearch
             params = {}
 
             body = arguments[:body]
-            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/update_model_snapshot.rb

@@ -7,21 +7,22 @@ module Elasticsearch
     module API
       module MachineLearning
         module Actions
-          # TODO: Description
-
+          # Updates certain properties of a snapshot.
           #
           # @option arguments [String] :job_id The ID of the job to fetch
           # @option arguments [String] :snapshot_id The ID of the snapshot to update
-
+          # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body The model snapshot properties to update (*Required*)
           #
-          # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-snapshot.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-snapshot.html
           #
           def update_model_snapshot(arguments = {})
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
             raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]
             raise ArgumentError, "Required argument 'snapshot_id' missing" unless arguments[:snapshot_id]
 
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _job_id = arguments.delete(:job_id)
@@ -33,7 +34,7 @@ module Elasticsearch
             params = {}
 
             body = arguments[:body]
-            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/validate.rb

@@ -7,8 +7,9 @@ module Elasticsearch
     module API
       module MachineLearning
         module Actions
-          # TODO: Description
-
+          # Validates an anomaly detection job.
+          #
+          # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body The job config (*Required*)
           #
           # @see [TODO]
@@ -16,6 +17,8 @@ module Elasticsearch
           def validate(arguments = {})
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
 
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             method = Elasticsearch::API::HTTP_POST
@@ -23,7 +26,7 @@ module Elasticsearch
             params = {}
 
             body = arguments[:body]
-            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/validate_detector.rb

@@ -7,8 +7,9 @@ module Elasticsearch
     module API
       module MachineLearning
         module Actions
-          # TODO: Description
-
+          # Validates an anomaly detection detector.
+          #
+          # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body The detector (*Required*)
           #
           # @see [TODO]
@@ -16,6 +17,8 @@ module Elasticsearch
           def validate_detector(arguments = {})
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
 
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             method = Elasticsearch::API::HTTP_POST
@@ -23,7 +26,7 @@ module Elasticsearch
             params = {}
 
             body = arguments[:body]
-            perform_request(method, path, params, body).body
+            perform_request(method, path, params, body, headers).body
           end
       end
     end

data/lib/elasticsearch/xpack/api/actions/migration/deprecations.rb

@@ -7,15 +7,16 @@ module Elasticsearch
     module API
       module Migration
         module Actions
-          # TODO: Description
-
+          # Retrieves information about different cluster, node, and index level settings that use deprecated features that will be removed or changed in the next major version.
           #
           # @option arguments [String] :index Index pattern
-
+          # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-deprecation.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-deprecation.html
           #
           def deprecations(arguments = {})
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _index = arguments.delete(:index)
@@ -25,11 +26,11 @@ module Elasticsearch
                        "#{Elasticsearch::API::Utils.__listify(_index)}/_migration/deprecations"
                      else
                        "_migration/deprecations"
-  end
+            end
             params = {}
 
             body = nil
-            perform_request(method, path, params, body).body
+            perform_request(method, path, params, body, headers).body
           end
       end
     end