elasticsearch-api 7.13.3 → 8.14.0

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

@@ -14,7 +14,10 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
-
+#
+# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
+# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
+#
 module Elasticsearch
   module API
     module Snapshot
@@ -26,12 +29,20 @@ 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.13/modules-snapshots.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.14/modules-snapshots.html
         #
         def get_repository(arguments = {})
-          headers = arguments.delete(:headers) || {}
+          request_opts = { endpoint: arguments[:endpoint] || 'snapshot.get_repository' }
+
+          defined_params = [:repository].each_with_object({}) do |variable, set_variables|
+            set_variables[variable] = arguments[variable] if arguments.key?(variable)
+          end
+          request_opts[:defined_params] = defined_params unless defined_params.empty?
 
           arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
 
           _repository = arguments.delete(:repository)
 
@@ -39,25 +50,22 @@ module Elasticsearch
           path   = if _repository
                      "_snapshot/#{Utils.__listify(_repository)}"
                    else
-                     "_snapshot"
+                     '_snapshot'
                    end
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+          params = Utils.process_params(arguments)
 
-          body = nil
           if Array(arguments[:ignore]).include?(404)
-            Utils.__rescue_from_not_found { perform_request(method, path, params, body, headers).body }
+            Utils.__rescue_from_not_found do
+              Elasticsearch::API::Response.new(
+                perform_request(method, path, params, body, headers, request_opts)
+              )
+            end
           else
-            perform_request(method, path, params, body, headers).body
+            Elasticsearch::API::Response.new(
+              perform_request(method, path, params, body, headers, request_opts)
+            )
           end
         end
-
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.2.0
-        ParamsRegistry.register(:get_repository, [
-          :master_timeout,
-          :local
-        ].freeze)
       end
     end
   end

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

@@ -0,0 +1,71 @@
+# 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.
+#
+# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
+# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
+#
+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/8.14/modules-snapshots.html
+        #
+        def repository_analyze(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'snapshot.repository_analyze' }
+
+          defined_params = [:repository].each_with_object({}) do |variable, set_variables|
+            set_variables[variable] = arguments[variable] if arguments.key?(variable)
+          end
+          request_opts[:defined_params] = defined_params unless defined_params.empty?
+
+          raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]
+
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          _repository = arguments.delete(:repository)
+
+          method = Elasticsearch::API::HTTP_POST
+          path   = "_snapshot/#{Utils.__listify(_repository)}/_analyze"
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers, request_opts)
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -14,7 +14,10 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
-
+#
+# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
+# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
+#
 module Elasticsearch
   module API
     module Snapshot
@@ -28,15 +31,23 @@ 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.13/modules-snapshots.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.14/modules-snapshots.html
         #
         def restore(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'snapshot.restore' }
+
+          defined_params = %i[repository snapshot].each_with_object({}) do |variable, set_variables|
+            set_variables[variable] = arguments[variable] if arguments.key?(variable)
+          end
+          request_opts[:defined_params] = defined_params unless defined_params.empty?
+
           raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]
           raise ArgumentError, "Required argument 'snapshot' missing" unless arguments[:snapshot]
 
+          arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          arguments = arguments.clone
+          body = arguments.delete(:body)
 
           _repository = arguments.delete(:repository)
 
@@ -44,19 +55,12 @@ module Elasticsearch
 
           method = Elasticsearch::API::HTTP_POST
           path   = "_snapshot/#{Utils.__listify(_repository)}/#{Utils.__listify(_snapshot)}/_restore"
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+          params = Utils.process_params(arguments)
 
-          body = arguments[:body]
-          perform_request(method, path, params, body, headers).body
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers, request_opts)
+          )
         end
-
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.2.0
-        ParamsRegistry.register(:restore, [
-          :master_timeout,
-          :wait_for_completion
-        ].freeze)
       end
     end
   end

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

@@ -14,7 +14,10 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
-
+#
+# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
+# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
+#
 module Elasticsearch
   module API
     module Snapshot
@@ -27,12 +30,20 @@ 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.13/modules-snapshots.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.14/modules-snapshots.html
         #
         def status(arguments = {})
-          headers = arguments.delete(:headers) || {}
+          request_opts = { endpoint: arguments[:endpoint] || 'snapshot.status' }
+
+          defined_params = %i[repository snapshot].each_with_object({}) do |variable, set_variables|
+            set_variables[variable] = arguments[variable] if arguments.key?(variable)
+          end
+          request_opts[:defined_params] = defined_params unless defined_params.empty?
 
           arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
 
           _repository = arguments.delete(:repository)
 
@@ -44,25 +55,22 @@ module Elasticsearch
                    elsif _repository
                      "_snapshot/#{Utils.__listify(_repository)}/_status"
                    else
-                     "_snapshot/_status"
+                     '_snapshot/_status'
                    end
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+          params = Utils.process_params(arguments)
 
-          body = nil
           if Array(arguments[:ignore]).include?(404)
-            Utils.__rescue_from_not_found { perform_request(method, path, params, body, headers).body }
+            Utils.__rescue_from_not_found do
+              Elasticsearch::API::Response.new(
+                perform_request(method, path, params, body, headers, request_opts)
+              )
+            end
           else
-            perform_request(method, path, params, body, headers).body
+            Elasticsearch::API::Response.new(
+              perform_request(method, path, params, body, headers, request_opts)
+            )
           end
         end
-
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.2.0
-        ParamsRegistry.register(:status, [
-          :master_timeout,
-          :ignore_unavailable
-        ].freeze)
       end
     end
   end

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

@@ -14,7 +14,10 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
-
+#
+# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
+# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
+#
 module Elasticsearch
   module API
     module Snapshot
