elasticsearch-xpack 7.8.0 → 7.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97185d59f88aff4dfcdfbda7d1c6f128557bef55ad0f6cb1a5c0bef8c25a98d6
-  data.tar.gz: 293663611871cad18f5a0eb9feb68e554d761c571795407537ff58a61ce7e255
+  metadata.gz: d70fd28e0a1ebd707b7e4447f5bef68ed4651d723dfb59101cbe82f8738c6b43
+  data.tar.gz: e1d5e088fb4eaa17976d668fe7cbc3bc8fc84fdac8a06ae19fc7b1a0bc18392b
 SHA512:
-  metadata.gz: d47de0ba3e4044d6936c0b2c915e525279a5905f8e1d8c2f62490587da887bf3f0ae8b857988b3a26b00f9d394579749d724bc1ae6694414dae9115d02bf8d90
-  data.tar.gz: 3ffe1a66e08d3cb964dcb16c73ccf6394e1c420af6326b517ca1fd71bce056d438f578806e18ea3f22cf0df29ca9332b2e4471e57b015b060f7d62544dd917bb
+  metadata.gz: ad3ffcfa953810aeba576fbd1a83a1ad45f668f24a05e502da4d2d303f3dd040b64f99e3b7631922e955a1871f4dd3d28ca184151e2caa310737d62ef4dede5a
+  data.tar.gz: 588aa81f66b66e57e493ac922ee468adefebdd3e240548ce25f03d68e558be7a21bc4fcc3395a718c6d6cd78fb7d26bc7f6374e43f52b1f810fc9c35227b542a

data/Rakefile

@@ -16,11 +16,9 @@
 # under the License.
 
 require 'bundler/gem_tasks'
-
 require 'rake/testtask'
 require 'rspec/core/rake_task'
 
-
 task :default do
   exec "rake --tasks"
 end
@@ -33,13 +31,12 @@ Rake::TestTask.new('test:unit') do |test|
 end
 
 namespace :test do
-
   RSpec::Core::RakeTask.new(:spec)
 
-  desc "Run rest api yaml tests"
-  Rake::TestTask.new(:rest_api)  do |test|
+  desc 'Run rest api yaml tests'
+  Rake::TestTask.new(:rest_api) do |test|
     `rm Gemfile.lock`
-    test.deps = [ :spec ]
+    test.deps = [:spec]
   end
 
   desc "Run integration tests"

data/lib/elasticsearch/xpack.rb

@@ -15,9 +15,9 @@
 # specific language governing permissions and limitations
 # under the License.
 
-require "elasticsearch/api"
-require "elasticsearch/xpack/version"
-require "elasticsearch/xpack/api/actions/params_registry"
+require 'elasticsearch/api'
+require 'elasticsearch/xpack/version'
+require 'elasticsearch/xpack/api/actions/params_registry'
 
 Dir[ File.expand_path('../xpack/api/actions/**/params_registry.rb', __FILE__) ].each   { |f| require f }
 Dir[ File.expand_path('../xpack/api/actions/**/*.rb', __FILE__) ].each   { |f| require f }
@@ -112,6 +112,34 @@ module Elasticsearch
       def searchable_snapshots
         @searchable_snapshots ||= xpack.searchable_snapshots
       end
+
+      def cross_cluster_replication
+        @cross_cluster_replication ||= xpack.cross_cluster_replication
+      end
+
+      def autoscaling
+        @autoscaling ||= xpack.autoscaling
+      end
+
+      def enrich
+        @enrich ||= xpack.enrich
+      end
+
+      def eql
+        @eql ||= xpack.eql
+      end
+
+      def snapshot_lifecycle_management
+        @snapshot_lifecycle_management ||= xpack.snapshot_lifecycle_management
+      end
+
+      def open_point_in_time(arguments = {})
+        xpack.open_point_in_time(arguments)
+      end
+
+      def close_point_in_time(arguments = {})
+        xpack.close_point_in_time(arguments)
+      end
     end
   end
 end if defined?(Elasticsearch::Transport::Client)

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

@@ -25,7 +25,7 @@ module Elasticsearch
           # @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.8/async-search.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/async-search.html
           #
           def delete(arguments = {})
             raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
@@ -43,8 +43,8 @@ module Elasticsearch
             body = nil
             perform_request(method, path, params, body, headers).body
           end
+        end
       end
     end
-    end
   end
 end

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

@@ -28,7 +28,7 @@ module Elasticsearch
           # @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/7.8/async-search.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/async-search.html
           #
           def get(arguments = {})
             raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
@@ -55,8 +55,8 @@ module Elasticsearch
             :keep_alive,
             :typed_keys
           ].freeze)
+        end
       end
     end
-    end
   end
 end

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

@@ -30,9 +30,7 @@ module Elasticsearch
           # @option arguments [Boolean] :request_cache Specify if request cache should be used for this request or not, defaults to true
           # @option arguments [String] :analyzer The analyzer to use for the query string
           # @option arguments [Boolean] :analyze_wildcard Specify whether wildcard and prefix queries should be analyzed (default: false)
-          # @option arguments [String] :default_operator The default operator for query string query (AND or OR)
-          #   (options: AND,OR)
-
+          # @option arguments [String] :default_operator The default operator for query string query (AND or OR) (options: AND, OR)
           # @option arguments [String] :df The field to use as default where no field prefix is given in the query string
           # @option arguments [Boolean] :explain Specify whether to return detailed information about score computation as part of a hit
           # @option arguments [List] :stored_fields A comma-separated list of stored fields to return as part of a hit
