elasticsearch-api 1.0.17 → 1.0.18

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

@@ -0,0 +1,29 @@
+module Elasticsearch
+  module API
+    module Ingest
+      module Actions
+
+        # Delete a speficied pipeline
+        #
+        # @option arguments [String] :id Pipeline ID (*Required*)
+        # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
+        # @option arguments [Time] :timeout Explicit operation timeout
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/plugins/master/ingest.html
+        #
+        def delete_pipeline(arguments={})
+          raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
+          valid_params = [
+            :master_timeout,
+            :timeout ]
+          method = 'DELETE'
+          path   = Utils.__pathify "_ingest/pipeline", Utils.__escape(arguments[:id])
+          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/ingest/get_pipeline.rb

@@ -0,0 +1,27 @@
+module Elasticsearch
+  module API
+    module Ingest
+      module Actions
+
+        # Return a specified pipeline
+        #
+        # @option arguments [String] :id Comma separated list of pipeline ids. Wildcards supported (*Required*)
+        # @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={})
+          raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
+          valid_params = [
+            :master_timeout ]
+          method = 'GET'
+          path   = Utils.__pathify "_ingest/pipeline", Utils.__escape(arguments[:id])
+          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/ingest/put_pipeline.rb

@@ -0,0 +1,32 @@
+module Elasticsearch
+  module API
+    module Ingest
+      module Actions
+
+        # Add or update a specified pipeline
+        #
+        # @option arguments [String] :id Pipeline ID (*Required*)
+        # @option arguments [Hash] :body The ingest definition (*Required*)
+        # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
+        # @option arguments [Time] :timeout Explicit operation timeout
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/plugins/master/ingest.html
+        #
+        def put_pipeline(arguments={})
+          raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
+          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+          valid_params = [
+            :master_timeout,
+            :timeout ]
+          method = 'PUT'
+          path   = Utils.__pathify "_ingest/pipeline", Utils.__escape(arguments[:id])
+
+          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/ingest/simulate.rb

@@ -0,0 +1,29 @@
+module Elasticsearch
+  module API
+    module Ingest
+      module Actions
+
+        # Execute a specific pipeline against the set of documents provided in the body of the request
+        #
+        # @option arguments [String] :id Pipeline ID
+        # @option arguments [Hash] :body The pipeline definition (*Required*)
+        # @option arguments [Boolean] :verbose Verbose mode. Display data output for each processor
+        #                                                    in executed pipeline
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/simulate-pipeline-api.html
+        #
+        def simulate(arguments={})
+          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+          valid_params = [
+            :verbose ]
+          method = 'GET'
+          path   = Utils.__pathify "_ingest/pipeline", Utils.__escape(arguments[:id]), '_simulate'
+          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/nodes/hot_threads.rb

@@ -20,6 +20,7 @@ module Elasticsearch
         # @option arguments [Number] :snapshots Number of samples of thread stacktrace (default: 10)
         # @option arguments [Number] :threads Specify the number of threads to provide information for (default: 3)
         # @option arguments [String] :type The type to sample (default: cpu) (options: cpu, wait, block)
+        # @option arguments [Time] :timeout Explicit operation timeout
         #
         # @return [String]
         #
@@ -30,7 +31,8 @@ module Elasticsearch
             :interval,
             :snapshots,
             :threads,
-            :type ]
+            :type,
+            :timeout ]
 
           method = HTTP_GET
           path   = Utils.__pathify '_nodes', Utils.__listify(arguments[:node_id]), 'hot_threads'

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

@@ -35,6 +35,7 @@ module Elasticsearch
         # @option arguments [Boolean] :settings Return information about node settings
         # @option arguments [Boolean] :thread_pool Return information about the thread pool
         # @option arguments [Boolean] :transport Return information about transport
+        # @option arguments [Time] :timeout Explicit operation timeout
         #
         # @see http://elasticsearch.org/guide/reference/api/admin-cluster-nodes-info/
         #
@@ -52,9 +53,10 @@ module Elasticsearch
             :process,
             :settings,
             :thread_pool,
-            :transport ]
+            :transport,
+            :timeout ]
 
-          valid_params = []
+          valid_params = [ :timeout ]
 
           method = HTTP_GET
 

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

@@ -37,6 +37,7 @@ module Elasticsearch
         # @option arguments [String] :level Specify the level for aggregating indices stats
         #                                   (options: node, indices, shards)
         # @option arguments [List] :types A comma-separated list of document types for the `indexing` index metric
+        # @option arguments [Time] :timeout Explicit operation timeout
         #
         # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cluster-nodes-stats.html
         #
