elasticsearch-api 6.8.3 → 7.0.0.pre

data/lib/elasticsearch/api/actions/ingest/processor_grok.rb

@@ -1,7 +1,3 @@
-# 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
-
 module Elasticsearch
   module API
     module Ingest

data/lib/elasticsearch/api/actions/ingest/put_pipeline.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,7 +27,7 @@ module Elasticsearch
         # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
         # @option arguments [Time] :timeout Explicit operation timeout
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/plugins/current/ingest.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/plugins/master/ingest.html
         #
         def put_pipeline(arguments={})
           raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
@@ -30,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(:put_pipeline, [
             :master_timeout,
             :timeout ].freeze)

data/lib/elasticsearch/api/actions/ingest/simulate.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,10 +23,11 @@ module Elasticsearch
         # Execute a specific pipeline against the set of documents provided in the body of the request
         #
         # @option arguments [String] :id Pipeline ID
-        # @option arguments [Hash] :body The simulate definition (*Required*)
-        # @option arguments [Boolean] :verbose Verbose mode. Display data output for each processor in executed pipeline
+        # @option arguments [Hash] :body The pipeline definition (*Required*)
+        # @option arguments [Boolean] :verbose Verbose mode. Display data output for each processor
+        #                                                    in executed pipeline
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/plugins/current/ingest.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/simulate-pipeline-api.html
         #
         def simulate(arguments={})
           raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -27,9 +41,8 @@ module Elasticsearch
 
         # Register this action with its valid params when the module is loaded.
         #
-        # @since 6.2.0
-        ParamsRegistry.register(:simulate, [
-            :verbose ].freeze)
+        # @since 6.1.1
+        ParamsRegistry.register(:simulate, [ :verbose ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/mget.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
@@ -60,7 +73,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(:mget, [
           :stored_fields,
           :preference,

data/lib/elasticsearch/api/actions/msearch.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
@@ -38,7 +51,8 @@ module Elasticsearch
       # @option arguments [Boolean] :typed_keys Specify whether aggregation and suggester names should be prefixed by their respective types in the response
       # @option arguments [Number] :pre_filter_shard_size A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on it's rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint.
       # @option arguments [Number] :max_concurrent_shard_requests The number of concurrent shard requests each sub search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests
-      # @option arguments [Boolean] :rest_total_hits_as_int This parameter is ignored in this version. It is used in the next major version to control whether the rest response should render the total.hits as an object or a number
+      # @option arguments [Boolean] :rest_total_hits_as_int Indicates whether hits.total should be rendered as an integer or an object in the rest search response
+      # @option arguments [Boolean] :ccs_minimize_roundtrips Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution
       #
       # @see https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-multi-search.html
       #
@@ -75,17 +89,17 @@ module Elasticsearch
         perform_request(method, path, params, payload, {"Content-Type" => "application/x-ndjson"}).body
       end
 
-
       # Register this action with its valid params when the module is loaded.
       #
-      # @since 6.2.0
+      # @since 6.1.1
       ParamsRegistry.register(:msearch, [
           :search_type,
           :max_concurrent_searches,
           :typed_keys,
           :pre_filter_shard_size,
           :max_concurrent_shard_requests,
-          :rest_total_hits_as_int ].freeze)
+          :rest_total_hits_as_int,
+          :ccs_minimize_roundtrips ].freeze)
     end
   end
 end

data/lib/elasticsearch/api/actions/msearch_template.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
@@ -21,7 +34,8 @@ module Elasticsearch
       # @option arguments [String] :search_type Search operation type (options: query_then_fetch, query_and_fetch, dfs_query_then_fetch, dfs_query_and_fetch)
       # @option arguments [Boolean] :typed_keys Specify whether aggregation and suggester names should be prefixed by their respective types in the response
       # @option arguments [Number] :max_concurrent_searches Controls the maximum number of concurrent searches the multi search api will execute
-      # @option arguments [Boolean] :rest_total_hits_as_int This parameter is ignored in this version. It is used in the next major version to control whether the rest response should render the total.hits as an object or a number
+      # @option arguments [Boolean] :rest_total_hits_as_int Indicates whether hits.total should be rendered as an integer or an object in the rest search response
+      # @option arguments [Boolean] :ccs_minimize_roundtrips Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution
       #
       # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/multi-search-template.html
       #
@@ -48,12 +62,13 @@ module Elasticsearch
 
       # Register this action with its valid params when the module is loaded.
       #
-      # @since 6.2.0
+      # @since 6.1.1
       ParamsRegistry.register(:msearch_template, [
           :search_type,
           :typed_keys,
           :max_concurrent_searches,
-          :rest_total_hits_as_int ].freeze)
+          :rest_total_hits_as_int,
+          :ccs_minimize_roundtrips ].freeze)
     end
   end
 end

