elasticsearch-api 6.8.3 → 7.0.0.pre

data/lib/elasticsearch/api/actions/cluster/allocation_explain.rb

@@ -1,6 +1,19 @@
-# Licensed to Elasticsearch B.V under one or more agreements.
-# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
-# See the LICENSE file in the project root for more information
+# 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
@@ -11,9 +24,10 @@ module Elasticsearch
         #
         # @option arguments [Hash] :body The index, shard, and primary flag to explain. Empty means 'explain the first unassigned shard'
         # @option arguments [Boolean] :include_yes_decisions Return 'YES' decisions in explanation (default: false)
-        # @option arguments [Boolean] :include_disk_info Return information about disk usage and shard sizes (default: false)
+        # @option arguments [Boolean] :include_disk_info Return information about disk usage and shard sizes
+        #                                                (default: false)
         #
-        # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-allocation-explain.html
+        # @see http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-allocation-explain.html
         #
         def allocation_explain(arguments={})
           method = 'GET'
@@ -26,7 +40,7 @@ module Elasticsearch
 
         # Register this action with its valid params when the module is loaded.
         #
-        # @since 6.2.0
+        # @since 6.1.1
         ParamsRegistry.register(:allocation_explain, [
             :include_yes_decisions,
             :include_disk_info ].freeze)

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

@@ -1,6 +1,19 @@
-# Licensed to Elasticsearch B.V under one or more agreements.
-# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
-# See the LICENSE file in the project root for more information
+# 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
@@ -14,9 +27,8 @@ module Elasticsearch
         #     client.cluster.get_settings
         #
         # @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 [Time] :timeout Explicit operation timeout
-        # @option arguments [Boolean] :include_defaults Whether to return all default clusters setting.
+        # @option arguments [Boolean] :include_defaults Whether to return all default clusters setting
+        #                                               (default: false)
         #
         # @see http://elasticsearch.org/guide/reference/api/admin-cluster-update-settings/
         #
@@ -31,7 +43,7 @@ module Elasticsearch
 
         # Register this action with its valid params when the module is loaded.
         #
