lib/elasticsearch/api/actions/cat/nodes.rb in elasticsearch-api-6.8.3 vs lib/elasticsearch/api/actions/cat/nodes.rb in elasticsearch-api-7.0.0.pre
- old
+ new
@@ -1,8 +1,21 @@
-# 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
module Cat
module Actions
@@ -27,20 +40,21 @@
#
# @example Return the information as Ruby objects
#
# client.cat.nodes format: 'json'
#
- # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
# @option arguments [Boolean] :full_id Return the full node ID instead of the shortened version (default: false)
- # @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 [List] :h Comma-separated list of column names to display
- # @option arguments [Boolean] :help Return help information
+ # @option arguments [List] :h Comma-separated list of column names to display -- see the `help` argument
+ # @option arguments [Boolean] :v Display column headers as part of the output
# @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
- # @option arguments [Boolean] :v Verbose mode. Display column headers
+ # @option arguments [String] :format The output format. Options: 'text', 'json'; default: 'text'
+ # @option arguments [Boolean] :help Return information about headers
+ # @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
#
- # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cat-nodes.html
+ # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-nodes.html
#
def nodes(arguments={})
method = HTTP_GET
path = "_cat/nodes"
@@ -52,10 +66,10 @@
perform_request(method, path, params, body).body
end
# Register this action with its valid params when the module is loaded.
#
- # @since 6.2.0
+ # @since 6.1.1
ParamsRegistry.register(:nodes, [
:format,
:full_id,
:local,
:master_timeout,