elasticsearch-api 6.2.0 → 6.8.0

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

@@ -33,34 +33,24 @@ module Elasticsearch
       #                   body: { script: 'ctx._source.tags.contains(params.tag) ? ctx.op = "delete" : ctx.op = "none"',
       #                           params: { tag: 'to-delete' } }
       #
+      #
       # @option arguments [String] :id Document ID (*Required*)
-      # @option arguments [Number,List] :ignore The list of HTTP errors to ignore; only `404` supported at the moment
       # @option arguments [String] :index The name of the index (*Required*)
       # @option arguments [String] :type The type of the document (*Required*)
-      # @option arguments [Hash] :body The request definition using either `script` or partial `doc` (*Required*)
-      # @option arguments [String] :consistency Explicit write consistency setting for the operation
-      #                                         (options: one, quorum, all)
+      # @option arguments [Hash] :body The request definition requires either `script` or partial `doc` (*Required*)
+      # @option arguments [String] :wait_for_active_shards Sets the number of shard copies that must be active before proceeding with the update operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)
       # @option arguments [List] :fields A comma-separated list of fields to return in the response
-      # @option arguments [String] :lang The script language (default: mvel)
-      # @option arguments [String] :parent ID of the parent document
-      # @option arguments [String] :percolate Perform percolation during the operation;
-      #                                       use specific registered query name, attribute, or wildcard
-      # @option arguments [Boolean] :refresh Refresh the index after performing the operation
-      # @option arguments [String] :replication Specific replication type (options: sync, async)
-      # @option arguments [Number] :retry_on_conflict Specify how many times should the operation be retried
-      #                                               when a conflict occurs (default: 0)
+      # @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_excludes A list of fields to exclude from the returned _source field
+      # @option arguments [List] :_source_includes A list of fields to extract and return from the _source field
+      # @option arguments [String] :lang The script language (default: painless)
+      # @option arguments [String] :parent ID of the parent document. Is is only used for routing and when for the upsert request
+      # @option arguments [String] :refresh If `true` then refresh the effected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes. (options: true, false, wait_for)
+      # @option arguments [Number] :retry_on_conflict Specify how many times should the operation be retried when a conflict occurs (default: 0)
       # @option arguments [String] :routing Specific routing value
-      # @option arguments [String] :script The URL-encoded script definition (instead of using request body)
-      # @option arguments [String] :_source Specify whether the _source field should be returned,
-      #                                     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 [Time] :timeout Explicit operation timeout
-      # @option arguments [Time] :timestamp Explicit timestamp for the document
-      # @option arguments [Duration] :ttl Expiration time for the document
       # @option arguments [Number] :version Explicit version number for concurrency control
-      # @option arguments [Number] :version_type Explicit version number for concurrency control
-      #
+      # @option arguments [String] :version_type Specific version type (options: internal, force)
       # @since 0.20
       #
       # @see http://elasticsearch.org/guide/reference/api/update/
@@ -91,26 +81,22 @@ module Elasticsearch
       #
       # @since 6.2.0
       ParamsRegistry.register(:update, [
-          :consistency,
+          :wait_for_active_shards,
           :fields,
+          :_source,
+          :_source_excludes,
+          :_source_includes,
           :lang,
           :parent,
-          :percolate,
           :refresh,
-          :replication,
           :retry_on_conflict,
           :routing,
-          :script,
-          :_source,
-          :_source_include,
-          :_source_includes,
-          :_source_exclude,
-          :_source_excludes,
           :timeout,
-          :timestamp,
-          :ttl,
           :version,
-          :version_type ].freeze)
+          :version_type,
+          :if_seq_no,
+          :include_type_name,
+          :if_primary_term ].freeze)
     end
   end
 end

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

@@ -23,47 +23,38 @@ module Elasticsearch
       # @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] :conflicts What to do when the update by query 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 [Time] :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 [List] :_source_excludes A list of fields to exclude from the returned _source field
