elasticsearch-api 8.17.2 → 9.0.0

data/lib/elasticsearch/api/actions/watcher/query_watches.rb

@@ -15,19 +15,21 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Watcher
       module Actions
-        # Retrieves stored watches.
+        # Query watches.
+        # Get all registered watches in a paginated manner and optionally filter watches by a query.
+        # Note that only the +_id+ and +metadata.*+ fields are queryable or sortable.
         #
         # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body From, size, query, sort and search_after
+        # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/watcher-api-query-watches.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-watcher-query-watches
         #
         def query_watches(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'watcher.query_watches' }
@@ -35,7 +37,7 @@ module Elasticsearch
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          body   = arguments.delete(:body)
+          body = arguments.delete(:body)
 
           method = if body
                      Elasticsearch::API::HTTP_POST
@@ -43,7 +45,7 @@ module Elasticsearch
                      Elasticsearch::API::HTTP_GET
                    end
 
-          path = '_watcher/_query/watches'
+          path   = '_watcher/_query/watches'
           params = {}
 
           Elasticsearch::API::Response.new(

data/lib/elasticsearch/api/actions/watcher/start.rb

@@ -15,19 +15,20 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Watcher
       module Actions
-        # Starts Watcher if it is not already running.
+        # Start the watch service.
+        # Start the Watcher service if it is not already running.
         #
-        # @option arguments [Time] :master_timeout Specify timeout for connection to master
+        # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/watcher-api-start.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-watcher-start
         #
         def start(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'watcher.start' }
@@ -35,7 +36,7 @@ module Elasticsearch
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          body   = nil
+          body = nil
 
           method = Elasticsearch::API::HTTP_POST
           path   = '_watcher/_start'

data/lib/elasticsearch/api/actions/watcher/stats.rb

@@ -15,20 +15,22 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Watcher
       module Actions
-        # Retrieves the current Watcher metrics.
+        # Get Watcher statistics.
+        # This API always returns basic metrics.
+        # You retrieve more metrics by using the metric parameter.
         #
-        # @option arguments [List] :metric Controls what additional stat metrics should be include in the response (options: _all, queued_watches, current_watches, pending_watches)
-        # @option arguments [Boolean] :emit_stacktraces Emits stack traces of currently running watches
+        # @option arguments [Watchermetric] :metric Defines which additional metrics are included in the response.
+        # @option arguments [Boolean] :emit_stacktraces Defines whether stack traces are generated for each watch that is running.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/watcher-api-stats.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-watcher-stats
         #
         def stats(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'watcher.stats' }
@@ -47,7 +49,7 @@ module Elasticsearch
 
           method = Elasticsearch::API::HTTP_GET
           path   = if _metric
-                     "_watcher/stats/#{Utils.__listify(_metric)}"
+                     "_watcher/stats/#{Utils.listify(_metric)}"
                    else
                      '_watcher/stats'
                    end

data/lib/elasticsearch/api/actions/watcher/stop.rb

@@ -15,19 +15,22 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Watcher
       module Actions
-        # Stops Watcher if it is running.
+        # Stop the watch service.
+        # Stop the Watcher service if it is running.
         #
-        # @option arguments [Time] :master_timeout Specify timeout for connection to master
+        # @option arguments [Time] :master_timeout The period to wait for the master node.
+        #  If the master node is not available before the timeout expires, the request fails and returns an error.
+        #  To indicate that the request should never timeout, set it to +-1+. Server default: 30s.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/watcher-api-stop.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-watcher-stop
         #
         def stop(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'watcher.stop' }
@@ -35,7 +38,7 @@ module Elasticsearch
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          body   = nil
+          body = nil
 
           method = Elasticsearch::API::HTTP_POST
           path   = '_watcher/_stop'

data/lib/elasticsearch/api/actions/watcher/update_settings.rb

@@ -15,21 +15,29 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Watcher
       module Actions
-        # Update settings for the watcher system index
+        # Update Watcher index settings.
+        # Update settings for the Watcher internal index (+.watches+).
+        # Only a subset of settings can be modified.
+        # This includes +index.auto_expand_replicas+, +index.number_of_replicas+, +index.routing.allocation.exclude.*+,
+        # +index.routing.allocation.include.*+ and +index.routing.allocation.require.*+.
+        # Modification of +index.routing.allocation.include._tier_preference+ is an exception and is not allowed as the
+        # Watcher shards must always be in the +data_content+ tier.
         #
-        # @option arguments [Time] :timeout Specify timeout for waiting for acknowledgement from all nodes
-        # @option arguments [Time] :master_timeout Specify timeout for connection to master
+        # @option arguments [Time] :master_timeout The period to wait for a connection to the master node.
+        #  If no response is received before the timeout expires, the request fails and returns an error.
+        # @option arguments [Time] :timeout The period to wait for a response.
+        #  If no response is received before the timeout expires, the request fails and returns an error.
         # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body An object with the new index settings (*Required*)
+        # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/watcher-api-update-settings.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-watcher-update-settings
         #
         def update_settings(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'watcher.update_settings' }
@@ -39,7 +47,7 @@ module Elasticsearch
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          body   = arguments.delete(:body)
+          body = arguments.delete(:body)
 
           method = Elasticsearch::API::HTTP_PUT
           path   = '_watcher/settings'

data/lib/elasticsearch/api/actions/xpack/info.rb

@@ -15,21 +15,27 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module XPack
       module Actions
-        # Retrieves information about the installed X-Pack features.
+        # Get information.
+        # The information provided by the API includes:
+        # * Build information including the build number and timestamp.
+        # * License information about the currently installed license.
+        # * Feature information for the features that are currently enabled and available under the current license.
         #
-        # @option arguments [Boolean] :human Defines whether additional human-readable information is included in the response. In particular, it adds descriptions and a tag line. The default value is true.
-        # @option arguments [List] :categories Comma-separated list of info categories. Can be any of: build, license, features
-        # @option arguments [Boolean] :accept_enterprise If this param is used it must be set to true *Deprecated*
+        # @option arguments [Array<String>] :categories A comma-separated list of the information categories to include in the response.
+        #  For example, +build,license,features+.
+        # @option arguments [Boolean] :accept_enterprise If this param is used it must be set to true
+        # @option arguments [Boolean] :human Defines whether additional human-readable information is included in the response.
+        #  In particular, it adds descriptions and a tag line. Server default: true.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/info-api.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-info
         #
         def info(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'xpack.info' }
@@ -37,7 +43,7 @@ module Elasticsearch
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          body   = nil
+          body = nil
 
           method = Elasticsearch::API::HTTP_GET
           path   = '_xpack'

data/lib/elasticsearch/api/actions/xpack/usage.rb

@@ -15,19 +15,23 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module XPack
       module Actions
-        # Retrieves usage information about the installed X-Pack features.
+        # Get usage information.
+        # Get information about the features that are currently enabled and available under the current license.
+        # The API also provides some usage statistics.
         #
-        # @option arguments [Time] :master_timeout Specify timeout for watch write operation
+        # @option arguments [Time] :master_timeout The period to wait for a connection to the master node.
+        #  If no response is received before the timeout expires, the request fails and returns an error.
+        #  To indicate that the request should never timeout, set it to +-1+. Server default: 30s.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/usage-api.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-xpack
         #
         def usage(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'xpack.usage' }
@@ -35,7 +39,7 @@ module Elasticsearch
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          body   = nil
+          body = nil
 
           method = Elasticsearch::API::HTTP_GET
           path   = '_xpack/usage'

data/lib/elasticsearch/api/utils.rb

@@ -24,60 +24,62 @@ module Elasticsearch
       # URL-escape a string
       #
       # @example
-      #     __escape('foo/bar') # => 'foo%2Fbar'
-      #     __escape('bar^bam') # => 'bar%5Ebam'
+      #     escape('foo/bar') # => 'foo%2Fbar'
+      #     escape('bar^bam') # => 'bar%5Ebam'
       #
       # @api private
-      def __escape(string)
+      def escape(string)
         return string if string == '*'
+
         ERB::Util.url_encode(string.to_s)
       end
 
       # Create a "list" of values from arguments, ignoring nil values and encoding special characters.
       #
       # @example Create a list from array
-      #     __listify(['A','B']) # => 'A,B'
+      #     listify(['A','B']) # => 'A,B'
       #
       # @example Create a list from arguments
-      #     __listify('A','B') # => 'A,B'
+      #     listify('A','B') # => 'A,B'
       #
       # @example Escape values
-      #     __listify('foo','bar^bam') # => 'foo,bar%5Ebam'
+      #     listify('foo','bar^bam') # => 'foo,bar%5Ebam'
       #
       # @example Do not escape the values
-      #     __listify('foo','bar^bam', escape: false) # => 'foo,bar^bam'
+      #     listify('foo','bar^bam', escape: false) # => 'foo,bar^bam'
       #
       # @api private
-      def __listify(*list)
+      def listify(*list)
         options = list.last.is_a?(Hash) ? list.pop : {}
 
         escape = options[:escape]
-        Array(list).
-          flat_map { |e| e.respond_to?(:split) ? e.split(',') : e }.
-          flatten.
-          compact.
-          map { |e| escape == false ? e : __escape(e) }.
-          join(',')
+        Array(list)
+          .flat_map { |e| e.respond_to?(:split) ? e.split(',') : e }
+          .flatten
+          .compact
+          .map { |e| escape == false ? e : escape(e) }
+          .join(',')
       end
 
       # Create a path (URL part) from arguments, ignoring nil values and empty strings.
       #
       # @example Create a path from array
-      #     __pathify(['foo', '', nil, 'bar']) # => 'foo/bar'
+      #     pathify(['foo', '', nil, 'bar']) # => 'foo/bar'
       #
       # @example Create a path from arguments
-      #     __pathify('foo', '', nil, 'bar') # => 'foo/bar'
+      #     pathify('foo', '', nil, 'bar') # => 'foo/bar'
       #
       # # @example Encode special characters
-      #     __pathify(['foo', 'bar^bam']) # => 'foo/bar%5Ebam'
+      #     pathify(['foo', 'bar^bam']) # => 'foo/bar%5Ebam'
       #
       # @api private
-      def __pathify(*segments)
-        Array(segments).flatten.
-          compact.
-          reject { |s| s.to_s.strip.empty? }.
-          join('/').
-          squeeze('/')
+      def pathify(*segments)
+        Array(segments)
+          .flatten
+          .compact
+          .reject { |s| s.to_s.strip.empty? }
+          .join('/')
+          .squeeze('/')
       end
 
       # Convert an array of payloads into Elasticsearch `header\ndata` format
@@ -86,7 +88,7 @@ module Elasticsearch
       # or the conveniency "combined" format where data is passed along with the header
       # in a single item.
       #
-      #     Elasticsearch::API::Utils.__bulkify [
+      #     Elasticsearch::API::Utils.bulkify [
       #       { :index =>  { :_index => 'myindexA', :_type => 'mytype', :_id => '1', :data => { :title => 'Test' } } },
       #       { :update => { :_index => 'myindexB', :_type => 'mytype', :_id => '2', :data => { :doc => { :title => 'Update' } } } }
       #     ]
@@ -96,7 +98,7 @@ module Elasticsearch
       #     # => {"update":{"_index":"myindexB","_type":"mytype","_id":"2"}}
       #     # => {"doc":{"title":"Update"}}
       #
-      def __bulkify(payload)
+      def bulkify(payload)
         operations = %w[index create delete update]
 
         case
@@ -131,7 +133,7 @@ module Elasticsearch
 
       def process_params(arguments)
         arguments = Hash[arguments] unless arguments.is_a?(Hash)
-        Hash[arguments.map { |k, v| v.is_a?(Array) ? [k, __listify(v, { escape: false })] : [k, v] }] # Listify Arrays
+        Hash[arguments.map { |k, v| v.is_a?(Array) ? [k, listify(v, { escape: false })] : [k, v] }] # Listify Arrays
       end
 
       # Extracts the valid parts of the URL from the arguments
@@ -144,14 +146,14 @@ module Elasticsearch
       # @return [Array<String>]            Valid parts of the URL as an array of strings
       #
       # @example Extract parts
-      #   __extract_parts { :foo => true }, [:foo, :bar]
+      #   extract_parts { :foo => true }, [:foo, :bar]
       #   # => [:foo]
       #
       #
       # @api private
       #
-      def __extract_parts(arguments, valid_parts=[])
-        Hash[arguments].reduce([]) { |sum, item| k, v = item; v.is_a?(TrueClass) ? sum << k.to_s : sum << v  }
+      def extract_parts(arguments, _valid_parts = [])
+        Hash[arguments].reduce([]) { |sum, item| k, v = item; v.is_a?(TrueClass) ? sum << k.to_s : sum << v }
       end
 
       # Calls the given block, rescuing from `StandardError`.
@@ -165,7 +167,7 @@ module Elasticsearch
       #
       # @api private
       #
-      def __rescue_from_not_found(&block)
+      def rescue_from_not_found(&block)
         yield
       rescue StandardError => e
         if e.class.to_s =~ /NotFound/ || e.message =~ /Not\s*Found/i
@@ -175,63 +177,6 @@ module Elasticsearch
         end
       end
 
-      def __report_unsupported_parameters(arguments, params=[])
-        messages = []
-        unsupported_params = params.select {|d| d.is_a?(Hash) ? arguments.include?(d.keys.first) : arguments.include?(d) }
-
-        unsupported_params.each do |param|
-          name = case param
-          when Symbol
-            param
-          when Hash
-            param.keys.first
-          else
-            raise ArgumentError, "The param must be a Symbol or a Hash"
-          end
-
-          explanation = if param.is_a?(Hash)
-            ". #{param.values.first[:explanation]}."
-          else
-            ". This parameter is not supported in the version you're using: #{Elasticsearch::API::VERSION}, and will be removed in the next release."
-          end
-
-          message = "[!] You are using unsupported parameter [:#{name}]"
-
-          if source = caller && caller.last
-            message += " in `#{source}`"
-          end
-
-          message += explanation
-
-          messages << message
-        end
-
-        unless messages.empty?
-          messages << "Suppress this warning by the `-WO` command line flag."
-
-          if STDERR.tty?
-            Kernel.warn messages.map { |m| "\e[31;1m#{m}\e[0m" }.join("\n")
-          else
-            Kernel.warn messages.join("\n")
-          end
-        end
-      end
-
-      def __report_unsupported_method(name)
-        message = "[!] You are using unsupported method [#{name}]"
-        if source = caller && caller.last
-          message += " in `#{source}`"
-        end
-
-        message += ". This method is not supported in the version you're using: #{Elasticsearch::API::VERSION}, and will be removed in the next release. Suppress this warning by the `-WO` command line flag."
-
-        if STDERR.tty?
-          Kernel.warn "\e[31;1m#{message}\e[0m"
-        else
-          Kernel.warn message
-        end
-      end
-
       extend self
     end
   end

data/lib/elasticsearch/api/version.rb

@@ -17,6 +17,7 @@
 
 module Elasticsearch
   module API
-    VERSION = '8.17.2'.freeze
+    VERSION = '9.0.0'.freeze
+    ES_SPECIFICATION_COMMIT = '52c473efb1fb5320a5bac12572d0b285882862fb'.freeze
   end
 end