elasticsearch-xpack 7.6.0 → 7.7.0.pre

data/lib/elasticsearch/xpack/api/actions/monitoring/bulk.rb

@@ -7,14 +7,13 @@ module Elasticsearch
     module API
       module Monitoring
         module Actions
-          # TODO: Description
-
+          # Used by the monitoring features to send monitoring data.
           #
           # @option arguments [String] :type Default document type for items which don't provide one   *Deprecated*
           # @option arguments [String] :system_id Identifier of the monitored system
           # @option arguments [String] :system_api_version API Version of the monitored system
           # @option arguments [String] :interval Collection interval (e.g., '10s' or '10000ms') of the payload
-
+          # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body The operation definition and data (action-data pairs), separated by newlines (*Required*)
           #
           # *Deprecation notice*:
@@ -27,6 +26,8 @@ module Elasticsearch
           def bulk(arguments = {})
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
 
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _type = arguments.delete(:type)
@@ -46,7 +47,8 @@ module Elasticsearch
               payload = body
           end
 
-            perform_request(method, path, params, payload, { "Content-Type" => "application/x-ndjson" }).body
+            headers.merge!("Content-Type" => "application/x-ndjson")
+            perform_request(method, path, params, payload, headers).body
           end
 
           # Register this action with its valid params when the module is loaded.

data/lib/elasticsearch/xpack/api/actions/rollup/delete_job.rb

@@ -7,17 +7,18 @@ module Elasticsearch
     module API
       module Rollup
         module Actions
-          # TODO: Description
-
+          # Deletes an existing rollup job.
           #
           # @option arguments [String] :id The ID of the job to delete
-
+          # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-delete-job.html
           #
           def delete_job(arguments = {})
             raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
 
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _id = arguments.delete(:id)
@@ -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/rollup/get_jobs.rb

@@ -7,15 +7,16 @@ module Elasticsearch
     module API
       module Rollup
         module Actions
-          # TODO: Description
-
+          # Retrieves the configuration, stats, and status of rollup jobs.
           #
           # @option arguments [String] :id The ID of the job(s) to fetch. Accepts glob patterns, or left blank for all jobs
-
+          # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-get-job.html
           #
           def get_jobs(arguments = {})
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _id = arguments.delete(:id)
@@ -25,11 +26,11 @@ module Elasticsearch
                        "_rollup/job/#{Elasticsearch::API::Utils.__listify(_id)}"
                      else
                        "_rollup/job"
-  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/rollup/get_rollup_caps.rb

@@ -7,15 +7,16 @@ module Elasticsearch
     module API
       module Rollup
         module Actions
-          # TODO: Description
-
+          # Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern.
           #
           # @option arguments [String] :id The ID of the index to check rollup capabilities on, or left blank for all jobs
-
+          # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-get-rollup-caps.html
           #
           def get_rollup_caps(arguments = {})
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _id = arguments.delete(:id)
@@ -25,11 +26,11 @@ module Elasticsearch
                        "_rollup/data/#{Elasticsearch::API::Utils.__listify(_id)}"
                      else
                        "_rollup/data"
-  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/rollup/get_rollup_index_caps.rb

@@ -7,17 +7,18 @@ module Elasticsearch
     module API
       module Rollup
         module Actions
-          # TODO: Description
-
+          # Returns the rollup capabilities of all jobs inside of a rollup index (e.g. the index where rollup data is stored).
           #
           # @option arguments [String] :index The rollup index or index pattern to obtain rollup capabilities from.
