[XPACK] Update APIs

Author: picandocodigo

elasticsearch-xpack/lib/elasticsearch/xpack.rb

@@ -152,6 +152,10 @@ def eql
       def snapshot_lifecycle_management
         @snapshot_lifecycle_management ||= xpack.snapshot_lifecycle_management
       end
+
+      def text_structure
+        @text_structure ||= xpack.text_structure
+      end
     end
   end
 end if defined?(Elasticsearch::Transport::Client)

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/autoscaling/delete_autoscaling_policy.rb

@@ -20,11 +20,7 @@ module XPack
     module API
       module Autoscaling
         module Actions
-          # Deletes an autoscaling policy.
-          # This functionality is Experimental and may be changed or removed
-          # completely in a future release. Elastic will take a best effort approach
-          # to fix any issues, but experimental features are not subject to the
-          # support SLA of official GA features.
+          # Deletes an autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.
           #
           # @option arguments [String] :name the name of the autoscaling policy
           # @option arguments [Hash] :headers Custom HTTP headers

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/autoscaling/get_autoscaling_capacity.rb

@@ -20,11 +20,7 @@ module XPack
     module API
       module Autoscaling
         module Actions
-          # Gets the current autoscaling capacity based on the configured autoscaling policy.
-          # This functionality is Experimental and may be changed or removed
-          # completely in a future release. Elastic will take a best effort approach
-          # to fix any issues, but experimental features are not subject to the
-          # support SLA of official GA features.
+          # Gets the current autoscaling capacity based on the configured autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.
           #
           # @option arguments [Hash] :headers Custom HTTP headers
           #

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/autoscaling/get_autoscaling_policy.rb

@@ -20,11 +20,7 @@ module XPack
     module API
       module Autoscaling
         module Actions
-          # Retrieves an autoscaling policy.
-          # This functionality is Experimental and may be changed or removed
-          # completely in a future release. Elastic will take a best effort approach
-          # to fix any issues, but experimental features are not subject to the
-          # support SLA of official GA features.
+          # Retrieves an autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.
           #
           # @option arguments [String] :name the name of the autoscaling policy
           # @option arguments [Hash] :headers Custom HTTP headers

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/autoscaling/put_autoscaling_policy.rb

@@ -20,11 +20,7 @@ module XPack
     module API
       module Autoscaling
         module Actions
-          # Creates a new autoscaling policy.
-          # This functionality is Experimental and may be changed or removed
-          # completely in a future release. Elastic will take a best effort approach
-          # to fix any issues, but experimental features are not subject to the
-          # support SLA of official GA features.
+          # Creates a new autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.
           #
           # @option arguments [String] :name the name of the autoscaling policy
           # @option arguments [Hash] :headers Custom HTTP headers

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/eql/get_status.rb

@@ -0,0 +1,50 @@
+# 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 Eql
+        module Actions
+          # Returns the status of a previously submitted async or stored Event Query Language (EQL) search
+          #
+          # @option arguments [String] :id The async search ID
+          # @option arguments [Hash] :headers Custom HTTP headers
+          #
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/eql-search-api.html
+          #
+          def get_status(arguments = {})
+            raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
+
+            headers = arguments.delete(:headers) || {}
+
+            arguments = arguments.clone
+
+            _id = arguments.delete(:id)
+
+            method = Elasticsearch::API::HTTP_GET
+            path   = "_eql/search/status/#{Elasticsearch::API::Utils.__listify(_id)}"
+            params = {}
+
+            body = nil
+            perform_request(method, path, params, body, headers).body
+          end
+        end
+      end
+    end
+  end
+end

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/searchable_snapshots/mount.rb

@@ -30,6 +30,7 @@ module Actions
           # @option arguments [String] :snapshot The name of the snapshot of the index to mount
           # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
           # @option arguments [Boolean] :wait_for_completion Should this request wait until the operation has completed before returning
+          # @option arguments [String] :storage Selects the kind of local storage used to accelerate searches. Experimental, and defaults to `full_copy`
           # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body The restore configuration for mounting the snapshot as searchable (*Required*)
           #
@@ -61,7 +62,8 @@ def mount(arguments = {})
           # @since 6.2.0
           ParamsRegistry.register(:mount, [
             :master_timeout,
-            :wait_for_completion
+            :wait_for_completion,
+            :storage
           ].freeze)
         end
       end

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/searchable_snapshots/stats.rb

@@ -27,6 +27,7 @@ module Actions
           # support SLA of official GA features.
           #
           # @option arguments [List] :index A comma-separated list of index names
