opensearch-ruby 2.0.3 → 3.4.0

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

@@ -0,0 +1,137 @@
+# 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.
+#
+# 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
+      # Performs an update on every document in the index without changing the source,
+      # for example to pick up a mapping change.
+      #
+      # @option arguments [List] :index A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices (*Required*)
+      # @option arguments [String] :analyzer The analyzer to use for the query string
+      # @option arguments [Boolean] :analyze_wildcard Specify whether wildcard and prefix queries should be analyzed (default: false)
+      # @option arguments [String] :default_operator The default operator for query string query (AND or OR) (options: AND, OR)
+      # @option arguments [String] :df The field to use as default where no field prefix is given in the query string
+      # @option arguments [Number] :from Starting offset (default: 0)
+      # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
+      # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
+      # @option arguments [String] :conflicts What to do when the update by query hits version conflicts? (options: abort, proceed)
+      # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
+      # @option arguments [Boolean] :lenient Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
+      # @option arguments [String] :pipeline Ingest pipeline to set on index requests made by this action. (default: none)
+      # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random)
+      # @option arguments [String] :q Query in the Lucene query string syntax
+      # @option arguments [List] :routing A comma-separated list of specific routing values
+      # @option arguments [Time] :scroll Specify how long a consistent view of the index should be maintained for scrolled search
+      # @option arguments [String] :search_type Search operation type (options: query_then_fetch, dfs_query_then_fetch)
+      # @option arguments [Time] :search_timeout Explicit timeout for each search request. Defaults to no timeout.
+      # @option arguments [Number] :size Deprecated, please use `max_docs` instead
+      # @option arguments [Number] :max_docs Maximum number of documents to process (default: all documents)
+      # @option arguments [List] :sort A comma-separated list of <field>:<direction> pairs
+      # @option arguments [List] :_source True or false to return the _source field or not, or a list of fields to return
+      # @option arguments [List] :_source_excludes A list of fields to exclude from the returned _source field
+      # @option arguments [List] :_source_includes A list of fields to extract and return from the _source field
+      # @option arguments [Number] :terminate_after The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.
+      # @option arguments [List] :stats Specific 'tag' of the request for logging and statistical purposes
+      # @option arguments [Boolean] :version Specify whether to return document version as part of a hit
+      # @option arguments [Boolean] :version_type Should the document increment the version number (internal) on hit or not (reindex)
+      # @option arguments [Boolean] :request_cache Specify if request cache should be used for this request or not, defaults to index level setting
+      # @option arguments [Boolean] :refresh Should the affected indexes be refreshed?
+      # @option arguments [Time] :timeout Time each individual bulk request should wait for shards that are unavailable.
+      # @option arguments [String] :wait_for_active_shards Sets the number of shard copies that must be active before proceeding with the update by query operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)
+      # @option arguments [Number] :scroll_size Size on the scroll request powering the update by query
+      # @option arguments [Boolean] :wait_for_completion Should the request should block until the update by query operation is complete.
+      # @option arguments [Number] :requests_per_second The throttle to set on this request in sub-requests per second. -1 means no throttle.
+      # @option arguments [Number|string] :slices The number of slices this task should be divided into. Defaults to 1, meaning the task isn't sliced into subtasks. Can be set to `auto`.
+      # @option arguments [Hash] :headers Custom HTTP headers
+      # @option arguments [Hash] :body The search definition using the Query DSL
+      #
+      # *Deprecation notice*:
+      # Specifying types in urls has been deprecated
+      # Deprecated since version 7.0.0
+      #
+      #
+      #
+      def update_by_query(arguments = {})
+        raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
+
+        headers = arguments.delete(:headers) || {}
+
+        arguments = arguments.clone
+
+        _index = arguments.delete(:index)
+
+        method = OpenSearch::API::HTTP_POST
+        path   = "#{Utils.__listify(_index)}/_update_by_query"
+        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+
+        body = arguments[:body]
+        perform_request(method, path, params, body, headers).body
+      end
+
+      # Register this action with its valid params when the module is loaded.
+      #
+      # @since 6.2.0
+      ParamsRegistry.register(:update_by_query, %i[
+        analyzer
+        analyze_wildcard
+        default_operator
+        df
+        from
+        ignore_unavailable
+        allow_no_indices
+        conflicts
+        expand_wildcards
+        lenient
+        pipeline
+        preference
+        q
+        routing
+        scroll
+        search_type
+        search_timeout
+        size
+        max_docs
+        sort
+        _source
+        _source_excludes
+        _source_includes
+        terminate_after
+        stats
+        version
+        version_type
+        request_cache
+        refresh
+        timeout
+        wait_for_active_shards
+        scroll_size
+        wait_for_completion
+        requests_per_second
+        slices
+      ].freeze)
+    end
+  end
+end

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

