RubyGems - elasticsearch-api - Versions diffs - 6.8.3 → 7.0.0.pre - Mend

elasticsearch-api 6.8.3 → 7.0.0.pre

Files changed (334) hide show

data/lib/elasticsearch/api/actions/snapshot/get.rb CHANGED Viewed

@@ -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
@@ -23,11 +36,12 @@ module Elasticsearch
         #
         # @option arguments [String] :repository A repository name (*Required*)
         # @option arguments [List] :snapshot A comma-separated list of snapshot names (*Required*)
+        # @option arguments [Boolean] :ignore_unavailable Whether to ignore unavailable snapshots, defaults to
+        #   false which means a SnapshotMissingException is thrown
         # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
-        # @option arguments [Boolean] :ignore_unavailable Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown
         # @option arguments [Boolean] :verbose Whether to show verbose snapshot info or only show the basic info found in the repository index blob
         #
-        # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html
+        # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-snapshots.html
         #
         def get(arguments={})
           raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]
@@ -50,10 +64,10 @@ 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, [
-            :master_timeout,
             :ignore_unavailable,
+            :master_timeout,
             :verbose ].freeze)
       end
     end

data/lib/elasticsearch/api/actions/snapshot/get_repository.rb CHANGED Viewed

@@ -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,11 +30,14 @@ module Elasticsearch
         #
         #     client.snapshot.get_repository repository: 'my-backups'
         #
-        # @option arguments [List] :repository A comma-separated list of repository names
+        # @option arguments [List] :repository A comma-separated list of repository names. Leave blank or use `_all`
+        #                                      to get a list of repositories
         # @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 [Boolean] :local Return local information, do not retrieve the state from master node
+        #                                    (default: false)
+        # @option arguments [Number,List] :ignore The list of HTTP errors to ignore
         #
-        # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html
+        # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-snapshots.html
         #
         def get_repository(arguments={})
           repository = arguments.delete(:repository)
@@ -40,7 +56,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_repository, [
             :master_timeout,
             :local ].freeze)

data/lib/elasticsearch/api/actions/snapshot/params_registry.rb CHANGED Viewed

@@ -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/snapshot/restore.rb CHANGED Viewed

@@ -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 [Time] :master_timeout Explicit operation timeout for connection to master node
         # @option arguments [Boolean] :wait_for_completion Should this request wait until the operation has completed before returning
         #
-        # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html
+        # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-snapshots.html
         #
         def restore(arguments={})
           raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]
@@ -49,7 +62,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(:restore, [
             :master_timeout,
             :wait_for_completion ].freeze)

data/lib/elasticsearch/api/actions/snapshot/status.rb CHANGED Viewed

@@ -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
@@ -19,10 +32,12 @@ module Elasticsearch
         #
         # @option arguments [String] :repository A repository name
         # @option arguments [List] :snapshot A comma-separated list of snapshot names
+        # @option arguments [Boolean] :ignore_unavailable Whether to ignore unavailable snapshots, defaults to
+        #   false which means a SnapshotMissingException is thrown
         # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
-        # @option arguments [Boolean] :ignore_unavailable Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown
+        # @option arguments [Number,List] :ignore The list of HTTP errors to ignore
         #
-        # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html
+        # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-snapshots.html#_snapshot_status
         #
         def status(arguments={})
           repository = arguments.delete(:repository)
@@ -43,10 +58,10 @@ module Elasticsearch
         # Register this action with its valid params when the module is loaded.
         #
-        # @since 6.2.0
+        # @since 6.1.1
         ParamsRegistry.register(:status, [
-            :master_timeout,
-            :ignore_unavailable ].freeze)
+            :ignore_unavailable,
+            :master_timeout ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/snapshot/verify_repository.rb CHANGED Viewed

@@ -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,7 +26,7 @@ module Elasticsearch
         # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
         # @option arguments [Time] :timeout Explicit operation timeout
         #
-        # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html
+        # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-snapshots.html
         #
         def verify_repository(arguments={})
           raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]
@@ -28,7 +41,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(:verify_repository, [
             :master_timeout,
             :timeout ].freeze)

data/lib/elasticsearch/api/actions/tasks/cancel.rb CHANGED Viewed

@@ -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 [List] :actions A comma-separated list of actions that should be cancelled. Leave empty to cancel all.
         # @option arguments [String] :parent_task_id Cancel tasks with specified parent task id (node_id:task_number). Set to -1 to cancel all.
         #
-        # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/tasks.html
+        # @see http://www.elastic.co/guide/en/elasticsearch/reference/master/tasks-cancel.html
         #
         def cancel(arguments={})
           arguments = arguments.clone
@@ -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(:cancel, [
             :nodes,
             :actions,

data/lib/elasticsearch/api/actions/tasks/get.rb CHANGED Viewed

@@ -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,7 +26,7 @@ module Elasticsearch
         # @option arguments [Boolean] :wait_for_completion Wait for the matching tasks to complete (default: false)
         # @option arguments [Time] :timeout Explicit operation timeout
         #
-        # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/tasks.html
+        # @see http://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html
         #
         def get(arguments={})
           arguments = arguments.clone
@@ -28,7 +41,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, [
             :wait_for_completion,
             :timeout ].freeze)

data/lib/elasticsearch/api/actions/tasks/list.rb CHANGED Viewed

@@ -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,7 +30,7 @@ module Elasticsearch
         # @option arguments [String] :group_by Group tasks by nodes or parent/child relationships (options: nodes, parents, none)
         # @option arguments [Time] :timeout Explicit operation timeout
         #
-        # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/tasks.html
+        # @see http://www.elastic.co/guide/en/elasticsearch/reference/master/tasks-list.html
         #
         def list(arguments={})
           arguments = arguments.clone
@@ -33,7 +46,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(:list, [
             :nodes,
             :actions,

data/lib/elasticsearch/api/actions/tasks/params_registry.rb CHANGED Viewed

@@ -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