elasticsearch-api 6.8.0 → 7.10.0

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

@@ -1,62 +1,76 @@
+# 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
-
-        # Return the settings for all indices, or a list of indices.
-        #
-        # @example Get settings for all indices
-        #
-        #     client.indices.get_settings
-        #
-        # @example Get settings for the 'foo' index
-        #
-        #     client.indices.get_settings index: 'foo'
-        #
-        # @example Get settings for indices beginning with foo
-        #
-        #     client.indices.get_settings prefix: 'foo'
-        #
-        # @example Get settings for an index named _myindex_
-        #
-        #     client.indices.get_settings index: 'myindex'
+        # Returns settings for one or more 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, none, all)
+        # @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 [Hash] :headers Custom HTTP headers
         #
-        # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-settings.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/indices-get-settings.html
         #
-        def get_settings(arguments={})
-          method = HTTP_GET
-          path   = Utils.__pathify Utils.__listify(arguments[:index]),
-                                   Utils.__listify(arguments[:type]),
-                                   arguments.delete(:prefix),
-                                   '_settings',
-                                   Utils.__escape(arguments[:name])
+        def get_settings(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
+          arguments = arguments.clone
+
+          _index = arguments.delete(:index)
+
+          _name = arguments.delete(:name)
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = if _index && _name
+                     "#{Utils.__listify(_index)}/_settings/#{Utils.__listify(_name)}"
+                   elsif _index
+                     "#{Utils.__listify(_index)}/_settings"
+                   elsif _name
+                     "_settings/#{Utils.__listify(_name)}"
+                   else
+                     "_settings"
+                   end
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-          body   = nil
 
-          perform_request(method, path, params, body).body
+          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(:get_settings, [
-            :master_timeout,
-            :ignore_unavailable,
-            :allow_no_indices,
-            :expand_wildcards,
-            :flat_settings,
-            :local,
-            :include_defaults ].freeze)
+          :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

@@ -1,45 +1,63 @@
+# 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
-
-        # Get a single index template.
-        #
-        # @example Get all templates
-        #
-        #     client.indices.get_template
-        #
-        # @example Get a template named _mytemplate_
-        #
-        #     client.indices.get_template name: 'mytemplate'
-        #
-        # @note Use the {Cluster::Actions#state} API to get a list of all templates.
+        # Returns an index template.
         #
         # @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 [Hash] :headers Custom HTTP headers
         #
-        # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-templates.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/indices-templates.html
         #
-        def get_template(arguments={})
-          method = HTTP_GET
-          path   = Utils.__pathify '_template', Utils.__escape(arguments[:name])
+        def get_template(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
+          arguments = arguments.clone
+
+          _name = arguments.delete(:name)
 
+          method = Elasticsearch::API::HTTP_GET
+          path   = if _name
+                     "_template/#{Utils.__listify(_name)}"
+                   else
+                     "_template"
+                   end
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-          body   = arguments[:body]
 
-          perform_request(method, path, params, body).body
+          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(:get_template, [
-            :flat_settings,
-            :master_timeout,
-            :local,
-            :include_type_name ].freeze)
+          :include_type_name,
+          :flat_settings,
+          :master_timeout,
+          :local
+        ].freeze)
       end
     end
   end

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

@@ -0,0 +1,62 @@
+# 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
+        # The _upgrade API is no longer useful and will be removed.
+        #
+        # @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 [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/7.10/indices-upgrade.html
+        #
+        def get_upgrade(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
+          arguments = arguments.clone
+
+          _index = arguments.delete(:index)
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = if _index
+                     "#{Utils.__listify(_index)}/_upgrade"
+                   else
+                     "_upgrade"
+                   end
+          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(:get_upgrade, [
+          :ignore_unavailable,
+          :allow_no_indices,
+          :expand_wildcards
+        ].freeze)
+      end
+    end
+  end
+end

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

@@ -1,45 +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.
+
 module Elasticsearch
   module API
     module Indices
       module Actions
-
-        # Open a previously closed index (see the {Indices::Actions#close} API).
-        #
-        # @example Open index named _myindex_
+        # Opens an index.
         #
-        #     client.indices.open index: 'myindex'
-        #
-        # @option arguments [List] :index A comma separated list of indices to open (*Required*)
+        # @option arguments [List] :index A comma separated list of indices to open
         # @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, none, all)
+        # @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 [String] :wait_for_active_shards Sets the number of active shards to wait for before the operation returns.
+        # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-open-close.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/indices-open-close.html
         #
-        def open(arguments={})
+        def open(arguments = {})
           raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
-          method = HTTP_POST
-          path   = Utils.__pathify Utils.__escape(arguments[:index]), '_open'
 
+          headers = arguments.delete(:headers) || {}
+
+          arguments = arguments.clone
+
+          _index = arguments.delete(:index)
+
+          method = Elasticsearch::API::HTTP_POST
+          path   = "#{Utils.__listify(_index)}/_open"
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-          body = nil
 
-          perform_request(method, path, params, body).body
+          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(:open, [
-            :timeout,
-            :master_timeout,
-            :ignore_unavailable,
-            :allow_no_indices,
-            :expand_wildcards,
-            :wait_for_active_shards ].freeze)
+          :timeout,
+          :master_timeout,
+          :ignore_unavailable,
+          :allow_no_indices,
+          :expand_wildcards,
+          :wait_for_active_shards
+        ].freeze)
       end
     end
   end

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

