elasticsearch-api 2.0.2 → 5.0.0.pre

data/lib/elasticsearch/api/actions/cat/tasks.rb

@@ -14,12 +14,11 @@ module Elasticsearch
         # @option arguments [List] :h Comma-separated list of column names to display
         # @option arguments [Boolean] :help Return help information
         # @option arguments [Boolean] :v Verbose mode. Display column headers
+        # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
         #
         # @see http://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html
         #
         def tasks(arguments={})
-          Utils.__report_unsupported_method(__method__)
-
           valid_params = [
             :format,
             :node_id,
@@ -29,10 +28,9 @@ module Elasticsearch
             :parent_task,
             :h,
             :help,
-            :v ]
-
-          method = HTTP_GET
-
+            :v,
+            :s ]
+          method = 'GET'
           path   = "_cat/tasks"
           params = Utils.__validate_and_extract_params arguments, valid_params
           body   = nil

data/lib/elasticsearch/api/actions/cat/templates.rb

@@ -0,0 +1,39 @@
+module Elasticsearch
+  module API
+    module Cat
+      module Actions
+
+        # Returns information about existing templates
+        #
+        # @option arguments [String] :name A pattern that returned template names must match
+        # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
+        # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
+        # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
+        # @option arguments [List] :h Comma-separated list of column names to display
+        # @option arguments [Boolean] :help Return help information
+        # @option arguments [Boolean] :v Verbose mode. Display column headers
+        # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
+        #
+        # @see http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-templates.html
+        #
+        def templates(arguments={})
+          valid_params = [
+            :name,
+            :format,
+            :local,
+            :master_timeout,
+            :h,
+            :help,
+            :v,
+            :s ]
+          method = HTTP_GET
+          path   = "_cat/templates"
+          params = Utils.__validate_and_extract_params arguments, valid_params
+          body   = nil
+
+          perform_request(method, path, params, body).body
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/cat/thread_pool.rb

@@ -25,8 +25,11 @@ module Elasticsearch
         # @option arguments [Boolean] :full_id Display the complete node ID
         # @option arguments [String] :size The multiplier in which to display values
         #                                  (Options: k, m, g, t, p)
+        # @option arguments [List] :thread_pool_patterns A comma-separated list of regular expressions to filter
+        #                                                the thread pools in the output
         # @option arguments [List] :h Comma-separated list of column names to display -- see the `help` argument
         # @option arguments [Boolean] :v Display column headers as part of the output
+        # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
         # @option arguments [String] :format The output format. Options: 'text', 'json'; default: 'text'
         # @option arguments [Boolean] :help Return information about headers
         # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node
@@ -40,13 +43,12 @@ module Elasticsearch
             :full_id,
             :size,
             :local,
+            :thread_pool_patterns,
             :master_timeout,
             :h,
             :help,
-            :v ]
-
-          unsupported_params = [ :format, :size ]
-          Utils.__report_unsupported_parameters(arguments.keys, unsupported_params)
+            :v,
+            :s ]
 
           method = HTTP_GET
           path   = "_cat/thread_pool"

data/lib/elasticsearch/api/actions/cluster/allocation_explain.rb

@@ -7,15 +7,16 @@ module Elasticsearch
         #
         # @option arguments [Hash] :body The index, shard, and primary flag to explain. Empty means 'explain the first unassigned shard'
         # @option arguments [Boolean] :include_yes_decisions Return 'YES' decisions in explanation (default: false)
+        # @option arguments [Boolean] :include_disk_info Return information about disk usage and shard sizes
+        #                                                (default: false)
         #
         # @see http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-allocation-explain.html
         #
         def allocation_explain(arguments={})
-          Utils.__report_unsupported_method(__method__)
-
-          valid_params = [ :include_yes_decisions ]
-
-          method = HTTP_GET
+          valid_params = [
+            :include_yes_decisions,
+            :include_disk_info ]
+          method = 'GET'
           path   = "_cluster/allocation/explain"
           params = Utils.__validate_and_extract_params arguments, valid_params
           body   = arguments[:body]

data/lib/elasticsearch/api/actions/cluster/get_settings.rb

@@ -21,9 +21,6 @@ module Elasticsearch
             :include_defaults
           ]
 
-          unsupported_params = [ :include_defaults ]
-          Utils.__report_unsupported_parameters(arguments.keys, unsupported_params)
-
           method = HTTP_GET
           path   = "_cluster/settings"
           params = Utils.__validate_and_extract_params arguments, valid_params

