elasticsearch-api 7.17.11 → 9.0.2

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

@@ -14,66 +14,61 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
-
+#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Indices
       module Actions
-        # Returns mappings for one or more indices.
+        # Get mapping definitions.
+        # For data streams, the API retrieves mappings for the stream’s backing indices.
         #
-        # @option arguments [List] :index A comma-separated list of index names
-        # @option arguments [List] :type A comma-separated list of document types *Deprecated*
-        # @option arguments [Boolean] :include_type_name Whether to add the type name to the response (default: false)
-        # @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 [Time] :master_timeout Specify timeout for connection to master
-        # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) *Deprecated*
+        # @option arguments [String, Array] :index Comma-separated list of data streams, indices, and aliases used to limit the request.
+        #  Supports wildcards (+*+).
+        #  To target all data streams and indices, omit this parameter or use +*+ or +_all+.
+        # @option arguments [Boolean] :allow_no_indices If +false+, the request returns an error if any wildcard expression, index alias, or +_all+ value targets only missing or closed indices.
+        #  This behavior applies even if the request targets other open indices. Server default: true.
+        # @option arguments [String, Array<String>] :expand_wildcards Type of index that wildcard patterns can match.
+        #  If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
+        #  Supports comma-separated values, such as +open,hidden+.
+        #  Valid values are: +all+, +open+, +closed+, +hidden+, +none+. Server default: open.
+        # @option arguments [Boolean] :ignore_unavailable If +false+, the request returns an error if it targets a missing or closed index.
+        # @option arguments [Boolean] :local If +true+, the request retrieves information from the local node only.
+        # @option arguments [Time] :master_timeout Period to wait for a connection to the master node.
+        #  If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # *Deprecation notice*:
-        # Specifying types in urls has been deprecated
-        # Deprecated since version 7.0.0
-        #
-        #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/indices-get-mapping.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-get-mapping
         #
         def get_mapping(arguments = {})
-          headers = arguments.delete(:headers) || {}
+          request_opts = { endpoint: arguments[:endpoint] || 'indices.get_mapping' }
+
+          defined_params = [:index].each_with_object({}) do |variable, set_variables|
+            set_variables[variable] = arguments[variable] if arguments.key?(variable)
+          end
+          request_opts[:defined_params] = defined_params unless defined_params.empty?
 
           arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
 
-          _index = arguments.delete(:index)
+          body = nil
 
-          _type = arguments.delete(:type)
+          _index = arguments.delete(:index)
 
           method = Elasticsearch::API::HTTP_GET
-          path   = if _index && _type
-                     "#{Utils.__listify(_index)}/_mapping/#{Utils.__listify(_type)}"
-                   elsif _index
-                     "#{Utils.__listify(_index)}/_mapping"
-                   elsif _type
-                     "_mapping/#{Utils.__listify(_type)}"
+          path   = if _index
+                     "#{Utils.listify(_index)}/_mapping"
                    else
-                     "_mapping"
+                     '_mapping'
                    end
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+          params = Utils.process_params(arguments)
 
-          body = nil
-          perform_request(method, path, params, body, headers).body
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers, request_opts)
+          )
         end
-
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.2.0
-        ParamsRegistry.register(:get_mapping, [
-          :include_type_name,
-          :ignore_unavailable,
-          :allow_no_indices,
-          :expand_wildcards,
-          :master_timeout,
-          :local
-        ].freeze)
       end
     end
   end

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

@@ -0,0 +1,65 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
+module Elasticsearch
+  module API
+    module Indices
+      module Actions
+        # Get the migration reindexing status.
+        # Get the status of a migration reindex attempt for a data stream or index.
+        # This functionality is Experimental and may be changed or removed
+        # completely in a future release. Elastic will take a best effort approach
+        # to fix any issues, but experimental features are not subject to the
+        # support SLA of official GA features.
+        #
+        # @option arguments [String, Array] :index The index or data stream name. (*Required*)
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-migration
+        #
+        def get_migrate_reindex_status(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'indices.get_migrate_reindex_status' }
+
+          defined_params = [:index].each_with_object({}) do |variable, set_variables|
+            set_variables[variable] = arguments[variable] if arguments.key?(variable)
+          end
+          request_opts[:defined_params] = defined_params unless defined_params.empty?
+
+          raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
+
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          _index = arguments.delete(:index)
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = "_migration/reindex/#{Utils.listify(_index)}/_status"
+          params = {}
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers, request_opts)
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -14,30 +14,54 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
-
+#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Indices
       module Actions
