elasticsearch-api 7.11.2 → 7.17.0

data/lib/elasticsearch/api/actions/snapshot/repository_analyze.rb

@@ -0,0 +1,76 @@
+# 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 API
+    module Snapshot
+      module Actions
+        # Analyzes a repository for correctness and performance
+        #
+        # @option arguments [String] :repository A repository name
+        # @option arguments [Number] :blob_count Number of blobs to create during the test. Defaults to 100.
+        # @option arguments [Number] :concurrency Number of operations to run concurrently during the test. Defaults to 10.
+        # @option arguments [Number] :read_node_count Number of nodes on which to read a blob after writing. Defaults to 10.
+        # @option arguments [Number] :early_read_node_count Number of nodes on which to perform an early read on a blob, i.e. before writing has completed. Early reads are rare actions so the 'rare_action_probability' parameter is also relevant. Defaults to 2.
+        # @option arguments [Number] :seed Seed for the random number generator used to create the test workload. Defaults to a random value.
+        # @option arguments [Number] :rare_action_probability Probability of taking a rare action such as an early read or an overwrite. Defaults to 0.02.
+        # @option arguments [String] :max_blob_size Maximum size of a blob to create during the test, e.g '1gb' or '100mb'. Defaults to '10mb'.
+        # @option arguments [String] :max_total_data_size Maximum total size of all blobs to create during the test, e.g '1tb' or '100gb'. Defaults to '1gb'.
+        # @option arguments [Time] :timeout Explicit operation timeout. Defaults to '30s'.
+        # @option arguments [Boolean] :detailed Whether to return detailed results or a summary. Defaults to 'false' so that only the summary is returned.
+        # @option arguments [Boolean] :rarely_abort_writes Whether to rarely abort writes before they complete. Defaults to 'true'.
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/modules-snapshots.html
+        #
+        def repository_analyze(arguments = {})
+          raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]
+
+          headers = arguments.delete(:headers) || {}
+
+          arguments = arguments.clone
+
+          _repository = arguments.delete(:repository)
+
+          method = Elasticsearch::API::HTTP_POST
+          path   = "_snapshot/#{Utils.__listify(_repository)}/_analyze"
+          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+
+          body = nil
+          perform_request(method, path, params, body, headers).body
+        end
+
+        # Register this action with its valid params when the module is loaded.
+        #
+        # @since 6.2.0
+        ParamsRegistry.register(:repository_analyze, [
+          :blob_count,
+          :concurrency,
+          :read_node_count,
+          :early_read_node_count,
+          :seed,
+          :rare_action_probability,
+          :max_blob_size,
+          :max_total_data_size,
+          :timeout,
+          :detailed,
+          :rarely_abort_writes
+        ].freeze)
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/snapshot/restore.rb

@@ -28,7 +28,7 @@ module Elasticsearch
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body Details of what to restore
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/modules-snapshots.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/modules-snapshots.html
         #
         def restore(arguments = {})
           raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]

data/lib/elasticsearch/api/actions/snapshot/status.rb

@@ -27,7 +27,7 @@ module Elasticsearch
         # @option arguments [Boolean] :ignore_unavailable Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/modules-snapshots.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/modules-snapshots.html
         #
         def status(arguments = {})
           headers = arguments.delete(:headers) || {}

data/lib/elasticsearch/api/actions/snapshot/verify_repository.rb

@@ -26,7 +26,7 @@ module Elasticsearch
         # @option arguments [Time] :timeout Explicit operation timeout
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/modules-snapshots.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/modules-snapshots.html
         #
         def verify_repository(arguments = {})
           raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]

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

@@ -32,7 +32,7 @@ module Elasticsearch
         # @option arguments [Boolean] :wait_for_completion Should the request block until the cancellation of the task and its descendant tasks is completed. Defaults to false
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/tasks.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/tasks.html
         #
         def cancel(arguments = {})
           headers = arguments.delete(:headers) || {}

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

@@ -30,7 +30,7 @@ module Elasticsearch
         # @option arguments [Time] :timeout Explicit operation timeout
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/tasks.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/tasks.html
         #
         def get(arguments = {})
           headers = arguments.delete(:headers) || {}

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

@@ -34,7 +34,7 @@ module Elasticsearch
         # @option arguments [Time] :timeout Explicit operation timeout
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/tasks.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/tasks.html
         #
         def list(arguments = {})
           headers = arguments.delete(:headers) || {}

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

@@ -42,7 +42,7 @@ module Elasticsearch
       # Deprecated since version 7.0.0
       #
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/docs-termvectors.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/docs-termvectors.html
       #
       def termvectors(arguments = {})
         raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
@@ -64,15 +64,15 @@ module Elasticsearch
                  end
 
         endpoint = arguments.delete(:endpoint) || '_termvectors'