+      # @option arguments [List] :_source_includes 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.
-      # @option arguments [Integer] :slices The number of slices this task should be divided into. Defaults to 1 meaning the task isn't sliced into subtasks.
+      # @option arguments [Time] :timeout Time each individual bulk request should wait for shards that are unavailable.
+      # @option arguments [String] :wait_for_active_shards Sets the number of shard copies that must be active before proceeding with the update by query operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)
+      # @option arguments [Number] :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 update by query operation is complete.
+      # @option arguments [Number] :requests_per_second The throttle to set on this request in sub-requests per second. -1 means no throttle.
+      # @option arguments [Number] :slices The number of slices this task should be divided into. Defaults to 1 meaning the task isn't sliced into subtasks.
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update-by-query.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-update-by-query.html
       #
       def update_by_query(arguments={})
         raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
@@ -88,16 +79,12 @@ module Elasticsearch
           :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,
@@ -108,23 +95,16 @@ module Elasticsearch
           :size,
           :sort,
           :_source,
-          :_source_exclude,
           :_source_excludes,
-          :_source_include,
           :_source_includes,
           :terminate_after,
           :stats,
-          :suggest_field,
-          :suggest_mode,
-          :suggest_size,
-          :suggest_text,
-          :timeout,
-          :track_scores,
           :version,
           :version_type,
           :request_cache,
           :refresh,
-          :consistency,
+          :timeout,
+          :wait_for_active_shards,
           :scroll_size,
           :wait_for_completion,
           :requests_per_second,

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

@@ -0,0 +1,29 @@
+module Elasticsearch
+  module API
+    module Actions
+
+      # The value of requests_per_second can be changed on a running update by query using the _rethrottle API
+      #
+      # @option arguments [String] :task_id The task id to rethrottle (*Required*)
+      # @option arguments [Number] :requests_per_second The throttle to set on this request in floating sub-requests per second. -1 means set no throttle.
+      #
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-update-by-query.html
+      #
+      def update_by_query_rethrottle(arguments={})
+        raise ArgumentError, "Required argument 'task_id' missing" unless arguments[:task_id]
+        method = Elasticsearch::API::HTTP_POST
+        path   = "_update_by_query/#{arguments[:task_id]}/_rethrottle"
+        params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+        body   = nil
+
+        perform_request(method, path, params, body).body
+      end
+
+      # Register this action with its valid params when the module is loaded.
+      #
+      # @since 6.2.0
+      ParamsRegistry.register(:update_by_query_rethrottle, [
+          :requests_per_second ].freeze)
+    end
+  end
+end

data/lib/elasticsearch/api/version.rb

@@ -1,5 +1,5 @@
 module Elasticsearch
   module API
-    VERSION = "6.2.0"
+    VERSION = "6.8.0"
   end
 end

data/spec/elasticsearch/api/actions/cluster/state_spec.rb

@@ -32,21 +32,4 @@ describe 'client.cluster#state' do
       expect(client_double.cluster.state(metric: ['foo', 'bar'])).to eq({})
     end
   end
-
-  context 'when index templates are specified' do
-
-    let(:expected_args) do
-      [
-          'GET',
-          '_cluster/state',
-          { index_templates: 'foo,bar' },
-          nil,
-          nil
-      ]
-    end
-
-    it 'performs the request' do
-      expect(client_double.cluster.state(index_templates: ['foo', 'bar'])).to eq({})
-    end
-  end
 end

data/spec/elasticsearch/api/actions/cluster/stats_spec.rb

@@ -15,4 +15,21 @@ describe 'client.cluster#stats' do
   it 'performs the request' do
     expect(client_double.cluster.stats).to eq({})
   end
+
+  context 'when a node_id is specified' do
+
+    let(:expected_args) do
+      [
+          'GET',
+          '_cluster/stats/nodes/1',
+          {},
+          nil,
+          nil
+      ]
+    end
+
+    it 'performs the request' do
+      expect(client_double.cluster.stats(node_id: 1)).to eq({})
+    end
+  end
 end