-        # Returns settings for one or more indices.
+        # Get index settings.
+        # Get setting information for one or more indices.
+        # For data streams, it returns setting information for the stream's backing indices.
         #
-        # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
-        # @option arguments [List] :name The name of the settings that should be included
-        # @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 [Boolean] :flat_settings Return settings in flat format (default: false)
-        # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
-        # @option arguments [Boolean] :include_defaults Whether to return all default setting for each of the indices.
+        # @option arguments [String, Array] :index Comma-separated list of data streams, indices, and aliases used to limit
+        #  the request. Supports wildcards (+*+). To target all data streams and
+        #  indices, omit this parameter or use +*+ or +_all+.
+        # @option arguments [String, Array<String>] :name Comma-separated list or wildcard expression of settings to retrieve.
+        # @option arguments [Boolean] :allow_no_indices If +false+, the request returns an error if any wildcard expression, index
+        #  alias, or +_all+ value targets only missing or closed indices. This
+        #  behavior applies even if the request targets other open indices. For
+        #  example, a request targeting +foo*,bar*+ returns an error if an index
+        #  starts with foo but no index starts with +bar+. Server default: true.
+        # @option arguments [String, Array<String>] :expand_wildcards Type of index that wildcard patterns can match.
+        #  If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
+        #  Supports comma-separated values, such as +open,hidden+. Server default: open.
+        # @option arguments [Boolean] :flat_settings If +true+, returns settings in flat format.
+        # @option arguments [Boolean] :ignore_unavailable If +false+, the request returns an error if it targets a missing or closed index.
+        # @option arguments [Boolean] :include_defaults If +true+, return all default settings in the response.
+        # @option arguments [Boolean] :local If +true+, the request retrieves information from the local node only. If
+        #  +false+, information is retrieved from the master node.
+        # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. If no response is
+        #  received before the timeout expires, the request fails and returns an
+        #  error. Server default: 30s.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/indices-get-settings.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-get-settings
         #
         def get_settings(arguments = {})
-          headers = arguments.delete(:headers) || {}
+          request_opts = { endpoint: arguments[:endpoint] || 'indices.get_settings' }
+
+          defined_params = [:index, :name].each_with_object({}) do |variable, set_variables|
+            set_variables[variable] = arguments[variable] if arguments.key?(variable)
+          end
+          request_opts[:defined_params] = defined_params unless defined_params.empty?
 
           arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
 
           _index = arguments.delete(:index)
 
@@ -45,32 +69,20 @@ module Elasticsearch
 
           method = Elasticsearch::API::HTTP_GET
           path   = if _index && _name
-                     "#{Utils.__listify(_index)}/_settings/#{Utils.__listify(_name)}"
+                     "#{Utils.listify(_index)}/_settings/#{Utils.listify(_name)}"
                    elsif _index
-                     "#{Utils.__listify(_index)}/_settings"
+                     "#{Utils.listify(_index)}/_settings"
                    elsif _name
-                     "_settings/#{Utils.__listify(_name)}"
+                     "_settings/#{Utils.listify(_name)}"
                    else
-                     "_settings"
+                     '_settings'
                    end
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+          params = Utils.process_params(arguments)
 
-          body = nil
-          perform_request(method, path, params, body, headers).body
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers, request_opts)
+          )
         end
-
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.2.0
-        ParamsRegistry.register(:get_settings, [
-          :master_timeout,
-          :ignore_unavailable,
-          :allow_no_indices,
-          :expand_wildcards,
-          :flat_settings,
-          :local,
-          :include_defaults
-        ].freeze)
       end
     end
   end

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

@@ -14,50 +14,56 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
-
+#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Indices
       module Actions
-        # Returns an index template.
+        # Get index templates.
+        # Get information about one or more index templates.
+        # IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8.
         #