-        path = if _index && _type && _id
-                 "#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/#{Utils.__listify(_id)}/#{endpoint}"
-               elsif _index && _type
-                 "#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/#{endpoint}"
-               elsif _index && _id
-                 "#{Utils.__listify(_index)}/#{endpoint}/#{Utils.__listify(_id)}"
-               else
-                 "#{Utils.__listify(_index)}/#{endpoint}"
-               end
+        path   = if _index && _type && _id
+                   "#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/#{Utils.__listify(_id)}/#{endpoint}"
+                 elsif _index && _type
+                   "#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/#{endpoint}"
+                 elsif _index && _id
+                   "#{Utils.__listify(_index)}/#{endpoint}/#{Utils.__listify(_id)}"
+                 else
+                   "#{Utils.__listify(_index)}/#{endpoint}"
+                 end
 
         params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
@@ -85,6 +85,7 @@ module Elasticsearch
       def termvector(arguments = {})
         termvectors(arguments.merge endpoint: '_termvector')
       end
+
       # Register this action with its valid params when the module is loaded.
       #
       # @since 6.2.0

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

@@ -43,7 +43,7 @@ module Elasticsearch
       # Deprecated since version 7.0.0
       #
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/docs-update.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/docs-update.html
       #
       def update(arguments = {})
         raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]

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

@@ -43,9 +43,6 @@ module Elasticsearch
       # @option arguments [Number] :size Deprecated, please use `max_docs` instead
       # @option arguments [Number] :max_docs Maximum number of documents to process (default: all documents)
       # @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_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 [Boolean] :version Specify whether to return document version as part of a hit
@@ -66,7 +63,7 @@ module Elasticsearch
       # Deprecated since version 7.0.0
       #
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/docs-update-by-query.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/docs-update-by-query.html
       #
       def update_by_query(arguments = {})
         raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
@@ -115,9 +112,6 @@ module Elasticsearch
         :size,
         :max_docs,
         :sort,
-        :_source,
-        :_source_excludes,
-        :_source_includes,
         :terminate_after,
         :stats,
         :version,

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

@@ -24,7 +24,7 @@ module Elasticsearch
       # @option arguments [Number] :requests_per_second The throttle to set on this request in floating sub-requests per second. -1 means set no throttle. (*Required*)
       # @option arguments [Hash] :headers Custom HTTP headers
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.11/docs-update-by-query.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/docs-update-by-query.html
       #
       def update_by_query_rethrottle(arguments = {})
         raise ArgumentError, "Required argument 'task_id' missing" unless arguments[:task_id]

data/lib/elasticsearch/api/{actions/remote/info.rb → namespace/features.rb}

@@ -17,20 +17,19 @@
 
 module Elasticsearch
   module API
-    module Remote
-      module Actions
-        # Returns all of the configured remote cluster information
-        #
-        # @see http://www.elastic.co/guide/en/elasticsearch/reference/master/remote-info.html
-        #
-        def info(arguments = {})
-          method = HTTP_GET
-          path   = "_remote/info"
-          params = {}
-          body   = nil
+    module Features
+      module Actions; end
 
-          perform_request(method, path, params, body).body
-        end
+      # Client for the "features" namespace (includes the {Features::Actions} methods)
+      #
+      class FeaturesClient
+        include Common::Client, Common::Client::Base, Features::Actions
+      end
+
+      # Proxy method for {FeaturesClient}, available in the receiving object
+      #
+      def features
+        @features ||= FeaturesClient.new(self)
       end
     end
   end

data/lib/elasticsearch/api/namespace/security.rb

@@ -0,0 +1,36 @@
+# 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 API
+    module Security
+      module Actions; end
+
+      # Client for the "security" namespace (includes the {Security::Actions} methods)
+      #
+      class SecurityClient
+        include Common::Client, Common::Client::Base, Security::Actions
+      end
+
+      # Proxy method for {SecurityClient}, available in the receiving object
+      #
+      def security
+        @security ||= SecurityClient.new(self)
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/namespace/shutdown.rb

@@ -0,0 +1,37 @@
+# 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 API
+    module Shutdown
+      module Actions; end
+
+      # Client for the "shutdown" namespace (includes the {Shutdown::Actions} methods)
+      #
+      class ShutdownClient
+        include Common::Client, Common::Client::Base, Shutdown::Actions
+      end
+
+      # Proxy method for {ShutdownClient}, available in the receiving object
+      #
+      def shutdown
+        @shutdown ||= ShutdownClient.new(self)
+      end
+
+    end
+  end
+end

data/lib/elasticsearch/api/utils.rb

@@ -14,14 +14,13 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
+require 'erb'
 
 module Elasticsearch
   module API
-
     # Generic utility methods
     #
     module Utils
-
       # URL-escape a string
       #
       # @example
@@ -31,7 +30,7 @@ module Elasticsearch
       # @api private
       def __escape(string)
         return string if string == '*'
-        defined?(EscapeUtils) ? EscapeUtils.escape_url(string.to_s) : CGI.escape(string.to_s)
+        ERB::Util.url_encode(string.to_s)
       end
 
       # Create a "list" of values from arguments, ignoring nil values and encoding special characters.
@@ -282,6 +281,11 @@ module Elasticsearch
         end
       end
 