@@ -41,16 +39,12 @@ module Elasticsearch
           # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
           # @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,hidden,none,all)
-
+          # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (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)
           # @option arguments [String] :q Query in the Lucene query string syntax
           # @option arguments [List] :routing A comma-separated list of specific routing values
-          # @option arguments [String] :search_type Search operation type
-          #   (options: query_then_fetch,dfs_query_then_fetch)
-
+          # @option arguments [String] :search_type Search operation type (options: query_then_fetch, dfs_query_then_fetch)
           # @option arguments [Number] :size Number of hits to return (default: 10)
           # @option arguments [List] :sort A comma-separated list of <field>:<direction> pairs
           # @option arguments [List] :_source True or false to return the _source field or not, or a list of fields to return
@@ -59,9 +53,7 @@ module Elasticsearch
           # @option arguments [Number] :terminate_after The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.
           # @option arguments [List] :stats Specific 'tag' of the request for logging and statistical purposes
           # @option arguments [String] :suggest_field Specify which field to use for suggestions
-          # @option arguments [String] :suggest_mode Specify suggest mode
-          #   (options: missing,popular,always)
-
+          # @option arguments [String] :suggest_mode Specify suggest mode (options: missing, popular, always)
           # @option arguments [Number] :suggest_size How many suggestions to return in response
           # @option arguments [String] :suggest_text The source text for which the suggestions should be returned
           # @option arguments [Time] :timeout Explicit operation timeout
@@ -75,7 +67,7 @@ module Elasticsearch
           # @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/7.8/async-search.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/async-search.html
           #
           def submit(arguments = {})
             headers = arguments.delete(:headers) || {}
@@ -89,7 +81,7 @@ module Elasticsearch
                        "#{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]
@@ -142,8 +134,8 @@ module Elasticsearch
             :seq_no_primary_term,
             :max_concurrent_shard_requests
           ].freeze)
+        end
       end
     end
-    end
   end
 end

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

@@ -0,0 +1,54 @@
+# 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 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.
+          #
+          # @option arguments [String] :name the name of the autoscaling policy
+          # @option arguments [Hash] :headers Custom HTTP headers
+          #
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/autoscaling-delete-autoscaling-policy.html
+          #
+          def delete_autoscaling_policy(arguments = {})
+            raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
+
+            headers = arguments.delete(:headers) || {}
+
+            arguments = arguments.clone
+
+            _name = arguments.delete(:name)
+
+            method = Elasticsearch::API::HTTP_DELETE
+            path   = "_autoscaling/policy/#{Elasticsearch::API::Utils.__listify(_name)}"
+            params = {}
+
+            body = nil
+            perform_request(method, path, params, body, headers).body
+          end
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/xpack/api/actions/autoscaling/get_autoscaling_decision.rb

@@ -0,0 +1,49 @@
+# 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 Autoscaling
+        module Actions
+          # Gets the current autoscaling decision based on the configured autoscaling policy, indicating whether or not autoscaling is needed.
+          # 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 [Hash] :headers Custom HTTP headers
+          #
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/autoscaling-get-autoscaling-decision.html
+          #
+          def get_autoscaling_decision(arguments = {})
+            headers = arguments.delete(:headers) || {}
+
+            arguments = arguments.clone
+
+            method = Elasticsearch::API::HTTP_GET
+            path   = "_autoscaling/decision"
+            params = {}
+
+            body = nil
+            perform_request(method, path, params, body, headers).body
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+# 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 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.
+          #
+          # @option arguments [String] :name the name of the autoscaling policy
+          # @option arguments [Hash] :headers Custom HTTP headers
+          #
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/autoscaling-get-autoscaling-policy.html
+          #
+          def get_autoscaling_policy(arguments = {})
+            raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
+
+            headers = arguments.delete(:headers) || {}
+
+            arguments = arguments.clone
+
+            _name = arguments.delete(:name)
+
+            method = Elasticsearch::API::HTTP_GET
+            path   = "_autoscaling/policy/#{Elasticsearch::API::Utils.__listify(_name)}"
+            params = {}
+
+            body = nil
+            perform_request(method, path, params, body, headers).body
+          end
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/xpack/api/actions/autoscaling/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 Autoscaling
+        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

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

@@ -0,0 +1,56 @@
+# 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 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.
+          #
+          # @option arguments [String] :name the name of the autoscaling policy
+          # @option arguments [Hash] :headers Custom HTTP headers
+          # @option arguments [Hash] :body the specification of the autoscaling policy (*Required*)
+          #
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/autoscaling-put-autoscaling-policy.html
+          #
+          def put_autoscaling_policy(arguments = {})
+            raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+            raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
+
+            headers = arguments.delete(:headers) || {}
+
+            arguments = arguments.clone
+
+            _name = arguments.delete(:name)
+
+            method = Elasticsearch::API::HTTP_PUT
+            path   = "_autoscaling/policy/#{Elasticsearch::API::Utils.__listify(_name)}"
+            params = {}
+
+            body = arguments[:body]
+            perform_request(method, path, params, body, headers).body
+          end
+        end
+      end
+    end
+  end
+end