opensearch-ruby 3.4.0 → 4.0.0.pre.beta.2

data/lib/opensearch/api/actions/sm/get_policies.rb

@@ -0,0 +1,44 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Sm
+      module Actions
+        # Retrieves all snapshot management policies with optional pagination and filtering.
+        #
+        # @option args [Integer] :from The starting index (default: 0)
+        # @option args [String] :queryString A query string to filter policies.
+        # @option args [Integer] :size The number of policies to return.
+        # @option args [String] :sortField The field to sort on.
+        # @option args [String] :sortOrder (default: asc) The order of sorting.
+        def get_policies(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          url     = '_plugins/_sm/policies'
+
+          Utils.validate_query_params! args, GET_POLICIES_QUERY_PARAMS
+          transport.perform_request(method, url, args, body, headers).body
+        end
+
+        GET_POLICIES_QUERY_PARAMS = Set.new(%w[
+          from
+          queryString
+          size
+          sortField
+          sortOrder
+        ]).freeze
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/sm/get_policy.rb

@@ -0,0 +1,36 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Sm
+      module Actions
+        # Retrieves a specific snapshot management policy by name.
+        #
+        # @option args [String] :policy_name *Required* The name of the snapshot management policy.
+        def get_policy(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'policy_name' missing" if args['policy_name'].nil?
+
+          _policy_name = args.delete('policy_name')
+
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          url     = Utils.build_url('_plugins/_sm/policies', _policy_name)
+
+          Utils.validate_query_params! args
+          transport.perform_request(method, url, args, body, headers).body
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/sm/start_policy.rb

@@ -0,0 +1,36 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Sm
+      module Actions
+        # Starts a snapshot management policy.
+        #
+        # @option args [String] :policy_name *Required* The name of the snapshot management policy.
+        def start_policy(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'policy_name' missing" if args['policy_name'].nil?
+
+          _policy_name = args.delete('policy_name')
+
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'POST'
+          url     = Utils.build_url('_plugins/_sm/policies', _policy_name, '_start')
+
+          Utils.validate_query_params! args
+          transport.perform_request(method, url, args, body, headers).body
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/sm/stop_policy.rb

@@ -0,0 +1,36 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Sm
+      module Actions
+        # Stops a snapshot management policy.
+        #
+        # @option args [String] :policy_name *Required* The name of the snapshot management policy.
+        def stop_policy(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'policy_name' missing" if args['policy_name'].nil?
+
+          _policy_name = args.delete('policy_name')
+
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'POST'
+          url     = Utils.build_url('_plugins/_sm/policies', _policy_name, '_stop')
+
+          Utils.validate_query_params! args
+          transport.perform_request(method, url, args, body, headers).body
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/sm/update_policy.rb

@@ -0,0 +1,46 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Sm
+      module Actions
+        # Updates an existing snapshot management policy. Requires `if_seq_no` and `if_primary_term`.
+        #
+        # @option args [String] :policy_name *Required* The name of the snapshot management policy.
+        # @option args [Integer] :if_primary_term *Required* The primary term of the policy to update.
+        # @option args [Integer] :if_seq_no *Required* The sequence number of the policy to update.
+        # @option args [Hash] :body
+        def update_policy(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'policy_name' missing" if args['policy_name'].nil?
+          raise ArgumentError, "Required argument 'if_primary_term' missing" if args['if_primary_term'].nil?
+          raise ArgumentError, "Required argument 'if_seq_no' missing" if args['if_seq_no'].nil?
+
+          _policy_name = args.delete('policy_name')
+
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'PUT'
+          url     = Utils.build_url('_plugins/_sm/policies', _policy_name)
+
+          Utils.validate_query_params! args, UPDATE_POLICY_QUERY_PARAMS
+          transport.perform_request(method, url, args, body, headers).body
+        end
+
+        UPDATE_POLICY_QUERY_PARAMS = Set.new(%w[
+          if_primary_term
+          if_seq_no
+        ]).freeze
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/snapshot/cleanup_repository.rb

@@ -3,26 +3,11 @@
 # The OpenSearch Contributors require contributions made to
 # this file be licensed under the Apache-2.0 license or a
 # compatible open source license.
-#
-# Modifications Copyright OpenSearch Contributors. See
-# GitHub history for details.
-#
-# 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.
+
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
+
+# frozen_string_literal: true
 
 module OpenSearch
   module API
@@ -30,38 +15,30 @@ module OpenSearch
       module Actions
         # Removes stale data from repository.
         #
-        # @option arguments [String] :repository A repository name
-        # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Explicit operation timeout for connection to master node
-        # @option arguments [Time] :cluster_manager_timeout Explicit operation timeout for connection to cluster_manager node
-        # @option arguments [Time] :timeout Explicit operation timeout
-        # @option arguments [Hash] :headers Custom HTTP headers
-        #
-        #
-        def cleanup_repository(arguments = {})
-          raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]
-
-          headers = arguments.delete(:headers) || {}
-
-          arguments = arguments.clone
+        # @option args [String] :repository *Required* Snapshot repository to clean up.
+        # @option args [String] :cluster_manager_timeout Operation timeout for connection to cluster-manager node.
+        # @option args [String] :master_timeout DEPRECATED Period to wait for a connection to the cluster-manager node.
+        # @option args [String] :timeout Period to wait for a response.
+        def cleanup_repository(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'repository' missing" if args['repository'].nil?
 
-          _repository = arguments.delete(:repository)
+          _repository = args.delete('repository')
 
-          method = OpenSearch::API::HTTP_POST
-          path   = "_snapshot/#{Utils.__listify(_repository)}/_cleanup"
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'POST'
+          url     = Utils.build_url('_snapshot', _repository, '_cleanup')
 
-          body = nil
-          perform_request(method, path, params, body, headers).body
+          Utils.validate_query_params! args, CLEANUP_REPOSITORY_QUERY_PARAMS
+          transport.perform_request(method, url, args, body, headers).body
         end
 
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.2.0
-        ParamsRegistry.register(:cleanup_repository, %i[
-          master_timeout
+        CLEANUP_REPOSITORY_QUERY_PARAMS = Set.new(%w[
           cluster_manager_timeout
+          master_timeout
           timeout
-        ].freeze)
+        ]).freeze
       end
     end
   end

data/lib/opensearch/api/actions/snapshot/clone.rb

@@ -3,73 +3,48 @@
 # The OpenSearch Contributors require contributions made to
 # this file be licensed under the Apache-2.0 license or a
 # compatible open source license.
-#
-# Modifications Copyright OpenSearch Contributors. See
-# GitHub history for details.
-#
-# 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.
+
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
+
+# frozen_string_literal: true
 
 module OpenSearch
   module API
     module Snapshot
       module Actions
-        # Clones indices from one snapshot into another snapshot in the same repository.
-        #
-        # @option arguments [String] :repository A repository name
-        # @option arguments [String] :snapshot The name of the snapshot to clone from
-        # @option arguments [String] :target_snapshot The name of the cloned snapshot to create
-        # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Explicit operation timeout for connection to master node
-        # @option arguments [Time] :cluster_manager_timeout Explicit operation timeout for connection to cluster_manager node
-        # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body The snapshot clone definition (*Required*)
+        # Clones indexes from one snapshot into another snapshot in the same repository.
         #
-        #
-        def clone(arguments = {})
-          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
-          raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]
-          raise ArgumentError, "Required argument 'snapshot' missing" unless arguments[:snapshot]
-          raise ArgumentError, "Required argument 'target_snapshot' missing" unless arguments[:target_snapshot]
-
-          headers = arguments.delete(:headers) || {}
-
-          arguments = arguments.clone
-
-          _repository = arguments.delete(:repository)
-
-          _snapshot = arguments.delete(:snapshot)
-
-          _target_snapshot = arguments.delete(:target_snapshot)
-
-          method = OpenSearch::API::HTTP_PUT
-          path   = "_snapshot/#{Utils.__listify(_repository)}/#{Utils.__listify(_snapshot)}/_clone/#{Utils.__listify(_target_snapshot)}"
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-
-          body = arguments[:body]
-          perform_request(method, path, params, body, headers).body
+        # @option args [String] :repository *Required* A repository name
+        # @option args [String] :snapshot *Required* The name of the snapshot to clone from
+        # @option args [String] :target_snapshot *Required* The name of the cloned snapshot to create
+        # @option args [String] :cluster_manager_timeout Operation timeout for connection to cluster-manager node.
+        # @option args [String] :master_timeout DEPRECATED Explicit operation timeout for connection to cluster-manager node
+        # @option args [Hash] :body *Required* The snapshot clone definition
+        def clone(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'repository' missing" if args['repository'].nil?
+          raise ArgumentError, "Required argument 'snapshot' missing" if args['snapshot'].nil?
+          raise ArgumentError, "Required argument 'target_snapshot' missing" if args['target_snapshot'].nil?
+          raise ArgumentError, "Required argument 'body' missing" if args['body'].nil?
+
+          _repository = args.delete('repository')
+          _snapshot = args.delete('snapshot')
+          _target_snapshot = args.delete('target_snapshot')
+
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'PUT'
+          url     = Utils.build_url('_snapshot', _repository, _snapshot, '_clone', _target_snapshot)
+
+          Utils.validate_query_params! args, CLONE_QUERY_PARAMS
+          transport.perform_request(method, url, args, body, headers).body
         end
 
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.2.0
-        ParamsRegistry.register(:clone, %i[
-          master_timeout
+        CLONE_QUERY_PARAMS = Set.new(%w[
           cluster_manager_timeout
-        ].freeze)
+          master_timeout
+        ]).freeze
       end
     end
   end

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

@@ -3,26 +3,11 @@
 # The OpenSearch Contributors require contributions made to
 # this file be licensed under the Apache-2.0 license or a
 # compatible open source license.
-#
-# Modifications Copyright OpenSearch Contributors. See
-# GitHub history for details.
-#
-# 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.
+
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
+
+# frozen_string_literal: true
 
 module OpenSearch
   module API
@@ -30,43 +15,34 @@ module OpenSearch
       module Actions
         # Creates a snapshot in a repository.
         #
-        # @option arguments [String] :repository A repository name
-        # @option arguments [String] :snapshot A snapshot name
-        # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Explicit operation timeout for connection to master node
-        # @option arguments [Time] :cluster_manager_timeout Explicit operation timeout for connection to cluster_manager node
-        # @option arguments [Boolean] :wait_for_completion Should this request wait until the operation has completed before returning
-        # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body The snapshot definition
-        #
-        #
-        def create(arguments = {})
-          raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]
-          raise ArgumentError, "Required argument 'snapshot' missing" unless arguments[:snapshot]
-
-          headers = arguments.delete(:headers) || {}
-
-          arguments = arguments.clone
-
-          _repository = arguments.delete(:repository)
-
-          _snapshot = arguments.delete(:snapshot)
-
-          method = OpenSearch::API::HTTP_PUT
-          path   = "_snapshot/#{Utils.__listify(_repository)}/#{Utils.__listify(_snapshot)}"
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-
-          body = arguments[:body]
-          perform_request(method, path, params, body, headers).body
+        # @option args [String] :repository *Required* Repository for the snapshot.
+        # @option args [String] :snapshot *Required* Name of the snapshot. Must be unique in the repository.
+        # @option args [String] :cluster_manager_timeout Operation timeout for connection to cluster-manager node.
+        # @option args [String] :master_timeout DEPRECATED Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error.
+        # @option args [Boolean] :wait_for_completion If `true`, the request returns a response when the snapshot is complete. If `false`, the request returns a response when the snapshot initializes.
+        # @option args [Hash] :body The snapshot definition
+        def create(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'repository' missing" if args['repository'].nil?
+          raise ArgumentError, "Required argument 'snapshot' missing" if args['snapshot'].nil?
+
+          _repository = args.delete('repository')
+          _snapshot = args.delete('snapshot')
+
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'POST'
+          url     = Utils.build_url('_snapshot', _repository, _snapshot)
+
+          Utils.validate_query_params! args, CREATE_QUERY_PARAMS
+          transport.perform_request(method, url, args, body, headers).body
         end
 
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.2.0
-        ParamsRegistry.register(:create, %i[
-          master_timeout
+        CREATE_QUERY_PARAMS = Set.new(%w[
           cluster_manager_timeout
+          master_timeout
           wait_for_completion
-        ].freeze)
+        ]).freeze
       end
     end
   end

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

@@ -3,26 +3,11 @@
 # The OpenSearch Contributors require contributions made to
 # this file be licensed under the Apache-2.0 license or a
 # compatible open source license.
-#
-# Modifications Copyright OpenSearch Contributors. See
-# GitHub history for details.
-#
-# 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.
+
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
+
+# frozen_string_literal: true
 
 module OpenSearch
   module API
@@ -30,42 +15,34 @@ module OpenSearch
       module Actions
         # Creates a repository.
         #
-        # @option arguments [String] :repository A repository name
-        # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Explicit operation timeout for connection to master node
-        # @option arguments [Time] :cluster_manager_timeout Explicit operation timeout for connection to cluster_manager node
-        # @option arguments [Time] :timeout Explicit operation timeout
-        # @option arguments [Boolean] :verify Whether to verify the repository after creation
-        # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body The repository definition (*Required*)
-        #
-        #
-        def create_repository(arguments = {})
-          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
-          raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]
-
-          headers = arguments.delete(:headers) || {}
-
-          arguments = arguments.clone
+        # @option args [String] :repository *Required* A repository name
+        # @option args [String] :cluster_manager_timeout Operation timeout for connection to cluster-manager node.
+        # @option args [String] :master_timeout DEPRECATED Explicit operation timeout for connection to cluster-manager node
+        # @option args [String] :timeout Explicit operation timeout
+        # @option args [Boolean] :verify Whether to verify the repository after creation
+        # @option args [Hash] :body *Required* The repository definition
+        def create_repository(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'repository' missing" if args['repository'].nil?
+          raise ArgumentError, "Required argument 'body' missing" if args['body'].nil?
 
-          _repository = arguments.delete(:repository)
+          _repository = args.delete('repository')
 
-          method = OpenSearch::API::HTTP_PUT
-          path   = "_snapshot/#{Utils.__listify(_repository)}"
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'POST'
+          url     = Utils.build_url('_snapshot', _repository)
 
-          body = arguments[:body]
-          perform_request(method, path, params, body, headers).body
+          Utils.validate_query_params! args, CREATE_REPOSITORY_QUERY_PARAMS
+          transport.perform_request(method, url, args, body, headers).body
         end
 
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.2.0
-        ParamsRegistry.register(:create_repository, %i[
-          master_timeout
+        CREATE_REPOSITORY_QUERY_PARAMS = Set.new(%w[
           cluster_manager_timeout
+          master_timeout
           timeout
           verify
-        ].freeze)
+        ]).freeze
       end
     end
   end