data/lib/elasticsearch/api/actions/mtermvectors.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
@@ -30,7 +43,7 @@ module Elasticsearch
       # @option arguments [Number] :version Explicit version number for concurrency control
       # @option arguments [String] :version_type Specific version type (options: internal, external, external_gte, force)
       #
-      # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-multi-termvectors.html
+      # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/docs-multi-termvectors.html
       #
       # @see #mget
       # @see #termvector
@@ -56,7 +69,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(:mtermvectors, [
           :ids,
           :term_statistics,

data/lib/elasticsearch/api/actions/nodes/hot_threads.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,7 +38,9 @@ module Elasticsearch
         # @option arguments [String] :type The type to sample (default: cpu) (options: cpu, wait, block)
         # @option arguments [Time] :timeout Explicit operation timeout
         #
-        # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-nodes-hot-threads.html
+        # @return [String]
+        #
+        # @see http://www.elasticsearch.org/guide/reference/api/admin-cluster-nodes-hot-threads/
         #
         def hot_threads(arguments={})
           method = HTTP_GET
@@ -39,7 +54,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(:hot_threads, [
             :interval,
             :snapshots,

data/lib/elasticsearch/api/actions/nodes/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
@@ -26,12 +39,23 @@ module Elasticsearch
         #
         #     client.nodes.info metric: ['http', 'network']
         #
-        # @option arguments [List] :node_id A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes
-        # @option arguments [List] :metric A comma-separated list of metrics you wish returned. Leave empty to return all. (options: settings,os,process,jvm,thread_pool,transport,http,plugins,ingest)
+        # @option arguments [List] :node_id A comma-separated list of node IDs or names to limit the returned information;
+        #                                   use `_local` to return information from the node you're connecting to, leave
+        #                                   empty to get information from all nodes
+        # @option arguments [Boolean] :_all Return all available information
+        # @option arguments [Boolean] :http Return information about HTTP
+        # @option arguments [Boolean] :jvm Return information about the JVM
+        # @option arguments [Boolean] :network Return information about network
+        # @option arguments [Boolean] :os Return information about the operating system
+        # @option arguments [Boolean] :plugins Return information about plugins
+        # @option arguments [Boolean] :process Return information about the Elasticsearch process
+        # @option arguments [Boolean] :settings Return information about node settings
+        # @option arguments [Boolean] :thread_pool Return information about the thread pool
+        # @option arguments [Boolean] :transport Return information about transport
         # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false)
         # @option arguments [Time] :timeout Explicit operation timeout
         #
-        # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-nodes-info.html
+        # @see http://elasticsearch.org/guide/reference/api/admin-cluster-nodes-info/
         #
         def info(arguments={})
           arguments = arguments.clone
@@ -53,14 +77,23 @@ module Elasticsearch
 
         # Register this action with its valid params when the module is loaded.
         #
-        # @since 6.2.0
+        # @since 6.1.1
         ParamsRegistry.register(:info_params, [ :flat_settings, :timeout ].freeze)
 
-        # Register this action with its valid params when the module is loaded.
+        # Register this action with its valid parts when the module is loaded.
         #
-        # @since 6.2.0
-        ParamsRegistry.register(:info, [
-            :flat_settings,
+        # @since 6.1.1
+        ParamsRegistry.register(:info_parts, [
+            :_all,
+            :http,
+            :jvm,
+            :network,
+            :os,
+            :plugins,
+            :process,
+            :settings,
+            :thread_pool,
+            :transport,
             :timeout ].freeze)
       end
     end

data/lib/elasticsearch/api/actions/nodes/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/nodes/reload_secure_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
@@ -18,10 +31,10 @@ module Elasticsearch
         #
         #     client.nodes.reload_secure_settings(node_id: 'foo,bar')
         #
-        # @option arguments [List] :node_id A comma-separated list of node IDs to span the reload/reinit call. Should stay empty because reloading usually involves all cluster nodes.
-        # @option arguments [Time] :timeout Explicit operation timeout
+        # @option arguments [ Array ] :node_id A comma-separated list of node IDs or names to perform the operation on
+        # @option arguments [ String ] :timeout Explicit operation timeout
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/6.x/secure-settings.html#reloadable-secure-settings
+        # @see http://elasticsearch.org/guide/reference/api/cluster-nodes-reload-secure-settings
         #
         def reload_secure_settings(arguments={})
           valid_params = [
@@ -35,12 +48,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(:reload_secure_settings, [
-            :timeout ].freeze)
       end
     end
   end