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

data/lib/opensearch/api/actions/observability/get_object.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 Observability
+      module Actions
+        # Retrieves specific observability object specified by ID.
+        #
+        # @option args [String] :object_id *Required* The ID of the Observability Object.
+        def get_object(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'object_id' missing" if args['object_id'].nil?
+
+          _object_id = args.delete('object_id')
+
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          url     = Utils.build_url('_plugins/_observability/object', _object_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/observability/list_objects.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 Observability
+      module Actions
+        # Retrieves list of all observability objects.
+        #
+        def list_objects(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          url     = '_plugins/_observability/object'
+
+          Utils.validate_query_params! args
+          transport.perform_request(method, url, args, body, headers).body
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/observability/update_object.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 Observability
+      module Actions
+        # Updates an existing observability object.
+        #
+        # @option args [String] :object_id *Required* The ID of the Observability Object.
+        # @option args [Hash] :body
+        def update_object(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'object_id' missing" if args['object_id'].nil?
+
+          _object_id = args.delete('object_id')
+
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'PUT'
+          url     = Utils.build_url('_plugins/_observability/object', _object_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/ping.rb

@@ -3,50 +3,27 @@
 # 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.
 
-module OpenSearch
-  module API
-    module Actions
-      # Returns whether the cluster is running.
-      #
-      # @option arguments [Hash] :headers Custom HTTP headers
-      #
-      #
-      def ping(arguments = {})
-        headers = arguments.delete(:headers) || {}
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
 
-        arguments = arguments.clone
+# frozen_string_literal: true
 
-        method = OpenSearch::API::HTTP_HEAD
-        path   = ''
-        params = {}
+module OpenSearch
+  module API
+    module Root
+      module Actions
+        # Returns whether the cluster is running.
+        #
+        def ping(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'HEAD'
+          url     = '/'
 
-        body = nil
-        begin
-          perform_request(method, path, params, body, headers).status == 200
-        rescue StandardError => e
-          raise e unless e.class.to_s =~ /NotFound|ConnectionFailed/ || e.message =~ /Not *Found|404|ConnectionFailed/i
-          false
+          Utils.validate_query_params! args
+          transport.perform_ping_request method, url, args, body, headers
         end
       end
     end

data/lib/opensearch/api/actions/ppl/explain.rb

@@ -0,0 +1,41 @@
+# 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 Ppl
+      module Actions
+        # Shows how a query is executed against OpenSearch.
+        #
+        # @option args [String] :format A short version of the Accept header (for example, `json`, `yaml`).
+        # @option args [Boolean] :sanitize (default: true) Specifies whether to escape special characters in the results.
+        # @option args [Hash] :body *Required*
+        def explain(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'body' missing" if args['body'].nil?
+
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'POST'
+          url     = '_plugins/_ppl/_explain'
+
+          Utils.validate_query_params! args, EXPLAIN_QUERY_PARAMS
+          transport.perform_request(method, url, args, body, headers).body
+        end
+
+        EXPLAIN_QUERY_PARAMS = Set.new(%w[
+          format
+          sanitize
+        ]).freeze
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/ppl/get_stats.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 Ppl
+      module Actions
+        # Collect metrics for the plugin within the interval.
+        #
+        # @option args [String] :format A short version of the Accept header (for example, `json`, `yaml`).
+        # @option args [Boolean] :sanitize (default: true) Specifies whether to escape special characters in the results.
+        def get_stats(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          url     = '_plugins/_ppl/stats'
+
+          Utils.validate_query_params! args, GET_STATS_QUERY_PARAMS
+          transport.perform_request(method, url, args, body, headers).body
+        end
+
+        GET_STATS_QUERY_PARAMS = Set.new(%w[
+          format
+          sanitize
+        ]).freeze
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/ppl/post_stats.rb

@@ -0,0 +1,41 @@
+# 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 Ppl
+      module Actions
+        # By a stats endpoint, you are able to collect metrics for the plugin within the interval.
+        #
+        # @option args [String] :format A short version of the Accept header (for example, `json`, `yaml`).
+        # @option args [Boolean] :sanitize (default: true) Specifies whether to escape special characters in the results.
+        # @option args [Hash] :body *Required*
+        def post_stats(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'body' missing" if args['body'].nil?
+
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'POST'
+          url     = '_plugins/_ppl/stats'
+
+          Utils.validate_query_params! args, POST_STATS_QUERY_PARAMS
+          transport.perform_request(method, url, args, body, headers).body
+        end
+
+        POST_STATS_QUERY_PARAMS = Set.new(%w[
+          format
+          sanitize
+        ]).freeze
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/ppl/query.rb

@@ -0,0 +1,41 @@
+# 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 Ppl
+      module Actions
+        # Send a PPL query to the PPL plugin.
+        #
+        # @option args [String] :format A short version of the Accept header (for example, `json`, `yaml`).
+        # @option args [Boolean] :sanitize (default: true) Specifies whether to escape special characters in the results.
+        # @option args [Hash] :body *Required*
+        def query(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'body' missing" if args['body'].nil?
+
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'POST'
+          url     = '_plugins/_ppl'
+
+          Utils.validate_query_params! args, QUERY_QUERY_PARAMS
+          transport.perform_request(method, url, args, body, headers).body
+        end
+
+        QUERY_QUERY_PARAMS = Set.new(%w[
+          format
+          sanitize
+        ]).freeze
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/put_script.rb

@@ -3,74 +3,47 @@
 # 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.
-
-module OpenSearch
-  module API
-    module Actions
-      # Creates or updates a script.
-      #
-      # @option arguments [String] :id Script ID
-      # @option arguments [String] :context Script context
-      # @option arguments [Time] :timeout Explicit operation timeout
-      # @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Specify timeout for connection to master
-      # @option arguments [Time] :cluster_manager_timeout Specify timeout for connection to cluster_manager
-      # @option arguments [Hash] :headers Custom HTTP headers
-      # @option arguments [Hash] :body The document (*Required*)
-      #
-      #
-      def put_script(arguments = {})
-        raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
-        raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
 
-        headers = arguments.delete(:headers) || {}
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
 
-        arguments = arguments.clone
+# frozen_string_literal: true
 
-        _id = arguments.delete(:id)
-
-        _context = arguments.delete(:context)
-
-        method = OpenSearch::API::HTTP_PUT
-        path   = if _id && _context
-                   "_scripts/#{Utils.__listify(_id)}/#{Utils.__listify(_context)}"
-                 else
-                   "_scripts/#{Utils.__listify(_id)}"
-                 end
-        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-
-        body = arguments[:body]
-        perform_request(method, path, params, body, headers).body
+module OpenSearch
+  module API
+    module Root
+      module Actions
+        # Creates or updates a script.
+        #
+        # @option args [String] :id *Required* Identifier for the stored script or search template. Must be unique within the cluster.
+        # @option args [String] :cluster_manager_timeout Operation timeout for connection to cluster-manager node.
+        # @option args [String] :context Context in which the script or search template should run. To prevent errors, the API immediately compiles the script or template in this context.
+        # @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 [String] :timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.
+        # @option args [Hash] :body *Required* The document
+        def put_script(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'id' missing" if args['id'].nil?
+          raise ArgumentError, "Required argument 'body' missing" if args['body'].nil?
+
+          _id = args.delete('id')
+          _context = args.delete('context')
+
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = _context.nil? ? 'POST' : 'PUT'
+          url     = Utils.build_url('_scripts', _id, _context)
+
+          Utils.validate_query_params! args, PUT_SCRIPT_QUERY_PARAMS
+          transport.perform_request(method, url, args, body, headers).body
+        end
+
+        PUT_SCRIPT_QUERY_PARAMS = Set.new(%w[
+          cluster_manager_timeout
+          master_timeout
+          timeout
+        ]).freeze
       end
-
-      # Register this action with its valid params when the module is loaded.
-      #
-      # @since 6.2.0
-      ParamsRegistry.register(:put_script, %i[
-        timeout
-        master_timeout
-        cluster_manager_timeout
-        context
-      ].freeze)
     end
   end
 end

data/lib/opensearch/api/actions/query/datasource_delete.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 Query
+      module Actions
+        # Deletes specific datasource specified by name.
+        #
+        # @option args [String] :datasource_name *Required* The Name of the DataSource to delete.
+        # @option args [List] :ignore set to [404] to ignore server's NOT FOUND error for this request
+        def datasource_delete(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'datasource_name' missing" if args['datasource_name'].nil?
+
+          _datasource_name = args.delete('datasource_name')
+
+          ignore  = args.delete('ignore') || []
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'DELETE'
+          url     = Utils.build_url('_plugins/_query/_datasources', _datasource_name)
+
+          Utils.validate_query_params! args
+          transport.perform_delete_request method, url, args, body, headers, ignore.include?(404)
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/query/datasource_retrieve.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 Query
+      module Actions
+        # Retrieves specific datasource specified by name.
+        #
+        # @option args [String] :datasource_name *Required* The Name of the DataSource to retrieve.
+        def datasource_retrieve(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'datasource_name' missing" if args['datasource_name'].nil?
+
+          _datasource_name = args.delete('datasource_name')
+
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          url     = Utils.build_url('_plugins/_query/_datasources', _datasource_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/query/datasources_create.rb

@@ -0,0 +1,32 @@
+# 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 Query
+      module Actions
+        # Creates a new query datasource.
+        #
+        # @option args [Hash] :body
+        def datasources_create(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'POST'
+          url     = '_plugins/_query/_datasources'
+
+          Utils.validate_query_params! args
+          transport.perform_request(method, url, args, body, headers).body
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/query/datasources_list.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 Query
+      module Actions
+        # Retrieves list of all datasources.
+        #
+        def datasources_list(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          url     = '_plugins/_query/_datasources'
+
+          Utils.validate_query_params! args
+          transport.perform_request(method, url, args, body, headers).body
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/query/datasources_update.rb

@@ -0,0 +1,32 @@
+# 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 Query
+      module Actions
+        # Updates an existing query datasource.
+        #
+        # @option args [Hash] :body
+        def datasources_update(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'PUT'
+          url     = '_plugins/_query/_datasources'
+
+          Utils.validate_query_params! args
+          transport.perform_request(method, url, args, body, headers).body
+        end
+      end
+    end
+  end
+end