@@ -53,7 +54,8 @@ module Elasticsearch
             :groups,
             :human,
             :level,
-            :types ]
+            :types,
+            :timeout ]
 
           method = HTTP_GET
 

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

@@ -16,8 +16,14 @@ module Elasticsearch
         params = {}
         body   = nil
 
-        Utils.__rescue_from_not_found do
+        begin
           perform_request(method, path, params, body).status == 200 ? true : false
+        rescue Exception => e
+          if e.class.to_s =~ /NotFound|ConnectionFailed/ || e.message =~ /Not\s*Found|404|ConnectionFailed/i
+            false
+          else
+            raise e
+          end
         end
       end
     end

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

@@ -0,0 +1,69 @@
+module Elasticsearch
+  module API
+    module Actions
+
+      # Copy documents from one index to another, potentially changing
+      # its settings, mappings and the documents itself.
+      #
+      # @example Copy documents into a different index
+      #
+      #     client.reindex body: { source: { index: 'test1' }, dest: { index: 'test2' } }
+      #
+      # @example Limit the copied documents with a query
+      #
+      #     client.reindex body: {
+      #       source: {
+      #         index: 'test1',
+      #         query: { terms: { category: ['one', 'two'] }  }
+      #       },
+      #       dest: {
+      #         index: 'test2'
+      #       }
+      #     }
+      #
+      # @example Remove a field from reindexed documents
+      #
+      #     client.reindex body: {
+      #       source: {
+      #         index: 'test1'
+      #       },
+      #       dest: {
+      #         index: 'test3'
+      #       },
+      #       script: {
+      #         inline: 'ctx._source.remove("category")'
+      #       }
+      #     }
+      #
+      # @option arguments [Hash] :body The definition of the operation (source index, target index, ...)
+      #                                (*Required*)
+      # @option arguments [Boolean] :refresh Whether the affected indexes should be refreshed
+      # @option arguments [Time] :timeout Time each individual bulk request should wait for shards
+      #                                   that are unavailable. (Default: 1m)
+      # @option arguments [String] :consistency Explicit write consistency setting for the operation
+      #                                        (Options: one, quorum, all)
+      # @option arguments [Boolean] :wait_for_completion Whether the request should block and wait until
+        #                                                the operation has completed
+      # @option arguments [Float] :requests_per_second The throttling for this request in sub-requests per second.
+      #                                                0 means set no throttling (default)
+      #
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-reindex.html
+      #
+      def reindex(arguments={})
+        raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+        valid_params = [
+          :refresh,
+          :timeout,
+          :consistency,
+          :wait_for_completion,
+          :requests_per_second ]
+        method = 'POST'
+        path   = "_reindex"
+        params = Utils.__validate_and_extract_params arguments, valid_params
+        body   = arguments[:body]
+
+        perform_request(method, path, params, body).body
+      end
+    end
+  end
+end

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

@@ -87,6 +87,8 @@ module Elasticsearch
       # @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 [Boolean] :request_cache Specify if request cache should be used for this request
+      #                                            (defaults to index level setting)
       # @option arguments [List] :routing A comma-separated list of specific routing values
       # @option arguments [Duration] :scroll Specify how long a consistent view of the index should be maintained
       #                                      for scrolled search
@@ -105,6 +107,7 @@ module Elasticsearch
       # @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 [Text] :suggest_text The source text for which the suggestions should be returned
+      # @option arguments [Number] :terminate_after The maximum number of documents to collect for each shard
       # @option arguments [Time] :timeout Explicit operation timeout
       # @option arguments [Boolean] :version Specify whether to return document version as part of a hit
       #
@@ -134,6 +137,7 @@ module Elasticsearch
           :preference,
           :q,
           :query_cache,
+          :request_cache,
           :routing,
           :scroll,
           :search_type,
@@ -148,6 +152,7 @@ module Elasticsearch
           :suggest_mode,
           :suggest_size,
           :suggest_text,
+          :terminate_after,
           :timeout,
           :version ]
 

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

@@ -15,6 +15,8 @@ module Elasticsearch
         # @option arguments [String] :parent_node Return tasks with specified parent node.
         # @option arguments [Number] :parent_task Return tasks with specified parent task id.
         #                                         Set to -1 to return all.
+        # @option arguments [String] :group_by Group tasks by nodes or parent/child relationships
+        #                                      Options: nodes, parents
         # @option arguments [Boolean] :wait_for_completion Wait for the matching tasks to complete (default: false)
         #
         # @see http://www.elastic.co/guide/en/elasticsearch/reference/master/tasks-list.html
@@ -26,6 +28,7 @@ module Elasticsearch
             :detailed,
             :parent_node,
             :parent_task,