@@ -0,0 +1,62 @@
+# 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.
+#
+# 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
+      # Changes the number of requests per second for a particular Update By Query operation.
+      #
+      # @option arguments [String] :task_id The task id to rethrottle
+      # @option arguments [Number] :requests_per_second The throttle to set on this request in floating sub-requests per second. -1 means set no throttle. (*Required*)
+      # @option arguments [Hash] :headers Custom HTTP headers
+      #
+      #
+      def update_by_query_rethrottle(arguments = {})
+        raise ArgumentError, "Required argument 'task_id' missing" unless arguments[:task_id]
+
+        headers = arguments.delete(:headers) || {}
+
+        arguments = arguments.clone
+
+        _task_id = arguments.delete(:task_id)
+
+        method = OpenSearch::API::HTTP_POST
+        path   = "_update_by_query/#{Utils.__listify(_task_id)}/_rethrottle"
+        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+
+        body = nil
+        perform_request(method, path, params, body, headers).body
+      end
+
+      # Register this action with its valid params when the module is loaded.
+      #
+      # @since 6.2.0
+      ParamsRegistry.register(:update_by_query_rethrottle, [
+        :requests_per_second
+      ].freeze)
+    end
+  end
+end

data/{spec/integration/security_enabled/validation_integration_spec.rb → lib/opensearch/api/namespace/cat.rb}

@@ -23,18 +23,25 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
-require 'spec_helper'
-require 'logger'
 
-describe 'OpenSearch validation integration with security plugin enabled' do
-  it 'Validates for OpenSearch' do
-    client = OpenSearch::Client.new(
-      host: OPENSEARCH_URL,
-      logger: Logger.new($stderr),
-      transport_options: { ssl: { verify: false } }
-    )
-    expect(client.instance_variable_get('@verified')).to be false
-    client.count
-    expect(client.instance_variable_get('@verified')).to be true
+module OpenSearch
+  module API
+    module Cat
+      module Actions; end
+
+      # Client for the "cat" namespace (includes the {Cat::Actions} methods)
+      #
+      class CatClient
+        include Cat::Actions
+        include Common::Client::Base
+        include Common::Client
+      end
+
+      # Proxy method for {CatClient}, available in the receiving object
+      #
+      def cat
+        @cat ||= CatClient.new(self)
+      end
+    end
   end
 end

data/lib/opensearch/api/namespace/cluster.rb

@@ -0,0 +1,47 @@
+# 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.
+#
+# 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 Cluster
+      module Actions; end
+
+      # Client for the "cluster" namespace (includes the {Cluster::Actions} methods)
+      #
+      class ClusterClient
+        include Cluster::Actions
+        include Common::Client::Base
+        include Common::Client
+      end
+
+      # Proxy method for {ClusterClient}, available in the receiving object
+      #
+      def cluster
+        @cluster ||= ClusterClient.new(self)
+      end
+    end
+  end
+end

data/lib/opensearch/api/namespace/common.rb

@@ -0,0 +1,72 @@
+# 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.
+#
+# 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 Common
+      module Actions; end
+
+      module Client
+        # Base client wrapper
+        #
+        module Base
+          attr_reader :client
+
+          def initialize(client)
+            @client = client
+          end
+        end
+
+        # Delegates the `perform_request` method to the wrapped client
+        #
+        def perform_request(method, path, params = {}, body = nil, headers = nil)
+          client.perform_request method, path, params, body, headers
+        end
+
+        def perform_request_simple_ignore404(method, path, params, body, headers)
+          Utils.__rescue_from_not_found do
+            perform_request(method, path, params, body, headers).status == 200
+          end
+        end
+
+        def perform_request_complex_ignore404(method, path, params, body, headers, arguments)
+          if Array(arguments[:ignore]).include?(404)
+            Utils.__rescue_from_not_found { perform_request(method, path, params, body, headers).body }
+          else
+            perform_request(method, path, params, body, headers).body
+          end
+        end
+
+        def perform_request_ping(method, path, params, body, headers)
+          perform_request(method, path, params, body, headers).status == 200
+        rescue StandardError => e
+          raise e unless e.class.to_s =~ /NotFound|ConnectionFailed/ || e.message =~ /Not\s*Found|404|ConnectionFailed/i
+          false
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/namespace/dangling_indices.rb

