elasticsearch-xpack 7.6.0 → 7.7.0.pre

data/lib/elasticsearch/xpack/api/actions/data_frame_transform_deprecated/stop_transform.rb

@@ -7,14 +7,13 @@ module Elasticsearch
     module API
       module DataFrameTransformDeprecated
         module Actions
-          # TODO: Description
-
+          # Stops one or more transforms.
           #
           # @option arguments [String] :transform_id The id of the transform to stop
           # @option arguments [Boolean] :wait_for_completion Whether to wait for the transform to fully stop before returning or not. Default to false
           # @option arguments [Time] :timeout Controls the time to wait until the transform has stopped. Default to 30 seconds
           # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no transforms. (This includes `_all` string or when no transforms have been specified)
-
+          # @option arguments [Hash] :headers Custom HTTP headers
           #
           # *Deprecation notice*:
           # [_data_frame/transforms/] is deprecated, use [_transform/] in the future.
@@ -26,6 +25,8 @@ module Elasticsearch
           def stop_transform(arguments = {})
             raise ArgumentError, "Required argument 'transform_id' missing" unless arguments[:transform_id]
 
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _transform_id = arguments.delete(:transform_id)
@@ -35,7 +36,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/data_frame_transform_deprecated/update_transform.rb

@@ -7,12 +7,11 @@ module Elasticsearch
     module API
       module DataFrameTransformDeprecated
         module Actions
-          # TODO: Description
-
+          # Updates certain properties of a transform.
           #
           # @option arguments [String] :transform_id The id of the transform.  (*Required*)
           # @option arguments [Boolean] :defer_validation If validations should be deferred until transform starts, defaults to false.
-
+          # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body The update transform definition (*Required*)
           #
           # *Deprecation notice*:
@@ -26,6 +25,8 @@ module Elasticsearch
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
             raise ArgumentError, "Required argument 'transform_id' missing" unless arguments[:transform_id]
 
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _transform_id = arguments.delete(:transform_id)
@@ -35,7 +36,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/graph/explore.rb

@@ -7,14 +7,13 @@ module Elasticsearch
     module API
       module Graph
         module Actions
-          # TODO: Description
-
+          # Explore extracted and summarized information about the documents and terms in an index.
           #
           # @option arguments [List] :index A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
           # @option arguments [List] :type A comma-separated list of document types to search; leave empty to perform the operation on all types   *Deprecated*
           # @option arguments [String] :routing Specific routing value
           # @option arguments [Time] :timeout Explicit operation timeout
-
+          # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body Graph Query DSL
           #
           # *Deprecation notice*:
@@ -27,6 +26,8 @@ module Elasticsearch
           def explore(arguments = {})
             raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
 
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _index = arguments.delete(:index)
@@ -42,7 +43,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/index_lifecycle_management/delete_lifecycle.rb

@@ -7,17 +7,18 @@ module Elasticsearch
     module API
       module IndexLifecycleManagement
         module Actions
-          # TODO: Description
-
+          # Deletes the specified lifecycle policy definition. A currently used policy cannot be deleted.
           #
           # @option arguments [String] :policy The name of the index lifecycle policy
-
+          # @option arguments [Hash] :headers Custom HTTP headers
           #
           # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-delete-lifecycle.html
           #
           def delete_lifecycle(arguments = {})
             raise ArgumentError, "Required argument 'policy' missing" unless arguments[:policy]
 
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _policy = arguments.delete(:policy)
@@ -27,7 +28,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/index_lifecycle_management/explain_lifecycle.rb

@@ -7,19 +7,20 @@ module Elasticsearch
     module API
       module IndexLifecycleManagement
         module Actions
-          # TODO: Description
-
+          # Retrieves information about the index's current lifecycle state, such as the currently executing phase, action, and step.
           #
           # @option arguments [String] :index The name of the index to explain
           # @option arguments [Boolean] :only_managed filters the indices included in the response to ones managed by ILM
           # @option arguments [Boolean] :only_errors filters the indices included in the response to ones in an ILM error state, implies only_managed
-
+          # @option arguments [Hash] :headers Custom HTTP headers
           #
           # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-explain-lifecycle.html
           #
           def explain_lifecycle(arguments = {})
             raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
 
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _index = arguments.delete(:index)
@@ -29,7 +30,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/index_lifecycle_management/get_lifecycle.rb

@@ -7,15 +7,16 @@ module Elasticsearch
     module API
       module IndexLifecycleManagement
         module Actions
-          # TODO: Description
-
+          # Returns the specified policy definition. Includes the policy version and last modified date.
           #
           # @option arguments [String] :policy The name of the index lifecycle policy
-
+          # @option arguments [Hash] :headers Custom HTTP headers
           #
           # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-get-lifecycle.html
           #
           def get_lifecycle(arguments = {})
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _policy = arguments.delete(:policy)
@@ -25,11 +26,11 @@ module Elasticsearch
                        "_ilm/policy/#{Elasticsearch::API::Utils.__listify(_policy)}"
                      else
                        "_ilm/policy"
-  end
+            end
             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/index_lifecycle_management/get_status.rb