data/lib/elasticsearch/api/actions/cluster/health.rb

@@ -24,8 +24,12 @@ module Elasticsearch
         # @option arguments [Number] :wait_for_nodes Wait until the specified number of nodes is available
         # @option arguments [Number] :wait_for_relocating_shards Wait until the specified number of relocating
         #                                                        shards is finished
+        # @option arguments [Boolean] :wait_for_no_relocating_shards Whether to wait until there are no relocating
+        #                                                            shards in the cluster
         # @option arguments [String] :wait_for_status Wait until cluster is in a specific state
         #                                             (options: green, yellow, red)
+        # @option arguments [List] :wait_for_events Wait until all currently queued events with the given priorty
+        #                                           are processed (immediate, urgent, high, normal, low, languid)
         #
         # @see http://elasticsearch.org/guide/reference/api/admin-cluster-health/
         #
@@ -41,7 +45,9 @@ module Elasticsearch
             :wait_for_active_shards,
             :wait_for_nodes,
             :wait_for_relocating_shards,
-            :wait_for_status ]
+            :wait_for_no_relocating_shards,
+            :wait_for_status,
+            :wait_for_events ]
 
           method = HTTP_GET
           path   = Utils.__pathify "_cluster/health", Utils.__listify(index)

data/lib/elasticsearch/api/actions/cluster/reroute.rb

@@ -34,9 +34,6 @@ module Elasticsearch
         def reroute(arguments={})
           valid_params = [ :dry_run, :explain, :metric, :master_timeout, :retry_failed, :timeout ]
 
-          unsupported_params = [ :retry_failed ]
-          Utils.__report_unsupported_parameters(arguments.keys, unsupported_params)
-
           method = HTTP_POST
           path   = "_cluster/reroute"
 

data/lib/elasticsearch/api/actions/delete_by_query.rb

@@ -43,8 +43,6 @@ module Elasticsearch
       # @see http://www.elasticsearch.org/guide/reference/api/delete-by-query/
       #
       def delete_by_query(arguments={})
-        Utils.__report_unsupported_method(__method__)
-
         raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
 
         valid_params = [

data/lib/elasticsearch/api/actions/explain.rb

@@ -39,6 +39,7 @@ module Elasticsearch
       #                                     or a list of fields to return
       # @option arguments [String] :_source_exclude A list of fields to exclude from the returned _source field
       # @option arguments [String] :_source_include A list of fields to extract and return from the _source field
+      # @option arguments [List] :stored_fields A comma-separated list of stored fields to return in the response
       #
       # @see http://elasticsearch.org/guide/reference/api/explain/
       #
@@ -62,7 +63,8 @@ module Elasticsearch
           :source,
           :_source,
           :_source_include,
-          :_source_exclude ]
+          :_source_exclude,
+          :stored_fields ]
 
         method = HTTP_GET
         path   = Utils.__pathify Utils.__escape(arguments[:index]),

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

@@ -29,6 +29,7 @@ module Elasticsearch
       # @option arguments [String] :_source_exclude A list of fields to exclude from the returned _source field
       # @option arguments [String] :_source_include A list of fields to extract and return from the _source field
       # @option arguments [Boolean] :_source_transform Retransform the source before returning it
+      # @option arguments [List] :stored_fields A comma-separated list of stored fields to return in the response
       #
       # @see http://elasticsearch.org/guide/reference/api/get/
       #
@@ -49,7 +50,8 @@ module Elasticsearch
           :_source,
           :_source_include,
           :_source_exclude,
-          :_source_transform]
+          :_source_transform,
+          :stored_fields ]
 
         method = HTTP_GET
         path   = Utils.__pathify Utils.__escape(arguments[:index]),

data/lib/elasticsearch/api/actions/index.rb

@@ -89,9 +89,6 @@ module Elasticsearch
           :version,
           :version_type ]
 
-        unsupported_params = [ :pipeline ]
-        Utils.__report_unsupported_parameters(arguments, unsupported_params)
-
         method = arguments[:id] ? HTTP_PUT : HTTP_POST
         path   = Utils.__pathify Utils.__escape(arguments[:index]),
                                  Utils.__escape(arguments[:type]),

data/lib/elasticsearch/api/actions/indices/create.rb