-        # @since 6.2.0
+        # @since 6.1.1
         ParamsRegistry.register(:get_settings, [
             :flat_settings,
             :master_timeout,

data/lib/elasticsearch/api/actions/cluster/health.rb

@@ -1,6 +1,19 @@
-# Licensed to Elasticsearch B.V under one or more agreements.
-# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
-# See the LICENSE file in the project root for more information
+# 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
@@ -17,17 +30,25 @@ module Elasticsearch
         #
         #     client.cluster.health wait_for_status: 'yellow'
         #
-        # @option arguments [List] :index Limit the information returned to a specific index
-        # @option arguments [String] :level Specify the level of detail for returned information (options: cluster, indices, shards)
-        # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
+        # @option arguments [String] :index Limit the information returned to a specific index
+        # @option arguments [String] :level Specify the level of detail for returned information
+        #                                   (options: cluster, indices, shards)
+        # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node
+        #                                    (default: false)
         # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
         # @option arguments [Time] :timeout Explicit operation timeout
-        # @option arguments [String] :wait_for_active_shards Wait until the specified number of shards is active
-        # @option arguments [String] :wait_for_nodes Wait until the specified number of nodes is available
-        # @option arguments [String] :wait_for_events Wait until all currently queued events with the given priority are processed (options: immediate, urgent, high, normal, low, languid)
-        # @option arguments [Boolean] :wait_for_no_relocating_shards Whether to wait until there are no relocating shards in the cluster
-        # @option arguments [Boolean] :wait_for_no_initializing_shards Whether to wait until there are no initializing shards in the cluster
-        # @option arguments [String] :wait_for_status Wait until cluster is in a specific state (options: green, yellow, red)
+        # @option arguments [Number] :wait_for_active_shards Wait until the specified number of shards is active
+        # @option arguments [Number] :wait_for_nodes Wait until the specified number of nodes is available
+        # @option arguments [Number] :wait_for_relocating_shards Wait until the specified number of relocating
+        #                                                        shards is finished
+        # @option arguments [Boolean] :wait_for_no_relocating_shards Whether to wait until there are no relocating
+        #                                                            shards in the cluster
+        # @option arguments [Boolean] :wait_for_no_initializing_shards Whether to wait until there are no
+        #                                                              initializing shards in the cluster
+        # @option arguments [String] :wait_for_status Wait until cluster is in a specific state
+        #                                             (options: green, yellow, red)
+        # @option arguments [List] :wait_for_events Wait until all currently queued events with the given priorty
+        #                                           are processed (immediate, urgent, high, normal, low, languid)
         #
         # @see http://elasticsearch.org/guide/reference/api/admin-cluster-health/
         #
@@ -45,8 +66,9 @@ module Elasticsearch
 
         # Register this action with its valid params when the module is loaded.
         #
-        # @since 6.2.0
+        # @since 6.1.1
         ParamsRegistry.register(:health, [
+            :expand_wildcards,
             :level,
             :local,
             :master_timeout,

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

@@ -1,6 +1,19 @@
-# Licensed to Elasticsearch B.V under one or more agreements.
-# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
-# See the LICENSE file in the project root for more information
+# 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
@@ -12,7 +25,7 @@ module Elasticsearch
 
           # 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.
@@ -23,7 +36,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
@@ -37,7 +50,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/cluster/pending_tasks.rb

@@ -1,6 +1,19 @@
-# Licensed to Elasticsearch B.V under one or more agreements.
-# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
-# See the LICENSE file in the project root for more information
+# 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
@@ -14,10 +27,11 @@ module Elasticsearch
         #
         #     client.cluster.pending_tasks
         #
-        # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
+        # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node
+        #                                    (default: false)
         # @option arguments [Time] :master_timeout Specify timeout for connection to master
         #
-        # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-pending.html
+        # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cluster-pending.html
         #
         def pending_tasks(arguments={})
           method = HTTP_GET
@@ -30,7 +44,7 @@ module Elasticsearch
 
         # Register this action with its valid params when the module is loaded.
         #
-        # @since 6.2.0
+        # @since 6.1.1
         ParamsRegistry.register(:pending_tasks, [
             :local,
             :master_timeout ].freeze)

data/lib/elasticsearch/api/actions/cluster/put_settings.rb

@@ -1,6 +1,19 @@
-# Licensed to Elasticsearch B.V under one or more agreements.
-# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
-# See the LICENSE file in the project root for more information
+# 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
@@ -13,10 +26,8 @@ module Elasticsearch
         #
         #     client.cluster.put_settings body: { transient: { 'cluster.routing.allocation.disable_allocation' => true } }
         #
-        # @option arguments [Hash] :body The settings to be updated. Can be either `transient` or `persistent` (survives cluster restart). (*Required*)
-        # @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 [Time] :timeout Explicit operation timeout
+        # @option arguments [Hash] :body The settings to be updated. Can be either `transient` or `persistent`
+        #                                (survives cluster restart).
         #
         # @see http://elasticsearch.org/guide/reference/api/admin-cluster-update-settings/
         #
@@ -31,7 +42,7 @@ module Elasticsearch
 
         # Register this action with its valid params when the module is loaded.
         #
-        # @since 6.2.0
+        # @since 6.1.1
         ParamsRegistry.register(:put_settings, [
             :flat_settings,
             :master_timeout,

data/lib/elasticsearch/api/actions/cluster/remote_info.rb

@@ -1,6 +1,19 @@
-# Licensed to Elasticsearch B.V under one or more agreements.
-# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
-# See the LICENSE file in the project root for more information
+# 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
@@ -10,7 +23,7 @@ module Elasticsearch
         # Returns the configured remote cluster information
         #
         #
-        # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-remote-info.html
+        # @see http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-remote-info.html
         #
         def remote_info(arguments={})
           method = Elasticsearch::API::HTTP_GET
@@ -20,12 +33,6 @@ module Elasticsearch
 
           perform_request(method, path, params, body).body
         end
-
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.2.0
-        ParamsRegistry.register(:remote_info, [
-        ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/cluster/reroute.rb

@@ -1,6 +1,19 @@
-# Licensed to Elasticsearch B.V under one or more agreements.
-# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
-# See the LICENSE file in the project root for more information
+# 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
@@ -25,13 +38,13 @@ module Elasticsearch
         #
         # @option arguments [Hash] :body The definition of `commands` to perform (`move`, `cancel`, `allocate`)
         # @option arguments [Boolean] :dry_run Simulate the operation only and return the resulting state
-        # @option arguments [Boolean] :explain Return an explanation of why the commands can or cannot be executed
+        # @option arguments [Boolean] :explain Return an explanation for why the commands can or cannot be executed
+        # @option arguments [Boolean] :metric Limit the information returned to the specified metrics.
+        #                                     Defaults to all but metadata. (Options: _all, blocks, metadata,
+        #                                     nodes, routing_table, master_node, version)
+        # @option arguments [Time] :master_timeout Specify timeout for connection to master
         # @option arguments [Boolean] :retry_failed Retries allocation of shards that are blocked due to too many
-        #   subsequent allocation failures
-        # @option arguments [List] :metric Limit the information returned to the specified metrics. Defaults to all
-        #   but metadata (options: _all, blocks, metadata, nodes, routing_table, master_node, version)
-        # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
-        # @option arguments [Time] :timeout Explicit operation timeout
+        #                                           subsequent allocation failures
         #
         # @see http://elasticsearch.org/guide/reference/api/admin-cluster-reroute/
         #
@@ -47,7 +60,7 @@ module Elasticsearch
 
         # Register this action with its valid params when the module is loaded.
         #
-        # @since 6.2.0
+        # @since 6.1.1
         ParamsRegistry.register(:reroute, [
             :dry_run,
             :explain,

data/lib/elasticsearch/api/actions/cluster/state.rb

@@ -1,6 +1,19 @@
-# Licensed to Elasticsearch B.V under one or more agreements.
-# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
-# See the LICENSE file in the project root for more information
+# 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
@@ -13,24 +26,21 @@ module Elasticsearch
         #
         #     client.cluster.state
         #
-        # @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] :index A comma-separated list of index names; use `_all` or omit to
+        #                                 perform the operation on all indices
         # @option arguments [List] :metric Limit the information returned to the specified metrics
-        #   (options: _all,blocks,metadata,nodes,routing_table,routing_nodes,master_node,version)
+        #                                 (options: _all, blocks, index_templates, metadata, nodes, routing_table,
+        #                                  master_node, version)
+        # @option arguments [List] :index_templates A comma separated list to return specific index templates when
+        #                                           returning metadata
         # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node
-        #   (default: false)
+        #                                    (default: false)
         # @option arguments [Time] :master_timeout Specify timeout for connection to master
-        # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false)
-        # @option arguments [Number] :wait_for_metadata_version Wait for the metadata version to be equal or greater
-        #   than the specified metadata version
-        # @option arguments [Time] :wait_for_timeout The maximum time to wait for wait_for_metadata_version before
-        #   timing out
+        # @option arguments [String] :expand_wildcards Whether to expand wildcard expression for inidices
+        #                                              (options: open, 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 [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)
+        #                                                 unavailable (missing, closed, etc)
         #
         # @see http://elasticsearch.org/guide/reference/api/admin-cluster-state/
         #
@@ -56,7 +66,7 @@ module Elasticsearch
 
         # Register this action with its valid params when the module is loaded.
         #
-        # @since 6.2.0
+        # @since 6.1.1
         ParamsRegistry.register(:state, [
             :local,
             :master_timeout,