[X-Pack] Generate X-Pack API code

Author: picandocodigo

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/async_search/delete.rb

@@ -7,17 +7,18 @@ module XPack
     module API
       module AsyncSearch
         module Actions
-          # TODO: Description
-
+          # Deletes an async search by ID. If the search is still running, the search request will be cancelled. Otherwise, the saved search results are deleted.
           #
           # @option arguments [String] :id The async search ID
-
+          # @option arguments [Hash] :headers Custom HTTP headers
           #
           # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html
           #
           def delete(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 @@ def delete(arguments = {})
             params = {}
 
             body = nil
-            perform_request(method, path, params, body).body
+            perform_request(method, path, params, body, headers).body
           end
       end
     end

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/async_search/get.rb

@@ -7,20 +7,21 @@ module XPack
     module API
       module AsyncSearch
         module Actions
-          # TODO: Description
-
+          # Retrieves the results of a previously submitted async search request given its ID.
           #
           # @option arguments [String] :id The async search ID
           # @option arguments [Time] :wait_for_completion_timeout Specify the time that the request should block waiting for the final response
           # @option arguments [Time] :keep_alive Specify the time interval in which the results (partial or final) for this search will be available
           # @option arguments [Boolean] :typed_keys Specify whether aggregation and suggester names should be prefixed by their respective types in the response
-
+          # @option arguments [Hash] :headers Custom HTTP headers
           #
           # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html
           #
           def get(arguments = {})
             raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
 
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _id = arguments.delete(:id)
@@ -30,7 +31,7 @@ def get(arguments = {})
             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.

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/async_search/submit.rb

@@ -7,8 +7,7 @@ module XPack
     module API
       module AsyncSearch
         module Actions
-          # TODO: Description
-
+          # Executes a search request asynchronously.
           #
           # @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 [Time] :wait_for_completion_timeout Specify the time that the request should block waiting for the final response
@@ -30,7 +29,7 @@ module Actions
           # @option arguments [Boolean] :ignore_throttled Whether specified concrete, expanded or aliased indices should be ignored when throttled
           # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
           # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
-          #   (options: open,closed,none,all)
+          #   (options: open,closed,hidden,none,all)
 
           # @option arguments [Boolean] :lenient Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
           # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random)
@@ -60,12 +59,14 @@ module Actions
           # @option arguments [Boolean] :version Specify whether to return document version as part of a hit
           # @option arguments [Boolean] :seq_no_primary_term Specify whether to return sequence number and primary term of the last modification of each hit
           # @option arguments [Number] :max_concurrent_shard_requests The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests
-
+          # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body The search definition using the Query DSL
           #
           # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html
           #
           def submit(arguments = {})
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _index = arguments.delete(:index)
@@ -75,11 +76,11 @@ def submit(arguments = {})
                        "#{Elasticsearch::API::Utils.__listify(_index)}/_async_search"
                      else
                        "_async_search"
-  end
+            end
             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.

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/cat/ml_data_frame_analytics.rb

@@ -7,8 +7,7 @@ module XPack
     module API
       module Cat
         module Actions
-          # TODO: Description
-
+          # Gets configuration and usage information about data frame analytics jobs.
           #
           # @option arguments [String] :id The ID of the data frame analytics to fetch
           # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no configs. (This includes `_all` string or when no configs have been specified)
@@ -20,14 +19,16 @@ module Actions
           # @option arguments [Boolean] :help Return help information
           # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
           # @option arguments [String] :time The unit in which to display time values
-          #   (options: d (Days),h (Hours),m (Minutes),s (Seconds),ms (Milliseconds),micros (Microseconds),nanos (Nanoseconds))
+          #   (options: d,h,m,s,ms,micros,nanos)
 
           # @option arguments [Boolean] :v Verbose mode. Display column headers
-
+          # @option arguments [Hash] :headers Custom HTTP headers
           #
           # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-dfanalytics.html
           #
           def ml_data_frame_analytics(arguments = {})
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _id = arguments.delete(:id)
@@ -37,11 +38,11 @@ def ml_data_frame_analytics(arguments = {})
                        "_cat/ml/data_frame/analytics/#{Elasticsearch::API::Utils.__listify(_id)}"
                      else
                        "_cat/ml/data_frame/analytics"
-  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.

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/cat/ml_datafeeds.rb

@@ -7,8 +7,7 @@ module XPack
     module API
       module Cat
         module Actions
-          # TODO: Description
-
+          # Gets configuration and usage information about datafeeds.
           #
           # @option arguments [String] :datafeed_id The ID of the datafeeds stats to fetch
           # @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)
@@ -17,14 +16,16 @@ module Actions
           # @option arguments [Boolean] :help Return help information
           # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
           # @option arguments [String] :time The unit in which to display time values
-          #   (options: d (Days),h (Hours),m (Minutes),s (Seconds),ms (Milliseconds),micros (Microseconds),nanos (Nanoseconds))
+          #   (options: d,h,m,s,ms,micros,nanos)
 
           # @option arguments [Boolean] :v Verbose mode. Display column headers
-
+          # @option arguments [Hash] :headers Custom HTTP headers
           #
           # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-datafeeds.html
           #
           def ml_datafeeds(arguments = {})
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _datafeed_id = arguments.delete(:datafeed_id)
@@ -34,11 +35,11 @@ def ml_datafeeds(arguments = {})
                        "_cat/ml/datafeeds/#{Elasticsearch::API::Utils.__listify(_datafeed_id)}"
                      else
                        "_cat/ml/datafeeds"
-  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.

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/cat/ml_jobs.rb

@@ -7,8 +7,7 @@ module XPack
     module API
       module Cat
         module Actions
-          # TODO: Description
-
+          # Gets configuration and usage information about anomaly detection jobs.
           #
           # @option arguments [String] :job_id The ID of the jobs stats 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)
@@ -20,14 +19,16 @@ module Actions
           # @option arguments [Boolean] :help Return help information
           # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
           # @option arguments [String] :time The unit in which to display time values
-          #   (options: d (Days),h (Hours),m (Minutes),s (Seconds),ms (Milliseconds),micros (Microseconds),nanos (Nanoseconds))
+          #   (options: d,h,m,s,ms,micros,nanos)
 
           # @option arguments [Boolean] :v Verbose mode. Display column headers
-
+          # @option arguments [Hash] :headers Custom HTTP headers
           #
           # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-anomaly-detectors.html
           #
           def ml_jobs(arguments = {})
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _job_id = arguments.delete(:job_id)
@@ -37,11 +38,11 @@ def ml_jobs(arguments = {})
                        "_cat/ml/anomaly_detectors/#{Elasticsearch::API::Utils.__listify(_job_id)}"
                      else
                        "_cat/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.

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/cat/ml_trained_models.rb

@@ -7,8 +7,7 @@ module XPack
     module API
       module Cat
         module Actions
-          # TODO: Description
-
+          # Gets configuration and usage information about inference trained 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)
@@ -22,14 +21,16 @@ module Actions
           # @option arguments [Boolean] :help Return help information
           # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
           # @option arguments [String] :time The unit in which to display time values
-          #   (options: d (Days),h (Hours),m (Minutes),s (Seconds),ms (Milliseconds),micros (Microseconds),nanos (Nanoseconds))
+          #   (options: d,h,m,s,ms,micros,nanos)
 
           # @option arguments [Boolean] :v Verbose mode. Display column headers
-
+          # @option arguments [Hash] :headers Custom HTTP headers
           #
           # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-trained-model.html
           #
           def ml_trained_models(arguments = {})
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _model_id = arguments.delete(:model_id)
@@ -39,11 +40,11 @@ def ml_trained_models(arguments = {})
                        "_cat/ml/trained_models/#{Elasticsearch::API::Utils.__listify(_model_id)}"
                      else
                        "_cat/ml/trained_models"
-  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.

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/cat/transforms.rb

@@ -0,0 +1,65 @@
+# 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
+
+module Elasticsearch
+  module XPack
+    module API
+      module Cat
+        module Actions
+          # Gets configuration and usage information about transforms.
+          #
+          # @option arguments [String] :transform_id The id of the transform for which to get stats. '_all' or '*' implies all transforms
+          # @option arguments [Int] :from skips a number of transform configs, defaults to 0
+          # @option arguments [Int] :size specifies a max number of transforms to get, defaults to 100
+          # @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 [String] :format a short version of the Accept header, e.g. json, yaml
+          # @option arguments [List] :h Comma-separated list of column names to display
+          # @option arguments [Boolean] :help Return help information
+          # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
+          # @option arguments [String] :time The unit in which to display time values
+          #   (options: d,h,m,s,ms,micros,nanos)
+
+          # @option arguments [Boolean] :v Verbose mode. Display column headers
+          # @option arguments [Hash] :headers Custom HTTP headers
+          #
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-transforms.html
+          #
+          def transforms(arguments = {})
+            headers = arguments.delete(:headers) || {}
+
+            arguments = arguments.clone
+
+            _transform_id = arguments.delete(:transform_id)
+
+            method = Elasticsearch::API::HTTP_GET
+            path   = if _transform_id
+                       "_cat/transforms/#{Elasticsearch::API::Utils.__listify(_transform_id)}"
+                     else
+                       "_cat/transforms"
+            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(:transforms, [
+            :from,
+            :size,
+            :allow_no_match,
+            :format,
+            :h,
+            :help,
+            :s,
+            :time,
+            :v
+          ].freeze)
+      end
+    end
+    end
+  end
+end

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/data_frame_transform_deprecated/delete_transform.rb

@@ -7,12 +7,11 @@ module XPack
     module API
       module DataFrameTransformDeprecated
         module Actions
-          # TODO: Description
-
+          # Deletes an existing transform.
           #
           # @option arguments [String] :transform_id The id of the transform to delete
           # @option arguments [Boolean] :force When `true`, the transform is deleted regardless of its current state. The default value is `false`, meaning that the transform must be `stopped` before it can be deleted.
-
+          # @option arguments [Hash] :headers Custom HTTP headers
           #
           # *Deprecation notice*:
           # [_data_frame/transforms/] is deprecated, use [_transform/] in the future.
@@ -24,6 +23,8 @@ module Actions
           def delete_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)
@@ -33,7 +34,7 @@ def delete_transform(arguments = {})
             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.