elasticsearch-api 7.2.0 → 8.0.0

data/lib/elasticsearch/api/actions/cluster/state.rb

@@ -6,7 +6,7 @@
 # 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
+#   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
@@ -19,63 +19,47 @@ module Elasticsearch
   module API
     module Cluster
       module Actions
-
-        # Get information about the cluster state (indices settings, allocations, etc)
-        #
-        # @example
-        #
-        #     client.cluster.state
+        # Returns a comprehensive information about the state of the cluster.
         #
-        # @option arguments [List] :index A comma-separated list of index names; use `_all` or omit to
-        #                                 perform the operation on all indices
-        # @option arguments [List] :metric Limit the information returned to the specified metrics
-        #                                 (options: _all, blocks, index_templates, metadata, nodes, routing_table,
-        #                                  master_node, version)
-        # @option arguments [List] :index_templates A comma separated list to return specific index templates when
-        #                                           returning metadata
-        # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node
-        #                                    (default: false)
+        # @option arguments [List] :metric Limit the information returned to the specified metrics (options: _all, blocks, metadata, nodes, routing_table, routing_nodes, master_node, version)
+        # @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] :local Return local information, do not retrieve the state from master node (default: false)
         # @option arguments [Time] :master_timeout Specify timeout for connection to master
-        # @option arguments [String] :expand_wildcards Whether to expand wildcard expression for inidices
-        #                                              (options: open, closed)
+        # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false)
+        # @option arguments [Number] :wait_for_metadata_version Wait for the metadata version to be equal or greater than the specified metadata version
+        # @option arguments [Time] :wait_for_timeout The maximum time to wait for wait_for_metadata_version before timing out
+        # @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 [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when
-        #                                                 unavailable (missing, closed, etc)
+        # @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 http://elasticsearch.org/guide/reference/api/admin-cluster-state/
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-state.html
         #