@@ -1,14 +1,30 @@
+# 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
         module ParamsRegistry
-
           extend self
 
           # A Mapping of all the actions to their list of valid params.
           #
-          # @since 6.2.0
+          # @since 6.1.1
           PARAMS = {}
 
           # Register an action with its list of valid params.
@@ -19,7 +35,7 @@ module Elasticsearch
           # @param [ Symbol ] action The action to register.
           # @param [ Array[Symbol] ] valid_params The list of valid params.
           #
-          # @since 6.2.0
+          # @since 6.1.1
           def register(action, valid_params)
             PARAMS[action.to_sym] = valid_params
           end
@@ -33,7 +49,7 @@ module Elasticsearch
           #
           # @return [ Array<Symbol> ] The list of valid params for the action.
           #
-          # @since 6.2.0
+          # @since 6.1.1
           def get(action)
             PARAMS.fetch(action, [])
           end

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

@@ -1,47 +1,64 @@
+# 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
-
-        # Create or update a single index alias.
-        #
-        # @example Create an alias for current month
-        #
-        #     client.indices.put_alias index: 'logs-2013-06', name: 'current-month'
-        #
-        # @example Create an alias for multiple indices
-        #
-        #     client.indices.put_alias index: 'logs-2013-06', name: 'year-2013'
-        #     client.indices.put_alias index: 'logs-2013-05', name: 'year-2013'
-        #
-        # See the {Indices::Actions#update_aliases} for performing operations with index aliases in bulk.
+        # Creates or updates an alias.
         #
-        # @option arguments [List] :index A comma-separated list of index names the alias should point to (supports wildcards); use `_all` to perform the operation on all indices. (*Required*)
-        # @option arguments [String] :name The name of the alias to be created or updated (*Required*)
-        # @option arguments [Hash] :body The settings for the alias, such as `routing` or `filter`
+        # @option arguments [List] :index A comma-separated list of index names the alias should point to (supports wildcards); use `_all` to perform the operation on all indices.
+        # @option arguments [String] :name The name of the alias to be created or updated
         # @option arguments [Time] :timeout Explicit timestamp for the document
         # @option arguments [Time] :master_timeout Specify timeout for connection to master
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body The settings for the alias, such as `routing` or `filter`
         #
-        # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-aliases.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/indices-aliases.html
         #
-        def put_alias(arguments={})
-          raise ArgumentError, "Required argument 'index' missing"  unless arguments[:index]
-          raise ArgumentError, "Required argument 'name' missing"  unless arguments[:name]
-          method = HTTP_PUT
-          path   = Utils.__pathify Utils.__listify(arguments[:index]), '_alias', Utils.__escape(arguments[:name])
+        def put_alias(arguments = {})
+          raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
+          raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
+
+          headers = arguments.delete(:headers) || {}
+
+          arguments = arguments.clone
+
+          _index = arguments.delete(:index)
+
+          _name = arguments.delete(:name)
 
+          method = Elasticsearch::API::HTTP_PUT
+          path   = if _index && _name
+                     "#{Utils.__listify(_index)}/_aliases/#{Utils.__listify(_name)}"
+                   end
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-          body   = arguments[:body]
 
-          perform_request(method, path, params, body).body
+          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(:put_alias, [
-            :timeout,
-            :master_timeout ].freeze)
+          :timeout,
+          :master_timeout
+        ].freeze)
       end
     end
   end

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

@@ -0,0 +1,66 @@
+# 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
+        # Creates or updates an index template.
+        # 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] :name The name of the template
+        # @option arguments [Boolean] :create Whether the index template should only be added if new or can also replace an existing one
+        # @option arguments [String] :cause User defined reason for creating/updating the index template
+        # @option arguments [Time] :master_timeout Specify timeout for connection to master
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body The template definition (*Required*)
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.10/indices-templates.html
+        #
+        def put_index_template(arguments = {})
+          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+          raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
+
+          headers = arguments.delete(:headers) || {}
+
+          arguments = arguments.clone
+
+          _name = arguments.delete(:name)
+
+          method = Elasticsearch::API::HTTP_PUT
+          path   = "_index_template/#{Utils.__listify(_name)}"
+          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(:put_index_template, [
+          :create,
+          :cause,
+          :master_timeout
+        ].freeze)
+      end
+    end
+  end
+end