+            :group_by,
             :wait_for_completion ]
 
           task_id = arguments.delete(:task_id)

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

@@ -0,0 +1,128 @@
+module Elasticsearch
+  module API
+    module Actions
+
+      # Process every document matching a query, potentially updating it
+      #
+      # @example Update all documents in the index, eg. to pick up new mappings
+      #
+      #     client.update_by_query index: 'articles'
+      #
+      # @example Update a property of documents matching a query in the index
+      #
+      #     client.update_by_query index: 'article',
+      #                            body: {
+      #                              script: { inline: 'ctx._source.views += 1' },
+      #                              query: { match: { title: 'foo' } }
+      #                            }
+      #
+      # @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 (*Required*)
+      # @option arguments [List] :type A comma-separated list of document types to search; leave empty to perform the operation on all types
+      # @option arguments [Hash] :body The search definition using the Query DSL
+      # @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] :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] :fields A comma-separated list of fields to return as part of a hit
+      # @option arguments [List] :fielddata_fields A comma-separated list of fields to return as the field data representation of a field for each hit
+      # @option arguments [Number] :from Starting offset (default: 0)
+      # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
+      # @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] :conflicts What to do when the reindex hits version conflicts? (options: abort, proceed)
+      # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, 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 [Boolean] :lowercase_expanded_terms Specify whether query terms should be lowercased
+      # @option arguments [String] :pipeline Ingest pipeline to set on index requests made by this action. (default: none)
+      # @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 [Duration] :scroll Specify how long a consistent view of the index should be maintained for scrolled search
+      # @option arguments [String] :search_type Search operation type (options: query_then_fetch, dfs_query_then_fetch)
+      # @option arguments [Time] :search_timeout Explicit timeout for each search request. Defaults to no timeout.
+      # @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
+      # @option arguments [List] :_source_exclude A list of fields to exclude from the returned _source field
+      # @option arguments [List] :_source_include A list of fields to extract and return from the _source field
+      # @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 [Number] :suggest_size How many suggestions to return in response
+      # @option arguments [Text] :suggest_text The source text for which the suggestions should be returned
+      # @option arguments [Time] :timeout Time each individual bulk request should wait for shards that are unavailable.
+      # @option arguments [Boolean] :track_scores Whether to calculate and return scores even if they are not used for sorting
+      # @option arguments [Boolean] :version Specify whether to return document version as part of a hit
+      # @option arguments [Boolean] :version_type Should the document increment the version number (internal) on hit or not (reindex)
+      # @option arguments [Boolean] :request_cache Specify if request cache should be used for this request or not, defaults to index level setting
+      # @option arguments [Boolean] :refresh Should the effected indexes be refreshed?
+      # @option arguments [String] :consistency Explicit write consistency setting for the operation (options: one, quorum, all)
+      # @option arguments [Integer] :scroll_size Size on the scroll request powering the update_by_query
+      # @option arguments [Boolean] :wait_for_completion Should the request should block until the reindex is complete.
+      # @option arguments [Float] :requests_per_second The throttle for this request in sub-requests per second. 0 means set no throttle.
+      #
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update-by-query.html
+      #
+      def update_by_query(arguments={})
+        raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
+
+        valid_params = [
+          :analyzer,
+          :analyze_wildcard,
+          :default_operator,
+          :df,
+          :explain,
+          :fields,
+          :fielddata_fields,
+          :from,
+          :ignore_unavailable,
+          :allow_no_indices,
+          :conflicts,
+          :expand_wildcards,
+          :lenient,
+          :lowercase_expanded_terms,
+          :pipeline,
+          :preference,
+          :q,
+          :routing,
+          :scroll,
+          :search_type,
+          :search_timeout,
+          :size,
+          :sort,
+          :_source,
+          :_source_exclude,
+          :_source_include,
+          :terminate_after,
+          :stats,
+          :suggest_field,
+          :suggest_mode,
+          :suggest_size,
+          :suggest_text,
+          :timeout,
+          :track_scores,
+          :version,
+          :version_type,
+          :request_cache,
+          :refresh,
+          :consistency,
+          :scroll_size,
+          :wait_for_completion,
+          :requests_per_second ]
+
+        method = HTTP_POST
+
+        path   = Utils.__pathify Utils.__listify(arguments[:index]),
+                                 Utils.__listify(arguments[:type]),
+                                 '/_update_by_query'
+
+        params = Utils.__validate_and_extract_params arguments, valid_params
+
+        body   = arguments[:body]
+
+        perform_request(method, path, params, body).body
+      end
+    end
+  end
+end