elasticsearch-api 7.2.0 → 8.0.0

data/lib/elasticsearch/api/actions/index_lifecycle_management/move_to_step.rb

@@ -0,0 +1,52 @@
+# 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 Elasticsearch
+  module API
+    module IndexLifecycleManagement
+      module Actions
+        # Manually moves an index into the specified step and executes that step.
+        #
+        # @option arguments [String] :index The name of the index whose lifecycle step is to change
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body The new lifecycle step to move to
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-move-to-step.html
+        #
+        def move_to_step(arguments = {})
+          raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
+
+          headers = arguments.delete(:headers) || {}
+
+          body = arguments.delete(:body)
+
+          arguments = arguments.clone
+
+          _index = arguments.delete(:index)
+
+          method = Elasticsearch::API::HTTP_POST
+          path   = "_ilm/move/#{Utils.__listify(_index)}"
+          params = {}
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/index_lifecycle_management/put_lifecycle.rb

@@ -0,0 +1,52 @@
+# 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 Elasticsearch
+  module API
+    module IndexLifecycleManagement
+      module Actions
+        # Creates a lifecycle policy
+        #
+        # @option arguments [String] :policy The name of the index lifecycle policy
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body The lifecycle policy definition to register
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-put-lifecycle.html
+        #
+        def put_lifecycle(arguments = {})
+          raise ArgumentError, "Required argument 'policy' missing" unless arguments[:policy]
+
+          headers = arguments.delete(:headers) || {}
+
+          body = arguments.delete(:body)
+
+          arguments = arguments.clone
+
+          _policy = arguments.delete(:policy)
+
+          method = Elasticsearch::API::HTTP_PUT
+          path   = "_ilm/policy/#{Utils.__listify(_policy)}"
+          params = {}
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/index_lifecycle_management/remove_policy.rb

@@ -0,0 +1,51 @@
+# 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 Elasticsearch
+  module API
+    module IndexLifecycleManagement
+      module Actions
+        # Removes the assigned lifecycle policy and stops managing the specified index
+        #
+        # @option arguments [String] :index The name of the index to remove policy on
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-remove-policy.html
+        #
+        def remove_policy(arguments = {})
+          raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
+
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          arguments = arguments.clone
+
+          _index = arguments.delete(:index)
+
+          method = Elasticsearch::API::HTTP_POST
+          path   = "#{Utils.__listify(_index)}/_ilm/remove"
+          params = {}
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/index_lifecycle_management/retry.rb

@@ -0,0 +1,51 @@
+# 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 Elasticsearch
+  module API
+    module IndexLifecycleManagement
+      module Actions
+        # Retries executing the policy for an index that is in the ERROR step.
+        #
+        # @option arguments [String] :index The name of the indices (comma-separated) whose failed lifecycle step is to be retry
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-retry-policy.html
+        #
+        def retry(arguments = {})
+          raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
+
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          arguments = arguments.clone
+
+          _index = arguments.delete(:index)
+
+          method = Elasticsearch::API::HTTP_POST
+          path   = "#{Utils.__listify(_index)}/_ilm/retry"
+          params = {}
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/index_lifecycle_management/start.rb