-        def state(arguments={})
+        def state(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
           arguments = arguments.clone
-          index     = arguments.delete(:index)
-          metric    = arguments.delete(:metric)
-          method = HTTP_GET
-          path   = Utils.__pathify '_cluster/state',
-                                   Utils.__listify(metric),
-                                   Utils.__listify(index)
 
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+          _metric = arguments.delete(:metric)
 
-          [:index_templates].each do |key|
-            params[key] = Utils.__listify(params[key]) if params[key]
-          end
+          _index = arguments.delete(:index)
 
-          body = nil
+          method = Elasticsearch::API::HTTP_GET
+          path   = if _metric && _index
+                     "_cluster/state/#{Utils.__listify(_metric)}/#{Utils.__listify(_index)}"
+                   elsif _metric
+                     "_cluster/state/#{Utils.__listify(_metric)}"
+                   else
+                     "_cluster/state"
+                   end
+          params = Utils.process_params(arguments)
 
-          perform_request(method, path, params, body).body
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
         end
-
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.1.1
-        ParamsRegistry.register(:state, [
-            :local,
-            :master_timeout,
-            :flat_settings,
-            :wait_for_metadata_version,
-            :wait_for_timeout,
-            :ignore_unavailable,
-            :allow_no_indices,
-            :expand_wildcards ].freeze)
       end
     end
   end

data/lib/elasticsearch/api/actions/cluster/stats.rb

@@ -6,7 +6,7 @@
 # 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
+#   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
@@ -19,31 +19,36 @@ module Elasticsearch
   module API
     module Cluster
       module Actions
-
-        # Returns statistical information about the cluster
+        # Returns high-level overview of cluster statistics.
         #
         # @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] :flat_settings Return settings in flat format (default: false)
-        # @option arguments [Boolean] :human Whether to return time and byte values in human-readable format.
         # @option arguments [Time] :timeout Explicit operation timeout
+        # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-stats.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-stats.html
         #
-        def stats(arguments={})
-          method = 'GET'
-          path   = "_cluster/stats"
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-          body   = nil
+        def stats(arguments = {})
+          headers = arguments.delete(:headers) || {}
 
-          perform_request(method, path, params, body).body
-        end
+          body = nil
 
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.1.1
-        ParamsRegistry.register(:stats, [
-            :flat_settings,
-            :timeout ].freeze)
+          arguments = arguments.clone
+
+          _node_id = arguments.delete(:node_id)
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = if _node_id
+                     "_cluster/stats/nodes/#{Utils.__listify(_node_id)}"
+                   else
+                     "_cluster/stats"
+                   end
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
       end
     end
   end

data/lib/elasticsearch/api/actions/count.rb

@@ -6,7 +6,7 @@
 # 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
+#   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
@@ -18,29 +18,13 @@
 module Elasticsearch
   module API
     module Actions
-
-      # Get the number of documents for the cluster, index, type, or a query.
-      #
-      # @example Get the number of all documents in the cluster
-      #
-      #     client.count
-      #
-      # @example Get the number of documents in a specified index
-      #
-      #     client.count index: 'myindex'
-      #
-      # @example Get the number of documents matching a specific query
-      #
-      #     index: 'my_index', body: { filtered: { filter: { terms: { foo: ['bar'] } } } }
-      #
+      # Returns number of documents matching a query.
       #
       # @option arguments [List] :index A comma-separated list of indices to restrict the results
-      # @option arguments [List] :type A comma-separated list of types to restrict the results
-      # @option arguments [Hash] :body A query to restrict the results specified with the Query DSL (optional)
       # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
       # @option arguments [Boolean] :ignore_throttled Whether specified concrete, expanded or aliased indices should be ignored when throttled
       # @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, none, all)
+      # @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 [Number] :min_score Include only documents with a specific `_score` value in the result
       # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random)
       # @option arguments [List] :routing A comma-separated list of specific routing values
@@ -51,37 +35,37 @@ module Elasticsearch
       # @option arguments [String] :df The field to use as default where no field prefix is given in the query string
       # @option arguments [Boolean] :lenient Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
       # @option arguments [Number] :terminate_after The maximum count for each shard, upon reaching which the query execution will terminate early
+      # @option arguments [Hash] :headers Custom HTTP headers
+      # @option arguments [Hash] :body A query to restrict the results specified with the Query DSL (optional)
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-count.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/search-count.html
       #
-      def count(arguments={})
-        method = HTTP_GET
-        path   = Utils.__pathify( Utils.__listify(arguments[:index]), Utils.__listify(arguments[:type]), '_count' )
+      def count(arguments = {})
+        headers = arguments.delete(:headers) || {}
 
-        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-        body   = arguments[:body]
+        body = arguments.delete(:body)
 
-        perform_request(method, path, params, body).body
-      end
+        arguments = arguments.clone
 
-      # Register this action with its valid params when the module is loaded.
-      #
-      # @since 6.1.1
-      ParamsRegistry.register(:count, [
-          :ignore_unavailable,
-          :ignore_throttled,
-          :allow_no_indices,
-          :expand_wildcards,
-          :min_score,
-          :preference,
-          :routing,
-          :q,
-          :analyzer,
-          :analyze_wildcard,
-          :default_operator,
-          :df,
-          :lenient,
-          :terminate_after ].freeze)
+        _index = arguments.delete(:index)
+
+        method = if body
+                   Elasticsearch::API::HTTP_POST
+                 else
+                   Elasticsearch::API::HTTP_GET
+                 end
+
+        path   = if _index
+                   "#{Utils.__listify(_index)}/_count"
+                 else
+                   "_count"
+                 end
+        params = Utils.process_params(arguments)
+
+        Elasticsearch::API::Response.new(
+          perform_request(method, path, params, body, headers)
+        )
+      end
     end
   end
 end

data/lib/elasticsearch/api/actions/create.rb

@@ -6,7 +6,7 @@
 # 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
+#   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
@@ -18,38 +18,27 @@
 module Elasticsearch
   module API
     module Actions
-
-      # Create a new document.
-      #
-      # The API will create new document, if it doesn't exist yet -- in that case, it will return
-      # a `409` error (`version_conflict_engine_exception`).
-      #
-      # You can leave out the `:id` parameter for the ID to be generated automatically
-      #
-      # @example Create a document with an ID
-      #
-      #     client.create index: 'myindex',
-      #                  type: 'doc',
-      #                  id: '1',
-      #                  body: {
-      #                   title: 'Test 1'
-      #                 }
-      #
-      # @example Create a document with an auto-generated ID
+      # Creates a new document in the index.
       #
-      #     client.create index: 'myindex',
-      #                  type: 'doc',
-      #                  body: {
-      #                   title: 'Test 1'
-      #                 }
+      # Returns a 409 response when a document with a same ID already exists in the index.
       #
-      # @option (see Actions#index)
+      # @option arguments [String] :id Document ID
+      # @option arguments [String] :index The name of the index
+      # @option arguments [String] :wait_for_active_shards Sets the number of shard copies that must be active before proceeding with the index operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)
+      # @option arguments [String] :refresh If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes. (options: true, false, wait_for)
+      # @option arguments [String] :routing Specific routing value
+      # @option arguments [Time] :timeout Explicit operation timeout
+      # @option arguments [Number] :version Explicit version number for concurrency control
+      # @option arguments [String] :version_type Specific version type (options: internal, external, external_gte)
+      # @option arguments [String] :pipeline The pipeline id to preprocess incoming documents with
+      # @option arguments [Hash] :headers Custom HTTP headers
+      # @option arguments [Hash] :body The document (*Required*)
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-index_.html#_automatic_id_generation
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html
       #
-      def create(arguments={})
+      def create(arguments = {})
         if arguments[:id]
-          index arguments.update :op_type => 'create'
+          index arguments.update op_type: 'create'
         else
           index arguments
         end

data/lib/elasticsearch/api/actions/cross_cluster_replication/delete_auto_follow_pattern.rb

@@ -0,0 +1,51 @@
+# 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 CrossClusterReplication
+      module Actions
+        # Deletes auto-follow patterns.
+        #
+        # @option arguments [String] :name The name of the auto follow pattern.
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-delete-auto-follow-pattern.html
+        #
+        def delete_auto_follow_pattern(arguments = {})
+          raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
+
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          arguments = arguments.clone
+
+          _name = arguments.delete(:name)
+
+          method = Elasticsearch::API::HTTP_DELETE
+          path   = "_ccr/auto_follow/#{Utils.__listify(_name)}"
+          params = {}
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/cross_cluster_replication/follow.rb

@@ -0,0 +1,54 @@
+# 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 CrossClusterReplication
+      module Actions
+        # Creates a new follower index configured to follow the referenced leader index.
+        #
+        # @option arguments [String] :index The name of the follower index
+        # @option arguments [String] :wait_for_active_shards Sets the number of shard copies that must be active before returning. Defaults to 0. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body The name of the leader index and other optional ccr related parameters (*Required*)
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-put-follow.html
+        #
+        def follow(arguments = {})
+          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+          raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
+
+          headers = arguments.delete(:headers) || {}
+
+          body = arguments.delete(:body)
+
+          arguments = arguments.clone
+
+          _index = arguments.delete(:index)
+
+          method = Elasticsearch::API::HTTP_PUT
+          path   = "#{Utils.__listify(_index)}/_ccr/follow"
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/cross_cluster_replication/follow_info.rb

@@ -0,0 +1,51 @@
+# 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 CrossClusterReplication
+      module Actions
+        # Retrieves information about all follower indices, including parameters and status for each follower index
+        #
+        # @option arguments [List] :index A comma-separated list of index patterns; use `_all` to perform the operation on all indices
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-follow-info.html
+        #
+        def follow_info(arguments = {})
+          raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
+
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          arguments = arguments.clone
+
+          _index = arguments.delete(:index)
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = "#{Utils.__listify(_index)}/_ccr/info"
+          params = {}
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/cross_cluster_replication/follow_stats.rb

@@ -0,0 +1,51 @@
+# 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 CrossClusterReplication
+      module Actions
+        # Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices.
+        #
+        # @option arguments [List] :index A comma-separated list of index patterns; use `_all` to perform the operation on all indices
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-follow-stats.html
+        #
+        def follow_stats(arguments = {})
+          raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
+
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          arguments = arguments.clone
+
+          _index = arguments.delete(:index)
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = "#{Utils.__listify(_index)}/_ccr/stats"
+          params = {}
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/cross_cluster_replication/forget_follower.rb

@@ -0,0 +1,53 @@
+# 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 CrossClusterReplication
+      module Actions
+        # Removes the follower retention leases from the leader.
+        #
+        # @option arguments [String] :index the name of the leader index for which specified follower retention leases should be removed
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body the name and UUID of the follower index, the name of the cluster containing the follower index, and the alias from the perspective of that cluster for the remote cluster containing the leader index (*Required*)
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-post-forget-follower.html
+        #
+        def forget_follower(arguments = {})
+          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+          raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
+
+          headers = arguments.delete(:headers) || {}
+
+          body = arguments.delete(:body)
+
+          arguments = arguments.clone
+
+          _index = arguments.delete(:index)
+
+          method = Elasticsearch::API::HTTP_POST
+          path   = "#{Utils.__listify(_index)}/_ccr/forget_follower"
+          params = {}
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/cross_cluster_replication/get_auto_follow_pattern.rb

@@ -0,0 +1,53 @@
+# 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 CrossClusterReplication
+      module Actions
+        # Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection.
+        #
+        # @option arguments [String] :name The name of the auto follow pattern.
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-auto-follow-pattern.html
+        #
+        def get_auto_follow_pattern(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          arguments = arguments.clone
+
+          _name = arguments.delete(:name)
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = if _name
+                     "_ccr/auto_follow/#{Utils.__listify(_name)}"
+                   else
+                     "_ccr/auto_follow"
+                   end
+          params = {}
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end