@@ -7,12 +7,15 @@ module Elasticsearch
     module API
       module IndexLifecycleManagement
         module Actions
-          # TODO: Description
-
+          # Retrieves the current index lifecycle management (ILM) status.
+          #
+          # @option arguments [Hash] :headers Custom HTTP headers
           #
           # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-get-status.html
           #
           def get_status(arguments = {})
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             method = Elasticsearch::API::HTTP_GET
@@ -20,7 +23,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/index_lifecycle_management/move_to_step.rb

@@ -7,11 +7,10 @@ module Elasticsearch
     module API
       module IndexLifecycleManagement
         module Actions
-          # TODO: Description
-
+          # Manually moves an index into the specified step and executes that step.
           #
           # @option arguments [String] :index The name of the index whose lifecycle step is to change
-
+          # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body The new lifecycle step to move to
           #
           # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-move-to-step.html
@@ -19,6 +18,8 @@ module Elasticsearch
           def move_to_step(arguments = {})
             raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
 
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _index = arguments.delete(:index)
@@ -28,7 +29,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/index_lifecycle_management/put_lifecycle.rb

@@ -7,11 +7,10 @@ module Elasticsearch
     module API
       module IndexLifecycleManagement
         module Actions
-          # TODO: Description
-
+          # Creates a lifecycle policy
           #
           # @option arguments [String] :policy The name of the index lifecycle policy
-
+          # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body The lifecycle policy definition to register
           #
           # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-put-lifecycle.html
@@ -19,6 +18,8 @@ module Elasticsearch
           def put_lifecycle(arguments = {})
             raise ArgumentError, "Required argument 'policy' missing" unless arguments[:policy]
 
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _policy = arguments.delete(:policy)
@@ -28,7 +29,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/index_lifecycle_management/remove_policy.rb

@@ -7,17 +7,18 @@ module Elasticsearch
     module API
       module IndexLifecycleManagement
         module Actions
-          # TODO: Description
-
+          # Removes the assigned lifecycle policy and stops managing the specified index
           #
           # @option arguments [String] :index The name of the index to remove policy on
-
+          # @option arguments [Hash] :headers Custom HTTP headers
           #
           # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-remove-policy.html
           #
           def remove_policy(arguments = {})
             raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
 
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _index = arguments.delete(:index)
@@ -27,7 +28,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/index_lifecycle_management/retry.rb

@@ -7,17 +7,18 @@ module Elasticsearch
     module API
       module IndexLifecycleManagement
         module Actions
-          # TODO: Description
-
+          # Retries executing the policy for an index that is in the ERROR step.
           #
           # @option arguments [String] :index The name of the indices (comma-separated) whose failed lifecycle step is to be retry
-
+          # @option arguments [Hash] :headers Custom HTTP headers
           #
           # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-retry-policy.html
           #
           def retry(arguments = {})
             raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
 
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _index = arguments.delete(:index)
@@ -27,7 +28,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/index_lifecycle_management/start.rb

@@ -7,12 +7,15 @@ module Elasticsearch
     module API
       module IndexLifecycleManagement
         module Actions
-          # TODO: Description
-
+          # Start the index lifecycle management (ILM) plugin.
+          #
+          # @option arguments [Hash] :headers Custom HTTP headers
           #
           # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-start.html
           #
           def start(arguments = {})
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             method = Elasticsearch::API::HTTP_POST
@@ -20,7 +23,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/index_lifecycle_management/stop.rb

@@ -7,12 +7,15 @@ module Elasticsearch
     module API
       module IndexLifecycleManagement
         module Actions
-          # TODO: Description
-
+          # Halts all lifecycle management operations and stops the index lifecycle management (ILM) plugin
+          #
+          # @option arguments [Hash] :headers Custom HTTP headers
           #
           # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-stop.html
           #
           def stop(arguments = {})
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             method = Elasticsearch::API::HTTP_POST
@@ -20,7 +23,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/info.rb

@@ -6,15 +6,16 @@ module Elasticsearch
   module XPack
     module API
       module Actions
-        # TODO: Description
-
+        # Retrieves information about the installed X-Pack features.
         #
         # @option arguments [List] :categories Comma-separated list of info categories. Can be any of: build, license, features
-
+        # @option arguments [Hash] :headers Custom HTTP headers
         #
         # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/info-api.html
         #
         def info(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
           arguments = arguments.clone
 
           method = Elasticsearch::API::HTTP_GET
@@ -22,7 +23,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/license/delete.rb

@@ -7,12 +7,15 @@ module Elasticsearch
     module API
       module License
         module Actions
-          # TODO: Description
-
+          # Deletes licensing information for the cluster
+          #
+          # @option arguments [Hash] :headers Custom HTTP headers
           #
           # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-license.html
           #
           def delete(arguments = {})
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             method = Elasticsearch::API::HTTP_DELETE
@@ -20,7 +23,7 @@ module Elasticsearch
             params = {}
 
             body = nil
-            perform_request(method, path, params, body).body
+            perform_request(method, path, params, body, headers).body
           end
       end
     end