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

data/lib/opensearch/api/actions/insights/top_queries.rb

@@ -0,0 +1,38 @@
+# 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 Insights
+      module Actions
+        # Retrieves the top queries based on the given metric type (latency, CPU, or memory).
+        #
+        # @option args [String] :type *Required* Get top n queries by a specific metric.
+        def top_queries(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'type' missing" if args['type'].nil?
+
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          url     = '_insights/top_queries'
+
+          Utils.validate_query_params! args, TOP_QUERIES_QUERY_PARAMS
+          transport.perform_request(method, url, args, body, headers).body
+        end
+
+        TOP_QUERIES_QUERY_PARAMS = Set.new(%w[
+          type
+        ]).freeze
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/ism/add_policy.rb

@@ -0,0 +1,37 @@
+# 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 Ism
+      module Actions
+        # Adds a policy to an index.
+        #
+        # @option args [String] :index *Required* Comma-separated list of data streams, indexes, and aliases. Supports wildcards (`*`).
+        # @option args [Hash] :body
+        def add_policy(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'index' missing" if args['index'].nil?
+
+          _index = args.delete('index')
+
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'POST'
+          url     = Utils.build_url('_plugins/_ism/add', _index)
+
+          Utils.validate_query_params! args
+          transport.perform_request(method, url, args, body, headers).body
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/ism/change_policy.rb

@@ -0,0 +1,37 @@
+# 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 Ism
+      module Actions
+        # Updates the managed index policy to a new policy.
+        #
+        # @option args [String] :index *Required* Comma-separated list of data streams, indexes, and aliases. Supports wildcards (`*`).
+        # @option args [Hash] :body
+        def change_policy(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'index' missing" if args['index'].nil?
+
+          _index = args.delete('index')
+
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'POST'
+          url     = Utils.build_url('_plugins/_ism/change_policy', _index)
+
+          Utils.validate_query_params! args
+          transport.perform_request(method, url, args, body, headers).body
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/ism/delete_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 Ism
+      module Actions
+        # Deletes a policy.
+        #
+        # @option args [String] :policy_id *Required*
+        def delete_policy(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'policy_id' missing" if args['policy_id'].nil?
+
+          _policy_id = args.delete('policy_id')
+
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'DELETE'
+          url     = Utils.build_url('_plugins/_ism/policies', _policy_id)
+
+          Utils.validate_query_params! args
+          transport.perform_delete_request method, url, args, body, headers
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/ism/exists_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 Ism
+      module Actions
+        # Checks whether the policy exists.
+        #
+        # @option args [String] :policy_id *Required*
+        def exists_policy(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'policy_id' missing" if args['policy_id'].nil?
+
+          _policy_id = args.delete('policy_id')
+
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'HEAD'
+          url     = Utils.build_url('_plugins/_ism/policies', _policy_id)
+
+          Utils.validate_query_params! args
+          transport.perform_head_request method, url, args, body, headers
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/ism/explain_policy.rb

@@ -0,0 +1,35 @@
+# 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 Ism
+      module Actions
+        # Gets the currently applied policy on indexes.
+        #
+        # @option args [String] :index Comma-separated list of data streams, indexes, and aliases. Supports wildcards (`*`).
+        # @option args [Hash] :body
+        def explain_policy(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          _index = args.delete('index')
+
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = body ? 'POST' : 'GET'
+          url     = Utils.build_url('_plugins/_ism/explain', _index)
+
+          Utils.validate_query_params! args
+          transport.perform_request(method, url, args, body, headers).body
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# 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 Ism
+      module Actions
+        # Gets the policies.
+        #
+        def get_policies(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          url     = '_plugins/_ism/policies'
+
+          Utils.validate_query_params! args
+          transport.perform_request(method, url, args, body, headers).body
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/ism/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 Ism
+      module Actions
+        # Gets a policy.
+        #
+        # @option args [String] :policy_id *Required*
+        def get_policy(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'policy_id' missing" if args['policy_id'].nil?
+
+          _policy_id = args.delete('policy_id')
+
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          url     = Utils.build_url('_plugins/_ism/policies', _policy_id)
+
+          Utils.validate_query_params! args
+          transport.perform_request(method, url, args, body, headers).body
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/ism/put_policies.rb

@@ -0,0 +1,43 @@
+# 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 Ism
+      module Actions
+        # Gets the policies.
+        #
+        # @option args [Float] :if_primary_term Only perform the operation if the document has this primary term.
+        # @option args [Integer] :if_seq_no Only perform the operation if the document has this sequence number.
+        # @option args [String] :policyID *Required*
+        # @option args [Hash] :body
+        def put_policies(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'policyID' missing" if args['policyID'].nil?
+
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'PUT'
+          url     = '_plugins/_ism/policies'
+
+          Utils.validate_query_params! args, PUT_POLICIES_QUERY_PARAMS
+          transport.perform_request(method, url, args, body, headers).body
+        end
+
+        PUT_POLICIES_QUERY_PARAMS = Set.new(%w[
+          if_primary_term
+          if_seq_no
+          policyID
+        ]).freeze
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/ism/put_policy.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 Ism
+      module Actions
+        # Creates or updates a policy.
+        #
+        # @option args [String] :policy_id *Required*
+        # @option args [Float] :if_primary_term Only perform the operation if the document has this primary term.
+        # @option args [Integer] :if_seq_no Only perform the operation if the document has this sequence number.
+        # @option args [Hash] :body
+        def put_policy(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'policy_id' missing" if args['policy_id'].nil?
+
+          _policy_id = args.delete('policy_id')
+
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'PUT'
+          url     = Utils.build_url('_plugins/_ism/policies', _policy_id)
+
+          Utils.validate_query_params! args, PUT_POLICY_QUERY_PARAMS
+          transport.perform_request(method, url, args, body, headers).body
+        end
+
+        PUT_POLICY_QUERY_PARAMS = Set.new(%w[
+          if_primary_term
+          if_seq_no
+        ]).freeze
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/ism/refresh_search_analyzers.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 Ism
+      module Actions
+        # Refresh search analyzers in real time.
+        #
+        # @option args [String] :index *Required* Comma-separated list of data streams, indexes, and aliases. Supports wildcards (`*`).
+        def refresh_search_analyzers(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'index' missing" if args['index'].nil?
+
+          _index = args.delete('index')
+
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'POST'
+          url     = Utils.build_url('_plugins/_refresh_search_analyzers', _index)
+
+          Utils.validate_query_params! args
+          transport.perform_request(method, url, args, body, headers).body
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/ism/remove_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 Ism
+      module Actions
+        # Removes a policy from an index.
+        #
+        # @option args [String] :index *Required* Comma-separated list of data streams, indexes, and aliases. Supports wildcards (`*`).
+        def remove_policy(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'index' missing" if args['index'].nil?
+
+          _index = args.delete('index')
+
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'POST'
+          url     = Utils.build_url('_plugins/_ism/remove', _index)
+
+          Utils.validate_query_params! args
+          transport.perform_request(method, url, args, body, headers).body
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/ism/retry_index.rb

@@ -0,0 +1,37 @@
+# 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 Ism
+      module Actions
+        # Retry the failed action for an index.
+        #
+        # @option args [String] :index *Required* Comma-separated list of data streams, indexes, and aliases. Supports wildcards (`*`).
+        # @option args [Hash] :body
+        def retry_index(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'index' missing" if args['index'].nil?
+
+          _index = args.delete('index')
+
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'POST'
+          url     = Utils.build_url('_plugins/_ism/retry', _index)
+
+          Utils.validate_query_params! args
+          transport.perform_request(method, url, args, body, headers).body
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/knn/delete_model.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 Knn
+      module Actions
+        # Used to delete a particular model in the cluster.
+        #
+        # @option args [String] :model_id *Required* The id of the model.
+        def delete_model(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'model_id' missing" if args['model_id'].nil?
+
+          _model_id = args.delete('model_id')
+
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'DELETE'
+          url     = Utils.build_url('_plugins/_knn/models', _model_id)
+
+          Utils.validate_query_params! args
+          transport.perform_delete_request method, url, args, body, headers
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/knn/get_model.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 Knn
+      module Actions
+        # Used to retrieve information about models present in the cluster.
+        #
+        # @option args [String] :model_id *Required* The id of the model.
+        def get_model(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'model_id' missing" if args['model_id'].nil?
+
+          _model_id = args.delete('model_id')
+
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          url     = Utils.build_url('_plugins/_knn/models', _model_id)
+
+          Utils.validate_query_params! args
+          transport.perform_request(method, url, args, body, headers).body
+        end
+      end
+    end
+  end
+end