@@ -62,6 +62,7 @@ module Elasticsearch
         # @option arguments [Hash] :body Optional configuration for the index (`settings` and `mappings`)
         # @option arguments [Boolean] :update_all_types Whether to update the mapping for all fields
         #                                               with the same name across all types
+        # @option arguments [Number] :wait_for_active_shards Wait until the specified number of shards is active
         # @option arguments [Time] :timeout Explicit operation timeout
         # @option arguments [Boolean] :master_timeout Timeout for connection to master
         #
@@ -72,7 +73,8 @@ module Elasticsearch
           valid_params = [
             :timeout,
             :master_timeout,
-            :update_all_types
+            :update_all_types,
+            :wait_for_active_shards
           ]
 
           method = HTTP_PUT

data/lib/elasticsearch/api/actions/indices/get.rb

@@ -35,9 +35,6 @@ module Elasticsearch
             :human,
             :include_defaults ]
 
-          unsupported_params = [ :include_defaults ]
-          Utils.__report_unsupported_parameters(arguments.keys, unsupported_params)
-
           method = HTTP_GET
 
           path   = Utils.__pathify Utils.__listify(arguments[:index]), Utils.__listify(arguments.delete(:feature))

data/lib/elasticsearch/api/actions/indices/get_settings.rb

@@ -53,9 +53,6 @@ module Elasticsearch
             :local
           ]
 
-          unsupported_params = [ :include_defaults ]
-          Utils.__report_unsupported_parameters(arguments.keys, unsupported_params)
-
           method = HTTP_GET
           path   = Utils.__pathify Utils.__listify(arguments[:index]),
                                    Utils.__listify(arguments[:type]),

data/lib/elasticsearch/api/actions/indices/put_settings.rb

@@ -59,9 +59,6 @@ module Elasticsearch
             :flat_settings
           ]
 
-          unsupported_params = [ :preserve_existing ]
-          Utils.__report_unsupported_parameters(arguments.keys, unsupported_params)
-
           method = HTTP_PUT
           path   = Utils.__pathify Utils.__listify(arguments[:index]), '_settings'
           params = Utils.__validate_and_extract_params arguments, valid_params

data/lib/elasticsearch/api/actions/indices/rollover.rb

@@ -0,0 +1,41 @@
+module Elasticsearch
+  module API
+    module Indices
+      module Actions
+
+        # The rollover index API rolls an alias over to a new index when the existing index
+        # is considered to be too large or too old
+        #
+        # @option arguments [String] :alias The name of the alias to rollover (*Required*)
+        # @option arguments [String] :new_index The name of the rollover index
+        # @option arguments [Hash] :body The conditions that needs to be met for executing rollover
+        # @option arguments [Number] :wait_for_active_shards Wait until the specified number of shards is active
+        # @option arguments [Time] :timeout Explicit operation timeout
+        # @option arguments [Time] :master_timeout Specify timeout for connection to master
+        #
+        # @see http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-rollover-index.html
+        #
+        def rollover(arguments={})
+          raise ArgumentError, "Required argument 'alias' missing" unless arguments[:alias]
+
+          valid_params = [
+            :wait_for_active_shards,
+            :timeout,
+            :master_timeout ]
+
+          arguments = arguments.clone
+
+          source = arguments.delete(:alias)
+          target = arguments.delete(:new_index)
+
+          method = HTTP_POST
+          path   = Utils.__pathify source, '_rollover', target
+          params = Utils.__validate_and_extract_params arguments, valid_params
+          body   = arguments[:body]
+
+          perform_request(method, path, params, body).body
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/indices/shrink.rb

@@ -0,0 +1,45 @@
+module Elasticsearch
+  module API
+    module Indices
+      module Actions
+
+        # Copy an existing index into a new index with a fewer number of primary shards
+        #
+        # @option arguments [String] :index The name of the source index to shrink (*Required*)
+        # @option arguments [String] :target The name of the target index to shrink into (*Required*)
+        # @option arguments [Hash] :body The configuration for the target index (`settings` and `aliases`)
+        # @option arguments [Number] :wait_for_active_shards Wait until the specified number of shards is active
+        # @option arguments [Boolean] :wait_for_no_relocating_shards Whether to wait until there are no relocating
+        #                                                            shards in the cluster
+        # @option arguments [Time] :timeout Explicit operation timeout
+        # @option arguments [Time] :master_timeout Specify timeout for connection to master
+        #
+        # @see http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-shrink-index.html
+        #
+        def shrink(arguments={})
+          raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
+          raise ArgumentError, "Required argument 'target' missing" unless arguments[:target]
+
+          valid_params = [
+            :wait_for_active_shards,
+            :wait_for_no_relocating_shards,
+            :timeout,
+            :master_timeout
+          ]
+
+          arguments = arguments.clone
+
+          source = arguments.delete(:index)
+          target = arguments.delete(:target)
+
+          method = HTTP_PUT
+          path   = Utils.__pathify(source, '_shrink', target)
+          params = Utils.__validate_and_extract_params arguments, valid_params
+          body   = arguments[:body]
+
+          perform_request(method, path, params, body).body
+        end
+      end
+    end
+  end
+end

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

