[API] Adds indices.disk_usage

Author: picandocodigo

elasticsearch-api/lib/elasticsearch/api/actions/indices/disk_usage.rb

@@ -0,0 +1,68 @@
+# 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
+        # Analyzes the disk usage of each field of an index or data stream
+        # 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] :index Comma-separated list of indices or data streams to analyze the disk usage
+        # @option arguments [Boolean] :run_expensive_tasks Must be set to [true] in order for the task to be performed. Defaults to false.
+        # @option arguments [Boolean] :flush Whether flush or not before analyzing the index disk usage. Defaults to true
+        # @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.14/indices-disk-usage.html
+        #
+        def disk_usage(arguments = {})
+          raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
+
+          headers = arguments.delete(:headers) || {}
+
+          arguments = arguments.clone
+
+          _index = arguments.delete(:index)
+
+          method = Elasticsearch::API::HTTP_POST
+          path   = "#{Utils.__listify(_index)}/_disk_usage"
+          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(:disk_usage, [
+          :run_expensive_tasks,
+          :flush,
+          :ignore_unavailable,
+          :allow_no_indices,
+          :expand_wildcards
+        ].freeze)
+      end
+    end
+  end
+end

elasticsearch-api/spec/elasticsearch/api/actions/indices/disk_usage_spec.rb

@@ -0,0 +1,48 @@
+# 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.
+
+require 'spec_helper'
+
+describe 'client.indices#disk_usage' do
+  let(:expected_args) do
+    [
+      'POST',
+      "#{index}/_disk_usage",
+      {},
+      nil,
+      {}
+    ]
+  end
+
+  let(:index) { 'foo' }
+
+  it 'performs the request' do
+    expect(client_double.indices.disk_usage(index: index)).to eq({})
+  end
+
+  context 'when there is no index specified' do
+    let(:client) do
+      Class.new { include Elasticsearch::API }.new
+    end
+
+    it 'raises an exception' do
+      expect do
+        client.indices.disk_usage
+      end.to raise_exception(ArgumentError)
+    end
+  end
+end

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/sql/clear_cursor.rb

@@ -25,7 +25,7 @@ module Actions
           # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body Specify the cursor value in the `cursor` element to clean the cursor. (*Required*)
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.14/sql-pagination.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.14/clear-sql-cursor-api.html
           #
           def clear_cursor(arguments = {})
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/sql/query.rb

@@ -26,7 +26,7 @@ module Actions
           # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body Use the `query` element to start a query. Use the `cursor` element to continue a query. (*Required*)
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.14/sql-rest-overview.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.14/sql-search-api.html
           #
           def query(arguments = {})
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/sql/translate.rb

@@ -25,7 +25,7 @@ module Actions
           # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body Specify the query in the `query` element. (*Required*)
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.14/sql-translate.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.14/sql-translate-api.html
           #
           def translate(arguments = {})
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]