@@ -26,32 +29,33 @@ 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.13/modules-snapshots.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.14/modules-snapshots.html
         #
         def verify_repository(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'snapshot.verify_repository' }
+
+          defined_params = [:repository].each_with_object({}) do |variable, set_variables|
+            set_variables[variable] = arguments[variable] if arguments.key?(variable)
+          end
+          request_opts[:defined_params] = defined_params unless defined_params.empty?
+
           raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]
 
+          arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          arguments = arguments.clone
+          body = nil
 
           _repository = arguments.delete(:repository)
 
           method = Elasticsearch::API::HTTP_POST
           path   = "_snapshot/#{Utils.__listify(_repository)}/_verify"
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+          params = Utils.process_params(arguments)
 
-          body = nil
-          perform_request(method, path, params, body, headers).body
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers, request_opts)
+          )
         end
-
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.2.0
-        ParamsRegistry.register(:verify_repository, [
-          :master_timeout,
-          :timeout
-        ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/delete_lifecycle.rb

@@ -0,0 +1,60 @@
+# 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.
+#
+# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
+# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
+#
+module Elasticsearch
+  module API
+    module SnapshotLifecycleManagement
+      module Actions
+        # Deletes an existing snapshot lifecycle policy.
+        #
+        # @option arguments [String] :policy_id The id of the snapshot lifecycle policy to remove
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.14/slm-api-delete-policy.html
+        #
+        def delete_lifecycle(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'slm.delete_lifecycle' }
+
+          defined_params = [:policy_id].each_with_object({}) do |variable, set_variables|
+            set_variables[variable] = arguments[variable] if arguments.key?(variable)
+          end
+          request_opts[:defined_params] = defined_params unless defined_params.empty?
+
+          raise ArgumentError, "Required argument 'policy_id' missing" unless arguments[:policy_id]
+
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          _policy_id = arguments.delete(:policy_id)
+
+          method = Elasticsearch::API::HTTP_DELETE
+          path   = "_slm/policy/#{Utils.__listify(_policy_id)}"
+          params = {}
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers, request_opts)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/execute_lifecycle.rb

@@ -0,0 +1,60 @@
+# 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.
+#
+# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
+# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
+#
+module Elasticsearch
+  module API
+    module SnapshotLifecycleManagement
+      module Actions
+        # Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time.
+        #
+        # @option arguments [String] :policy_id The id of the snapshot lifecycle policy to be executed
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.14/slm-api-execute-lifecycle.html
+        #
+        def execute_lifecycle(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'slm.execute_lifecycle' }
+
+          defined_params = [:policy_id].each_with_object({}) do |variable, set_variables|
+            set_variables[variable] = arguments[variable] if arguments.key?(variable)
+          end
+          request_opts[:defined_params] = defined_params unless defined_params.empty?
+
+          raise ArgumentError, "Required argument 'policy_id' missing" unless arguments[:policy_id]
+
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          _policy_id = arguments.delete(:policy_id)
+
+          method = Elasticsearch::API::HTTP_PUT
+          path   = "_slm/policy/#{Utils.__listify(_policy_id)}/_execute"
+          params = {}
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers, request_opts)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/execute_retention.rb

@@ -0,0 +1,50 @@
+# 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.
+#
+# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
+# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
+#
+module Elasticsearch
+  module API
+    module SnapshotLifecycleManagement
+      module Actions
+        # Deletes any snapshots that are expired according to the policy's retention rules.
+        #
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.14/slm-api-execute-retention.html
+        #
+        def execute_retention(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'slm.execute_retention' }
+
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body   = nil
+
+          method = Elasticsearch::API::HTTP_POST
+          path   = '_slm/_execute_retention'
+          params = {}
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers, request_opts)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_lifecycle.rb

@@ -0,0 +1,62 @@
+# 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.
+#
+# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
+# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
+#
+module Elasticsearch
+  module API
+    module SnapshotLifecycleManagement
+      module Actions
+        # Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts.
+        #
+        # @option arguments [List] :policy_id Comma-separated list of snapshot lifecycle policies to retrieve
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.14/slm-api-get-policy.html
+        #
+        def get_lifecycle(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'slm.get_lifecycle' }
+
+          defined_params = [:policy_id].each_with_object({}) do |variable, set_variables|
+            set_variables[variable] = arguments[variable] if arguments.key?(variable)
+          end
+          request_opts[:defined_params] = defined_params unless defined_params.empty?
+
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          _policy_id = arguments.delete(:policy_id)
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = if _policy_id
+                     "_slm/policy/#{Utils.__listify(_policy_id)}"
+                   else
+                     '_slm/policy'
+                   end
+          params = {}
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers, request_opts)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_stats.rb

@@ -0,0 +1,50 @@
+# 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.
+#
+# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
+# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
+#
+module Elasticsearch
+  module API
+    module SnapshotLifecycleManagement
+      module Actions
+        # Returns global and policy-level statistics about actions taken by snapshot lifecycle management.
+        #
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.14/slm-api-get-stats.html
+        #
+        def get_stats(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'slm.get_stats' }
+
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body   = nil
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = '_slm/stats'
+          params = {}
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers, request_opts)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_status.rb

@@ -0,0 +1,50 @@
+# 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.
+#
+# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
+# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
+#
+module Elasticsearch
+  module API
+    module SnapshotLifecycleManagement
+      module Actions
+        # Retrieves the status of snapshot lifecycle management (SLM).
+        #
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.14/slm-api-get-status.html
+        #
+        def get_status(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'slm.get_status' }
+
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body   = nil
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = '_slm/status'
+          params = {}
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers, request_opts)
+          )
+        end
+      end
+    end
+  end
+end