data/spec/elasticsearch/api/actions/indices/analyze_spec.rb

@@ -43,17 +43,6 @@ describe 'client.indices#analyze' do
     end
   end
 
-  context 'when an url params are specified' do
-
-    let(:params) do
-      { text: 'foo', analyzer: 'bar' }
-    end
-
-    it 'performs the request' do
-      expect(client_double.indices.analyze(text: 'foo', analyzer: 'bar')).to eq({})
-    end
-  end
-
   context 'when a body is specified' do
 
     let(:body) do
@@ -64,30 +53,4 @@ describe 'client.indices#analyze' do
       expect(client_double.indices.analyze(body: 'foo')).to eq({})
     end
   end
-
-  context 'when filters are specified' do
-
-    let(:params) do
-      { filters: 'foo,bar', text: 'Test', tokenizer: 'whitespace' }
-    end
-
-    it 'performs the request' do
-      expect(client_double.indices.analyze(text: 'Test', tokenizer: 'whitespace', filters: ['foo,bar'])).to eq({})
-    end
-  end
-
-  context 'when path must be URL-escaped' do
-
-    let(:url) do
-      'foo%5Ebar/_analyze'
-    end
-
-    let(:params) do
-      { text: 'Test', index: 'foo^bar' }
-    end
-
-    it 'performs the request' do
-      expect(client_double.indices.analyze(index: 'foo^bar', text: 'Test')).to eq({})
-    end
-  end
 end

data/spec/elasticsearch/api/actions/indices/put_settings_spec.rb

@@ -41,21 +41,6 @@ describe 'client.cluster#put_settings' do
     end
   end
 
-  context 'when parameters are specified' do
-
-    let(:params) do
-      { flat_settings: true }
-    end
-
-    let(:url) do
-      'foo/_settings'
-    end
-
-    it 'performs the request' do
-      expect(client_double.indices.put_settings(index: 'foo', flat_settings: true, body: {})).to eq({})
-    end
-  end
-
   context 'when an index is specified' do
 
     let(:url) do

data/spec/elasticsearch/api/actions/indices/refresh_spec.rb

@@ -61,21 +61,6 @@ describe 'client.cluster#refresh' do
     end
   end
 
-  context 'when parameters are specified' do
-
-    let(:params) do
-      { ignore_indices: 'missing' }
-    end
-
-    let(:url) do
-      'foo/_refresh'
-    end
-
-    it 'performs the request' do
-      expect(client_double.indices.refresh(index: 'foo', ignore_indices: 'missing')).to eq({})
-    end
-  end
-
   context 'when the path needs to be URL-escaped' do
 
     let(:url) do

data/spec/elasticsearch/api/actions/indices/segments_spec.rb

@@ -61,21 +61,6 @@ describe 'client.cluster#segments' do
     end
   end
 
-  context 'when parameters are specified' do
-
-    let(:params) do
-      { ignore_indices: 'missing' }
-    end
-
-    let(:url) do
-      'foo/_segments'
-    end
-
-    it 'performs the request' do
-      expect(client_double.indices.segments(index: 'foo', ignore_indices: 'missing')).to eq({})
-    end
-  end
-
   context 'when the path needs to be URL-escaped' do
 
     let(:url) do

data/spec/elasticsearch/api/actions/mget_spec.rb

@@ -66,21 +66,6 @@ describe 'client#mget' do
     it 'performs the request' do
       expect(client_double.mget(body: {}, refresh: true)).to eq({})
     end
-
-    context 'when the fields parameter is specified' do
-
-      let(:params) do
-        { fields: 'foo,bar' }
-      end
-
-      let(:body) do
-        {}
-      end
-
-      it 'performs the request' do
-        expect(client_double.mget(body: {}, fields: ['foo', 'bar'])).to eq({})
-      end
-    end
   end
 
   context 'when the request needs to be URL-escaped' do