-
+          # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-get-rollup-index-caps.html
           #
           def get_rollup_index_caps(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/rollup/put_job.rb

@@ -7,19 +7,20 @@ module Elasticsearch
     module API
       module Rollup
         module Actions
-          # TODO: Description
-
+          # Creates a rollup job.
           #
           # @option arguments [String] :id The ID of the job to create
-
+          # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body The job configuration (*Required*)
           #
-          # @see
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-put-job.html
           #
           def put_job(arguments = {})
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
             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 = {}
 
             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/rollup/rollup_search.rb

@@ -7,14 +7,13 @@ module Elasticsearch
     module API
       module Rollup
         module Actions
-          # TODO: Description
-
+          # Enables searching rolled-up data using the standard query DSL.
           #
           # @option arguments [List] :index The indices or index-pattern(s) (containing rollup or regular data) that should be searched
           # @option arguments [String] :type The doc type inside the index   *Deprecated*
           # @option arguments [Boolean] :typed_keys Specify whether aggregation and suggester names should be prefixed by their respective types in the response
           # @option arguments [Boolean] :rest_total_hits_as_int Indicates whether hits.total should be rendered as an integer or an object in the rest search response
-
+          # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body The search request body (*Required*)
           #
           # *Deprecation notice*:
@@ -22,12 +21,14 @@ module Elasticsearch
           # Deprecated since version 7.0.0
           #
           #
-          # @see
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-search.html
           #
           def rollup_search(arguments = {})
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
             raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
 
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _index = arguments.delete(:index)
@@ -43,7 +44,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/rollup/start_job.rb

@@ -7,17 +7,18 @@ module Elasticsearch
     module API
       module Rollup
         module Actions
-          # TODO: Description
-
+          # Starts an existing, stopped rollup job.
           #
           # @option arguments [String] :id The ID of the job to start
-
+          # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-start-job.html
           #
           def start_job(arguments = {})
             raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
 
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _id = arguments.delete(:id)
@@ -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/rollup/stop_job.rb

@@ -7,19 +7,20 @@ module Elasticsearch
     module API
       module Rollup
         module Actions
-          # TODO: Description
-
+          # Stops an existing, started rollup job.
           #
           # @option arguments [String] :id The ID of the job to stop
           # @option arguments [Boolean] :wait_for_completion True if the API should block until the job has fully stopped, false if should be executed async. Defaults to false.
           # @option arguments [Time] :timeout Block for (at maximum) the specified duration while waiting for the job to stop.  Defaults to 30s.
-
+          # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-stop-job.html
           #
           def stop_job(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 = 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/security/authenticate.rb

@@ -7,12 +7,15 @@ module Elasticsearch
     module API
       module Security
         module Actions
-          # TODO: Description
-
+          # Enables authentication as a user and retrieve information about the authenticated user.
+          #
+          # @option arguments [Hash] :headers Custom HTTP headers
           #
           # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-authenticate.html
           #
           def authenticate(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/security/change_password.rb

@@ -7,13 +7,13 @@ module Elasticsearch
     module API
       module Security
         module Actions
-          # TODO: Description
-
+          # Changes the passwords of users in the native realm and built-in users.
           #
           # @option arguments [String] :username The username of the user to change the password for
           # @option arguments [String] :refresh If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.
           #   (options: true,false,wait_for)
 
+          # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body the new password for the user (*Required*)
           #
           # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-change-password.html
@@ -21,6 +21,8 @@ module Elasticsearch
           def change_password(arguments = {})
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
 
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _username = arguments.delete(:username)
@@ -34,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/security/clear_cached_realms.rb

@@ -7,18 +7,19 @@ module Elasticsearch
     module API
       module Security
         module Actions
-          # TODO: Description
-
+          # Evicts users from the user cache. Can completely clear the cache or evict specific users.
           #
           # @option arguments [List] :realms Comma-separated list of realms to clear
           # @option arguments [List] :usernames Comma-separated list of usernames to clear from the cache
-
+          # @option arguments [Hash] :headers Custom HTTP headers
           #
           # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-cache.html
           #
           def clear_cached_realms(arguments = {})
             raise ArgumentError, "Required argument 'realms' missing" unless arguments[:realms]
 
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _realms = arguments.delete(:realms)
@@ -28,7 +29,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/security/clear_cached_roles.rb

@@ -7,17 +7,18 @@ module Elasticsearch
     module API
       module Security
         module Actions
-          # TODO: Description
-
+          # Evicts roles from the native role cache.
           #
           # @option arguments [List] :name Role name
-
+          # @option arguments [Hash] :headers Custom HTTP headers
           #
           # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-role-cache.html
           #
           def clear_cached_roles(arguments = {})
             raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
 
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _name = arguments.delete(:name)
@@ -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/security/create_api_key.rb

@@ -7,12 +7,12 @@ module Elasticsearch
     module API
       module Security
         module Actions
-          # TODO: Description
-
+          # Creates an API key for access without requiring basic authentication.
           #
           # @option arguments [String] :refresh If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.
           #   (options: true,false,wait_for)
 
+          # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body The api key request to create an API key (*Required*)
           #
           # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-api-key.html
@@ -20,6 +20,8 @@ module Elasticsearch
           def create_api_key(arguments = {})
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
 
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             method = Elasticsearch::API::HTTP_PUT
@@ -27,7 +29,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.