+          # @option arguments [String] :level Return stats aggregated at cluster, index or shard level (options: cluster, indices, shards)
           # @option arguments [Hash] :headers Custom HTTP headers
           #
           # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/searchable-snapshots-apis.html
@@ -44,11 +45,18 @@ def stats(arguments = {})
                      else
                        "_searchable_snapshots/stats"
                      end
-            params = {}
+            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(:stats, [
+            :level
+          ].freeze)
         end
       end
     end

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/text_structure/find_structure.rb

@@ -0,0 +1,86 @@
+# 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 TextStructure
+        module Actions
+          # Finds the structure of a text file. The text file must contain data that is suitable to be ingested into Elasticsearch.
+          # This functionality is Experimental and may be changed or removed
+          # completely in a future release. Elastic will take a best effort approach
+          # to fix any issues, but experimental features are not subject to the
+          # support SLA of official GA features.
+          #
+          # @option arguments [Int] :lines_to_sample How many lines of the file should be included in the analysis
+          # @option arguments [Int] :line_merge_size_limit Maximum number of characters permitted in a single message when lines are merged to create messages.
+          # @option arguments [Time] :timeout Timeout after which the analysis will be aborted
+          # @option arguments [String] :charset Optional parameter to specify the character set of the file
+          # @option arguments [String] :format Optional parameter to specify the high level file format (options: ndjson, xml, delimited, semi_structured_text)
+          # @option arguments [Boolean] :has_header_row Optional parameter to specify whether a delimited file includes the column names in its first row
+          # @option arguments [List] :column_names Optional parameter containing a comma separated list of the column names for a delimited file
+          # @option arguments [String] :delimiter Optional parameter to specify the delimiter character for a delimited file - must be a single character
+          # @option arguments [String] :quote Optional parameter to specify the quote character for a delimited file - must be a single character
+          # @option arguments [Boolean] :should_trim_fields Optional parameter to specify whether the values between delimiters in a delimited file should have whitespace trimmed from them
+          # @option arguments [String] :grok_pattern Optional parameter to specify the Grok pattern that should be used to extract fields from messages in a semi-structured text file
+          # @option arguments [String] :timestamp_field Optional parameter to specify the timestamp field in the file
+          # @option arguments [String] :timestamp_format Optional parameter to specify the timestamp format in the file - may be either a Joda or Java time format
+          # @option arguments [Boolean] :explain Whether to include a commentary on how the structure was derived
+          # @option arguments [Hash] :headers Custom HTTP headers
+          # @option arguments [Hash] :body The contents of the file to be analyzed (*Required*)
+          #
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/find-structure.html
+          #
+          def find_structure(arguments = {})
+            raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+
+            headers = arguments.delete(:headers) || {}
+
+            arguments = arguments.clone
+
+            method = Elasticsearch::API::HTTP_POST
+            path   = "_text_structure/find_structure"
+            params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+
+            body = arguments[: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(:find_structure, [
+            :lines_to_sample,
+            :line_merge_size_limit,
+            :timeout,
+            :charset,
+            :format,
+            :has_header_row,
+            :column_names,
+            :delimiter,
+            :quote,
+            :should_trim_fields,
+            :grok_pattern,
+            :timestamp_field,
+            :timestamp_format,
+            :explain
+          ].freeze)
+        end
+      end
+    end
+  end
+end

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/text_structure/params_registry.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 TextStructure
+        module Actions
+          module ParamsRegistry
+            extend self
+
+            # A Mapping of all the actions to their list of valid params.
+            #
+            # @since 7.4.0
+            PARAMS = {}
+
+            # Register an action with its list of valid params.
+            #
+            # @example Register the action.
+            #   ParamsRegistry.register(:benchmark, [ :verbose ])
+            #
+            # @param [ Symbol ] action The action to register.
+            # @param [ Array[Symbol] ] valid_params The list of valid params.
+            #
+            # @since 7.4.0
+            def register(action, valid_params)
+              PARAMS[action.to_sym] = valid_params
+            end
+
+            # Get the list of valid params for a given action.
+            #
+            # @example Get the list of valid params.
+            #   ParamsRegistry.get(:benchmark)
+            #
+            # @param [ Symbol ] action The action.
+            #
+            # @return [ Array<Symbol> ] The list of valid params for the action.
+            #
+            # @since 7.4.0
+            def get(action)
+              PARAMS.fetch(action, [])
+            end
+          end
+        end
+      end
+    end
+  end
+end