@@ -0,0 +1,47 @@
+# 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.
+#
+# 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 DanglingIndices
+      module Actions; end
+
+      # Client for the "dangling_indices" namespace (includes the {DanglingIndices::Actions} methods)
+      #
+      class DanglingIndicesClient
+        include DanglingIndices::Actions
+        include Common::Client::Base
+        include Common::Client
+      end
+
+      # Proxy method for {DanglingIndicesClient}, available in the receiving object
+      #
+      def dangling_indices
+        @dangling_indices ||= DanglingIndicesClient.new(self)
+      end
+    end
+  end
+end

data/lib/opensearch/api/namespace/features.rb

@@ -0,0 +1,47 @@
+# 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.
+#
+# 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 Features
+      module Actions; end
+
+      # Client for the "features" namespace (includes the {Features::Actions} methods)
+      #
+      class FeaturesClient
+        include Features::Actions
+        include Common::Client::Base
+        include Common::Client
+      end
+
+      # Proxy method for {FeaturesClient}, available in the receiving object
+      #
+      def features
+        @features ||= FeaturesClient.new(self)
+      end
+    end
+  end
+end

data/lib/opensearch/api/namespace/http.rb

@@ -0,0 +1,30 @@
+# 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 code was generated from OpenSearch API Spec.
+# Update the code generation logic instead of modifying this file directly.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Http
+      module Actions; end
+
+      # Client for the "http" namespace (includes the Http::Actions methods)
+      class HttpClient
+        include Http::Actions
+        include Common::Client
+        include Common::Client::Base
+      end
+
+      # Proxy method for HttpClient, available in the receiving object
+      def http
+        @http ||= HttpClient.new(self)
+      end
+    end
+  end
+end

data/lib/opensearch/api/namespace/indices.rb

@@ -0,0 +1,47 @@
+# 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.
+#
+# 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 Indices
+      module Actions; end
+
+      # Client for the "indices" namespace (includes the {Indices::Actions} methods)
+      #
+      class IndicesClient
+        include Indices::Actions
+        include Common::Client::Base
+        include Common::Client
+      end
+
+      # Proxy method for {IndicesClient}, available in the receiving object
+      #
+      def indices
+        @indices ||= IndicesClient.new(self)
+      end
+    end
+  end
+end

data/lib/opensearch/api/namespace/ingest.rb

@@ -0,0 +1,47 @@
+# 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.
+#
+# 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 Ingest
+      module Actions; end
+
+      # Client for the "ingest" namespace (includes the {Ingest::Actions} methods)
+      #
+      class IngestClient
+        include Ingest::Actions
+        include Common::Client::Base
+        include Common::Client
+      end
+
+      # Proxy method for {IngestClient}, available in the receiving object
+      #
+      def ingest
+        @ingest ||= IngestClient.new(self)
+      end
+    end
+  end
+end

data/lib/opensearch/api/namespace/nodes.rb

@@ -0,0 +1,47 @@
+# 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.
+#
+# 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 Nodes
+      module Actions; end
+
+      # Client for the "nodes" namespace (includes the {Nodes::Actions} methods)
+      #
+      class NodesClient
+        include Nodes::Actions
+        include Common::Client::Base
+        include Common::Client
+      end
+
+      # Proxy method for {NodesClient}, available in the receiving object
+      #
+      def nodes
+        @nodes ||= NodesClient.new(self)
+      end
+    end
+  end
+end

data/lib/opensearch/api/namespace/remote.rb

@@ -0,0 +1,47 @@
+# 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.
+#
+# 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 Remote
+      module Actions; end
+
+      # Client for the "remote" namespace (includes the {Remote::Actions} methods)
+      #
+      class RemoteClient
+        include Remote::Actions
+        include Common::Client::Base
+        include Common::Client
+      end
+
+      # Proxy method for {RemoteClient}, available in the receiving object
+      #
+      def remote
+        @remote ||= RemoteClient.new(self)
+      end
+    end
+  end
+end