+      def ndjson_headers(headers)
+        headers.merge!('Content-Type' => 'application/x-ndjson') unless ['1', 'true'].include?(ENV['ELASTIC_CLIENT_APIVERSIONING'])
+        headers
+      end
+
       extend self
     end
   end

data/lib/elasticsearch/api/version.rb

@@ -17,6 +17,6 @@
 
 module Elasticsearch
   module API
-    VERSION = '7.11.2'.freeze
+    VERSION = '7.17.0'.freeze
   end
 end

data/lib/elasticsearch/api.rb

@@ -72,7 +72,9 @@ module Elasticsearch
                 Elasticsearch::API::Tasks,
                 Elasticsearch::API::Cat,
                 Elasticsearch::API::Remote,
-                Elasticsearch::API::DanglingIndices
+                Elasticsearch::API::DanglingIndices,
+                Elasticsearch::API::Features,
+                Elasticsearch::API::Shutdown
     end
 
     # The serializer class

data/spec/elasticsearch/api/actions/{benchmark_spec.rb → close_point_in_time_spec.rb}

@@ -17,18 +17,18 @@
 
 require 'spec_helper'
 
-describe 'client#benchmark' do
-
+describe 'client#close_point_in_time' do
   let(:expected_args) do
     [
-      'PUT',
-      '_bench',
+      'DELETE',
+      '_pit',
       {},
-      { name: 'foo' }
+      nil,
+      {}
     ]
   end
 
   it 'performs the request' do
-    expect(client_double.benchmark(body: { name: 'foo' }))
+    expect(client_double.close_point_in_time).to eq({})
   end
 end

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

@@ -18,10 +18,9 @@
 require 'spec_helper'
 
 describe 'client#count' do
-
   let(:expected_args) do
     [
-      'POST',
+      'GET',
       '_count',
       {},
       nil,
@@ -34,10 +33,9 @@ describe 'client#count' do
   end
 
   context 'when an index and type are specified' do
-
     let(:expected_args) do
       [
-        'POST',
+        'GET',
         'foo,bar/t1,t2/_count',
         {},
         nil,
@@ -51,7 +49,6 @@ describe 'client#count' do
   end
 
   context 'when there is a query provided' do
-
     let(:expected_args) do
       [
         'POST',

data/spec/elasticsearch/api/actions/{remote/info_spec.rb → features/get_features_spec.rb}

@@ -17,19 +17,18 @@
 
 require 'spec_helper'
 
-describe 'client.remote#info' do
-
+describe 'client.featues#get_features' do
   let(:expected_args) do
     [
-        'GET',
-        '_remote/info',
-        {},
-        nil,
-        nil
+      'GET',
+      '_features',
+      {},
+      nil,
+      {}
     ]
   end
 
   it 'performs the request' do
-    expect(client_double.remote.info).to eq({})
+    expect(client_double.features.get_features).to eq({})
   end
 end

data/spec/elasticsearch/api/actions/features/reset_features_spec.rb

@@ -0,0 +1,34 @@
+# 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.
+
+require 'spec_helper'
+
+describe 'client.featues#reset_features' do
+  let(:expected_args) do
+    [
+      'POST',
+      '_features/_reset',
+      {},
+      nil,
+      {}
+    ]
+  end
+
+  it 'performs the request' do
+    expect(client_double.features.reset_features).to eq({})
+  end
+end

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

@@ -1,7 +1,20 @@
-# Licensed to Elasticsearch B.V under one or more agreements.
-# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
-# See the LICENSE file in the project root for more information
+# 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.
+
 require 'spec_helper'
 
 describe 'client.indices#clear_cache' do

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

@@ -0,0 +1,48 @@
+# 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.
+
+require 'spec_helper'
+
+describe 'client.indices#disk_usage' do
+  let(:expected_args) do
+    [
+      'POST',
+      "#{index}/_disk_usage",
+      {},
+      nil,
+      {}
+    ]
+  end
+
+  let(:index) { 'foo' }
+
+  it 'performs the request' do
+    expect(client_double.indices.disk_usage(index: index)).to eq({})
+  end
+
+  context 'when there is no index specified' do
+    let(:client) do
+      Class.new { include Elasticsearch::API }.new
+    end
+
+    it 'raises an exception' do
+      expect do
+        client.indices.disk_usage
+      end.to raise_exception(ArgumentError)
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+# 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.
+
+require 'spec_helper'
+
+describe 'client.indices#field_usage_stats' do
+  let(:expected_args) do
+    [
+      'GET',
+      'foo/_field_usage_stats',
+      {},
+      nil,
+      {}
+    ]
+  end
+
+  it 'performs the request' do
+    expect(client_double.indices.field_usage_stats(index: 'foo')).to eq({})
+  end
+
+  context 'when there is no index specified' do
+    let(:client) do
+      Class.new { include Elasticsearch::API }.new
+    end
+
+    it 'raises an exception' do
+      expect {
+        client.indices.field_usage_stats
+      }.to raise_exception(ArgumentError)
+    end
+  end
+end