-        # @option arguments [List] :name The comma separated names of the index templates
-        # @option arguments [Boolean] :include_type_name Whether a type should be returned in the body of the mappings.
-        # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false)
-        # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
-        # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
+        # @option arguments [String, Array<String>] :name Comma-separated list of index template names used to limit the request.
+        #  Wildcard (+*+) expressions are supported.
+        #  To return all index templates, omit this parameter or use a value of +_all+ or +*+.
+        # @option arguments [Boolean] :flat_settings If +true+, returns settings in flat format.
+        # @option arguments [Boolean] :local If +true+, the request retrieves information from the local node only.
+        # @option arguments [Time] :master_timeout Period to wait for a connection to the master node.
+        #  If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/indices-templates.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-get-template
         #
         def get_template(arguments = {})
-          headers = arguments.delete(:headers) || {}
+          request_opts = { endpoint: arguments[:endpoint] || 'indices.get_template' }
+
+          defined_params = [:name].each_with_object({}) do |variable, set_variables|
+            set_variables[variable] = arguments[variable] if arguments.key?(variable)
+          end
+          request_opts[:defined_params] = defined_params unless defined_params.empty?
 
           arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
 
           _name = arguments.delete(:name)
 
           method = Elasticsearch::API::HTTP_GET
           path   = if _name
-                     "_template/#{Utils.__listify(_name)}"
+                     "_template/#{Utils.listify(_name)}"
                    else
-                     "_template"
+                     '_template'
                    end
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+          params = Utils.process_params(arguments)
 
-          body = nil
-          perform_request(method, path, params, body, headers).body
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers, request_opts)
+          )
         end
-
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.2.0
-        ParamsRegistry.register(:get_template, [
-          :include_type_name,
-          :flat_settings,
-          :master_timeout,
-          :local
-        ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/indices/migrate_reindex.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.
+#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
+module Elasticsearch
+  module API
+    module Indices
+      module Actions
+        # Reindex legacy backing indices.
+        # Reindex all legacy backing indices for a data stream.
+        # This operation occurs in a persistent task.
+        # The persistent task ID is returned immediately and the reindexing work is completed in that task.
+        # This functionality is Experimental and may be changed or removed
+        # completely in a future release. Elastic will take a best effort approach
+        # to fix any issues, but experimental features are not subject to the
+        # support SLA of official GA features.
+        #
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body reindex
+        #
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-migrate-reindex
+        #
+        def migrate_reindex(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'indices.migrate_reindex' }
+
+          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body = arguments.delete(:body)
+
+          method = Elasticsearch::API::HTTP_POST
+          path   = '_migration/reindex'
+          params = {}
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers, request_opts)
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,72 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
+module Elasticsearch
+  module API
+    module Indices
+      module Actions
+        # Convert an index alias to a data stream.
+        # Converts an index alias to a data stream.
+        # You must have a matching index template that is data stream enabled.
+        # The alias must meet the following criteria:
+        # The alias must have a write index;
+        # All indices for the alias must have a +@timestamp+ field mapping of a +date+ or +date_nanos+ field type;
+        # The alias must not have any filters;
+        # The alias must not use custom routing.
+        # If successful, the request removes the alias and creates a data stream with the same name.
+        # The indices for the alias become hidden backing indices for the stream.
+        # The write index for the alias becomes the write index for the stream.
+        #
+        # @option arguments [String] :name Name of the index alias to convert to a data stream. (*Required*)
+        # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
+        # @option arguments [Time] :timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-migrate-to-data-stream
+        #
+        def migrate_to_data_stream(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'indices.migrate_to_data_stream' }
+
+          defined_params = [:name].each_with_object({}) do |variable, set_variables|
+            set_variables[variable] = arguments[variable] if arguments.key?(variable)
+          end
+          request_opts[:defined_params] = defined_params unless defined_params.empty?
+
+          raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
+
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          _name = arguments.delete(:name)
+
+          method = Elasticsearch::API::HTTP_POST
+          path   = "_data_stream/_migrate/#{Utils.listify(_name)}"
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers, request_opts)
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
+module Elasticsearch
+  module API
+    module Indices
+      module Actions
+        # Update data streams.
+        # Performs one or more data stream modification actions in a single atomic operation.
+        #
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body request body
+        #
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-modify-data-stream
+        #
+        def modify_data_stream(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'indices.modify_data_stream' }
+
+          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body = arguments.delete(:body)
+
+          method = Elasticsearch::API::HTTP_POST
+          path   = '_data_stream/_modify'
+          params = {}
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers, request_opts)
+          )
+        end
+      end
+    end
+  end
+end