[API] Add indices/snapshot_index back

Author: estolfo

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

@@ -0,0 +1,44 @@
+module Elasticsearch
+  module API
+    module Indices
+      module Actions
+
+        # When using the shared storage gateway, manually trigger the snapshot operation.
+        #
+        # @deprecated The shared gateway has been deprecated [https://github.com/elasticsearch/elasticsearch/issues/2458]
+        #
+        # @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 [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)
+        # @option arguments [String] :ignore_indices When performed on multiple indices, allows to ignore
+        #                                            `missing` ones (options: none, missing) @until 1.0
+        # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when
+        #                                                 unavailable (missing, closed, etc)
+        #
+        # @see http://www.elasticsearch.org/guide/reference/api/admin-indices-gateway-snapshot/
+        #
+        def snapshot_index(arguments={})
+          method = HTTP_POST
+          path   = Utils.__pathify Utils.__listify(arguments[:index]), '_gateway/snapshot'
+          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+          body   = nil
+
+          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(:snapshot_index, [
+            :ignore_indices,
+            :ignore_unavailable,
+            :allow_no_indices,
+            :expand_wildcards ].freeze)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,89 @@
+require 'spec_helper'
+
+describe 'client.cluster#snapshot_index' do
+
+  let(:expected_args) do
+    [
+        'POST',
+        url,
+        params,
+        body,
+        nil
+    ]
+  end
+
+  let(:url) do
+    '_gateway/snapshot'
+  end
+
+  let(:body) do
+    nil
+  end
+
+  let(:params) do
+    {}
+  end
+
+  it 'performs the request' do
+    expect(client_double.indices.snapshot_index).to eq({})
+  end
+
+  context 'when an index is specified' do
+
+    let(:url) do
+      'foo/_gateway/snapshot'
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.snapshot_index(index: 'foo')).to eq({})
+    end
+  end
+
+  context 'when multiple indicies are specified as a list' do
+
+    let(:url) do
+      'foo,bar/_gateway/snapshot'
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.snapshot_index(index: ['foo', 'bar'])).to eq({})
+    end
+  end
+
+  context 'when multiple indicies are specified as a string' do
+
+    let(:url) do
+      'foo,bar/_gateway/snapshot'
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.snapshot_index(index: 'foo,bar')).to eq({})
+    end
+  end
+
+  context 'when parameters are specified' do
+
+    let(:params) do
+      { ignore_indices: 'missing' }
+    end
+
+    let(:url) do
+      'foo/_gateway/snapshot'
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.snapshot_index(index: 'foo', ignore_indices: 'missing')).to eq({})
+    end
+  end
+
+  context 'when the path needs to be URL-escaped' do
+
+    let(:url) do
+      'foo%5Ebar/_gateway/snapshot'
+    end
+
+    it 'performs the request' do
+      expect(client_double.indices.snapshot_index(index: 'foo^bar')).to eq({})
+    end
+  end
+end