@@ -0,0 +1,46 @@
+# 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 Elasticsearch
+  module API
+    module IndexLifecycleManagement
+      module Actions
+        # Start the index lifecycle management (ILM) plugin.
+        #
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-start.html
+        #
+        def start(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          arguments = arguments.clone
+
+          method = Elasticsearch::API::HTTP_POST
+          path   = "_ilm/start"
+          params = {}
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/index_lifecycle_management/stop.rb

@@ -0,0 +1,46 @@
+# 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 Elasticsearch
+  module API
+    module IndexLifecycleManagement
+      module Actions
+        # Halts all lifecycle management operations and stops the index lifecycle management (ILM) plugin
+        #
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-stop.html
+        #
+        def stop(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          arguments = arguments.clone
+
+          method = Elasticsearch::API::HTTP_POST
+          path   = "_ilm/stop"
+          params = {}
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/indices/add_block.rb

@@ -0,0 +1,60 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module Elasticsearch
+  module API
+    module Indices
+      module Actions
+        # Adds a block to an index.
+        #
+        # @option arguments [List] :index A comma separated list of indices to add a block to
+        # @option arguments [String] :block The block to add (one of read, write, read_only or metadata)
+        # @option arguments [Time] :timeout Explicit operation timeout
+        # @option arguments [Time] :master_timeout Specify timeout for connection to master
+        # @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] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/index-modules-blocks.html
+        #
+        def add_block(arguments = {})
+          raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
+          raise ArgumentError, "Required argument 'block' missing" unless arguments[:block]
+
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          arguments = arguments.clone
+
+          _index = arguments.delete(:index)
+
+          _block = arguments.delete(:block)
+
+          method = Elasticsearch::API::HTTP_PUT
+          path   = "#{Utils.__listify(_index)}/_block/#{Utils.__listify(_block)}"
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/indices/analyze.rb

@@ -6,7 +6,7 @@
 # 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
+#   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
@@ -19,67 +19,40 @@ module Elasticsearch
   module API
     module Indices
       module Actions
-
-        # Return the result of the analysis process (tokens)
-        #
-        # Allows to "test-drive" the Elasticsearch analysis process by performing the analysis on the
-        # same text with different analyzers. An ad-hoc analysis chain can be built from specific
-        # _tokenizer_ and _filters_.
-        #
-        # @example Analyze text "Quick Brown Jumping Fox" with the _snowball_ analyzer
-        #
-        #     client.indices.analyze text: 'The Quick Brown Jumping Fox', analyzer: 'snowball'
-        #
-        # @example Analyze text "Quick Brown Jumping Fox" with a custom tokenizer and filter chain
-        #
-        #     client.indices.analyze body: { text: 'The Quick Brown Jumping Fox',
-        #                                    tokenizer: 'whitespace',
-        #                                    filter: ['lowercase','stop'] }
-        #
-        # @note If your text for analysis is longer than 4096 bytes then you should use the :body argument, rather than :text, to avoid HTTP transport errors
-        #
-        # @example Analyze text "Quick <b>Brown</b> Jumping Fox" with custom tokenizer, token and character filters
+        # Performs the analysis process on a text and return the tokens breakdown of the text.
         #
-        # client.indices.analyze body: { text: 'The Quick <b>Brown</b> Jumping Fox',
-        #                                tokenizer: 'standard',
-        #                                char_filter: ['html_strip'] }
-        #
-        # @option arguments [String] :index The name of the index to scope the operation
-        # @option arguments [String] :body The text on which the analysis should be performed
-        # @option arguments [String] :analyzer The name of the analyzer to use
-        # @option arguments [String] :field Use the analyzer configured for this field
-        #                                   (instead of passing the analyzer name)
-        # @option arguments [List] :filters A comma-separated list of token filters to use for the analysis.
-        #                                   (Also available as the `:token_filters` option)
-        # @option arguments [List] :char_filters A comma-separated list of char filters to use for the analysis
-        # @option arguments [Boolean] :explain Whether to output further details (default: false)
-        # @option arguments [List] :attributes A comma-separated list of token attributes to output (use with `:explain`)
         # @option arguments [String] :index The name of the index to scope the operation
-        # @option arguments [Boolean] :prefer_local With `true`, specify that a local shard should be used if available,
-        #                                           with `false`, use a random shard (default: true)
-        # @option arguments [String] :text The text on which the analysis should be performed
-        #                                  (when request body is not used)
-        # @option arguments [String] :tokenizer The name of the tokenizer to use for the analysis
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body Define analyzer/tokenizer parameters and the text on which the analysis should be performed
         #
-        # @see https://www.elastic.co/guide/reference/api/admin-indices-analyze/
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-analyze.html
         #
-        def analyze(arguments={})
-          method = HTTP_GET
-          path   = Utils.__pathify Utils.__listify(arguments[:index]), '_analyze'
+        def analyze(arguments = {})
+          headers = arguments.delete(:headers) || {}
 
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-          params[:filters] = Utils.__listify(params[:filters]) if params[:filters]
+          body = arguments.delete(:body)
 
-          body   = arguments[:body]
+          arguments = arguments.clone
 
-          perform_request(method, path, params, body).body
-        end
+          _index = arguments.delete(:index)
 
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.1.1
-        ParamsRegistry.register(:analyze, [
-            :index ].freeze)
+          method = if body
+                     Elasticsearch::API::HTTP_POST
+                   else
+                     Elasticsearch::API::HTTP_GET
+                   end
+
+          path   = if _index
+                     "#{Utils.__listify(_index)}/_analyze"
+                   else
+                     "_analyze"
+                   end
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
       end
     end
   end

data/lib/elasticsearch/api/actions/indices/clear_cache.rb

@@ -6,7 +6,7 @@
 # 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
+#   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
@@ -19,65 +19,41 @@ module Elasticsearch
   module API
     module Indices
       module Actions
-
-        # Clear caches and other auxiliary data structures.
-        #
-        # Can be performed against a specific index, or against all indices.
-        #
-        # By default, all caches and data structures will be cleared.
-        # Pass a specific cache or structure name to clear just a single one.
-        #
-        # @example Clear all caches and data structures
-        #
-        #     client.indices.clear_cache
-        #
-        # @example Clear the field data structure only
-        #
-        #     client.indices.clear_cache field_data: true
-        #
-        # @example Clear only specific field in the field data structure
-        #
-        #     client.indices.clear_cache field_data: true, fields: 'created_at', filter_cache: false, id_cache: false
+        # Clears all or specific caches for one or more indices.
         #
         # @option arguments [List] :index A comma-separated list of index name to limit the operation
-        # @option arguments [Boolean] :field_data Clear field data
         # @option arguments [Boolean] :fielddata Clear field data
-        # @option arguments [List] :fields A comma-separated list of fields to clear when using the `field_data` parameter (default: all)
+        # @option arguments [List] :fields A comma-separated list of fields to clear when using the `fielddata` parameter (default: all)
         # @option arguments [Boolean] :query Clear query caches
         # @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] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, none, all)
-        # @option arguments [List] :index A comma-separated list of index name to limit the operation
-        # @option arguments [Boolean] :recycler Clear the recycler cache
-        # @option arguments [Boolean] :request_cache Clear request cache
+        # @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] :request Clear request cache
+        # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-clearcache.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-clearcache.html
         #
-        def clear_cache(arguments={})
-          method = HTTP_POST
-          path   = Utils.__pathify Utils.__listify(arguments[:index]), '_cache/clear'
+        def clear_cache(arguments = {})
+          headers = arguments.delete(:headers) || {}
 
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-          body   = nil
+          body = nil
 
-          params[:fields] = Utils.__listify(params[:fields]) if params[:fields]
+          arguments = arguments.clone
 
-          perform_request(method, path, params, body).body
-        end
+          _index = arguments.delete(:index)
 
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.1.1
-        ParamsRegistry.register(:clear_cache, [
-            :fielddata,
-            :fields,
-            :query,
-            :ignore_unavailable,
-            :allow_no_indices,
-            :expand_wildcards,
-            :index,
-            :request ].freeze)
+          method = Elasticsearch::API::HTTP_POST
+          path   = if _index
+                     "#{Utils.__listify(_index)}/_cache/clear"
+                   else
+                     "_cache/clear"
+                   end
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
       end
     end
   end

data/lib/elasticsearch/api/actions/indices/clone.rb

@@ -0,0 +1,59 @@
+# 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 Elasticsearch
+  module API
+    module Indices
+      module Actions
+        # Clones an index
+        #
+        # @option arguments [String] :index The name of the source index to clone
+        # @option arguments [String] :target The name of the target index to clone into
+        # @option arguments [Time] :timeout Explicit operation timeout
+        # @option arguments [Time] :master_timeout Specify timeout for connection to master
+        # @option arguments [String] :wait_for_active_shards Set the number of active shards to wait for on the cloned index before the operation returns.
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body The configuration for the target index (`settings` and `aliases`)
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-clone-index.html
+        #
+        def clone(arguments = {})
+          raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
+          raise ArgumentError, "Required argument 'target' missing" unless arguments[:target]
+
+          headers = arguments.delete(:headers) || {}
+
+          body = arguments.delete(:body)
+
+          arguments = arguments.clone
+
+          _index = arguments.delete(:index)
+
+          _target = arguments.delete(:target)
+
+          method = Elasticsearch::API::HTTP_PUT
+          path   = "#{Utils.__listify(_index)}/_clone/#{Utils.__listify(_target)}"
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end