elasticsearch-api 7.9.0 → 7.14.1

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

@@ -28,7 +28,7 @@ module Elasticsearch
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body The snapshot definition
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/modules-snapshots.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.14/modules-snapshots.html
         #
         def create(arguments = {})
           raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]

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

@@ -28,7 +28,7 @@ module Elasticsearch
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body The repository definition (*Required*)
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/modules-snapshots.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.14/modules-snapshots.html
         #
         def create_repository(arguments = {})
           raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]

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

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

data/lib/elasticsearch/api/actions/snapshot/delete_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.9/modules-snapshots.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.14/modules-snapshots.html
         #
         def delete_repository(arguments = {})
           raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]

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

@@ -25,10 +25,12 @@ module Elasticsearch
         # @option arguments [List] :snapshot A comma-separated list of snapshot names
         # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
         # @option arguments [Boolean] :ignore_unavailable Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown
+        # @option arguments [Boolean] :index_details Whether to include details of each index in the snapshot, if those details are available. Defaults to false.
+        # @option arguments [Boolean] :include_repository Whether to include the repository name in the snapshot info. Defaults to true.
         # @option arguments [Boolean] :verbose Whether to show verbose snapshot info or only show the basic info found in the repository index blob
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/modules-snapshots.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.14/modules-snapshots.html
         #
         def get(arguments = {})
           raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]
@@ -60,6 +62,8 @@ module Elasticsearch
         ParamsRegistry.register(:get, [
           :master_timeout,
           :ignore_unavailable,
+          :index_details,
+          :include_repository,
           :verbose
         ].freeze)
       end

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

@@ -0,0 +1,51 @@
+# 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
+        # Returns a list of features which can be snapshotted in this cluster.
+        #
+        # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/modules-snapshots.html
+        #
+        def get_features(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
+          arguments = arguments.clone
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = "_snapshottable_features"
+          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(:get_features, [
+          :master_timeout
+        ].freeze)
+      end
+    end
+  end
+end

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

@@ -26,7 +26,7 @@ module Elasticsearch
         # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/modules-snapshots.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.14/modules-snapshots.html
         #
         def get_repository(arguments = {})
           headers = arguments.delete(:headers) || {}

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.14/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.9/modules-snapshots.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.14/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.9/modules-snapshots.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.14/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.9/modules-snapshots.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.14/modules-snapshots.html
         #
         def verify_repository(arguments = {})
           raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]

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

@@ -20,6 +20,10 @@ module Elasticsearch
     module Tasks
       module Actions
         # Cancels a task, if it can be cancelled through an API.
+        # This functionality is Experimental and may be changed or removed
+        # completely in a future release. Elastic will take a best effort approach
+        # to fix any issues, but experimental features are not subject to the
+        # support SLA of official GA features.
         #
         # @option arguments [String] :task_id Cancel the task with specified task id (node_id:task_number)
         # @option arguments [List] :nodes A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes
@@ -28,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.9/tasks.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.14/tasks.html
         #
         def cancel(arguments = {})
           headers = arguments.delete(:headers) || {}

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

@@ -20,13 +20,17 @@ module Elasticsearch
     module Tasks
       module Actions
         # Returns information about a task.
+        # This functionality is Experimental and may be changed or removed
+        # completely in a future release. Elastic will take a best effort approach
+        # to fix any issues, but experimental features are not subject to the
+        # support SLA of official GA features.
         #
         # @option arguments [String] :task_id Return the task with specified id (node_id:task_number)
         # @option arguments [Boolean] :wait_for_completion Wait for the matching tasks to complete (default: false)
         # @option arguments [Time] :timeout Explicit operation timeout
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/tasks.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.14/tasks.html
         #
         def get(arguments = {})
           headers = arguments.delete(:headers) || {}

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

@@ -20,6 +20,10 @@ module Elasticsearch
     module Tasks
       module Actions
         # Returns a list of tasks.
+        # This functionality is Experimental and may be changed or removed
+        # completely in a future release. Elastic will take a best effort approach
+        # to fix any issues, but experimental features are not subject to the
+        # support SLA of official GA features.
         #
         # @option arguments [List] :nodes A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes
         # @option arguments [List] :actions A comma-separated list of actions that should be returned. Leave empty to return all.
@@ -30,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.9/tasks.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.14/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.9/docs-termvectors.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.14/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

@@ -34,6 +34,7 @@ module Elasticsearch
       # @option arguments [Time] :timeout Explicit operation timeout
       # @option arguments [Number] :if_seq_no only perform the update operation if the last operation that has changed the document has the specified sequence number
       # @option arguments [Number] :if_primary_term only perform the update operation if the last operation that has changed the document has the specified primary term
+      # @option arguments [Boolean] :require_alias When true, requires destination is an alias. Default is false
       # @option arguments [Hash] :headers Custom HTTP headers
       # @option arguments [Hash] :body The request definition requires either `script` or partial `doc` (*Required*)
       #
@@ -42,7 +43,7 @@ module Elasticsearch
       # Deprecated since version 7.0.0
       #
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/docs-update.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.14/docs-update.html
       #
       def update(arguments = {})
         raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -89,7 +90,8 @@ module Elasticsearch
         :routing,
         :timeout,
         :if_seq_no,
-        :if_primary_term
+        :if_primary_term,
+        :require_alias
       ].freeze)
     end
   end

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

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

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.9/docs-update-by-query.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.14/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/namespace/features.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 Features
+      module Actions; 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
+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