@@ -107,8 +107,8 @@ module Elasticsearch
           path   = Utils.__pathify Utils.__listify(arguments[:index]), '_stats', Utils.__listify(parts)
 
           params = Utils.__validate_and_extract_params arguments, valid_params
-          params[:fields] = Utils.__listify(params[:fields]) if params[:fields]
-          params[:groups] = Utils.__listify(params[:groups]) if params[:groups]
+          params[:fields] = Utils.__listify(params[:fields], :escape => false) if params[:fields]
+          params[:groups] = Utils.__listify(params[:groups], :escape => false) if params[:groups]
 
           body   = nil
 

data/lib/elasticsearch/api/actions/indices/validate_query.rb

@@ -13,12 +13,9 @@ module Elasticsearch
         #
         #     client.indices.validate_query index: 'myindex', q: '[[[ BOOM! ]]]', explain: true
         #
-        # @example Validate a DSL query (with explanation and rewrite). With rewrite set to true, the 
-        #                                explanation is more detailed showing the actual Lucene query that will 
-        #                                be executed.
+        # @example Validate a DSL query (with explanation)
         #
         #     client.indices.validate_query index: 'myindex',
-        #                                   rewrite: true,
         #                                   explain: true,
         #                                   body: {
         #                                     filtered: {
@@ -67,7 +64,6 @@ module Elasticsearch
         #
         def validate_query(arguments={})
           valid_params = [
-            :rewrite,
             :explain,
             :ignore_unavailable,
             :allow_no_indices,

data/lib/elasticsearch/api/actions/ingest/delete_pipeline.rb

@@ -12,15 +12,11 @@ module Elasticsearch
         # @see https://www.elastic.co/guide/en/elasticsearch/plugins/master/ingest.html
         #
         def delete_pipeline(arguments={})
-          Utils.__report_unsupported_method(__method__)
-
           raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
-
           valid_params = [
             :master_timeout,
             :timeout ]
-
-          method = HTTP_DELETE
+          method = 'DELETE'
           path   = Utils.__pathify "_ingest/pipeline", Utils.__escape(arguments[:id])
           params = Utils.__validate_and_extract_params arguments, valid_params
           body   = nil

data/lib/elasticsearch/api/actions/ingest/get_pipeline.rb

@@ -5,20 +5,15 @@ module Elasticsearch
 
         # Return a specified pipeline
         #
-        # @option arguments [String] :id Comma separated list of pipeline ids. Wildcards supported (*Required*)
+        # @option arguments [String] :id Comma separated list of pipeline ids (wildcards supported).
         # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
         #
         # @see https://www.elastic.co/guide/en/elasticsearch/plugins/master/ingest.html
         #
         def get_pipeline(arguments={})
-          Utils.__report_unsupported_method(__method__)
-
-          raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
-
           valid_params = [
             :master_timeout ]
-
-          method = HTTP_GET
+          method = 'GET'
           path   = Utils.__pathify "_ingest/pipeline", Utils.__escape(arguments[:id])
           params = Utils.__validate_and_extract_params arguments, valid_params
           body   = nil

data/lib/elasticsearch/api/actions/ingest/put_pipeline.rb

@@ -13,16 +13,12 @@ module Elasticsearch
         # @see https://www.elastic.co/guide/en/elasticsearch/plugins/master/ingest.html
         #
         def put_pipeline(arguments={})
-          Utils.__report_unsupported_method(__method__)
-
           raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
           raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
-
           valid_params = [
             :master_timeout,
             :timeout ]
-
-          method = HTTP_PUT
+          method = 'PUT'
           path   = Utils.__pathify "_ingest/pipeline", Utils.__escape(arguments[:id])
 
           params = Utils.__validate_and_extract_params arguments, valid_params