elasticsearch-api 7.2.0 → 8.0.0

data/lib/elasticsearch/api/actions/{abort_benchmark.rb → get_script_languages.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,24 +18,26 @@
 module Elasticsearch
   module API
     module Actions
-
-      # Abort a running benchmark
-      #
-      # @example
-      #
-      #     client.abort_benchmark name: 'my_benchmark'
+      # Returns available script types, languages and contexts
       #
-      # @option arguments [String] :name A benchmark name
+      # @option arguments [Hash] :headers Custom HTTP headers
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/search-benchmark.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html
       #
-      def abort_benchmark(arguments={})
-        method = HTTP_POST
-        path   = "_bench/abort/#{arguments[:name]}"
+      def get_script_languages(arguments = {})
+        headers = arguments.delete(:headers) || {}
+
+        body = nil
+
+        arguments = arguments.clone
+
+        method = Elasticsearch::API::HTTP_GET
+        path   = "_script_language"
         params = {}
-        body   = nil
 
-        perform_request(method, path, params, body).body
+        Elasticsearch::API::Response.new(
+          perform_request(method, path, params, body, headers)
+        )
       end
     end
   end

data/lib/elasticsearch/api/actions/get_source.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,19 +18,10 @@
 module Elasticsearch
   module API
     module Actions
-
-      # Return a specified document's `_source`.
-      #
-      # The response contains just the original document, as passed to Elasticsearch during indexing.
-      #
-      # @example Get a document `_source`
-      #
-      #     client.get_source index: 'myindex', type: 'mytype', id: '1'
+      # Returns the source of a document.
       #
-      # @option arguments [String] :id The document ID (*Required*)
-      # @option arguments [String] :index The name of the index (*Required*)
-      # @option arguments [String] :type The type of the document; deprecated and optional starting with 7.0
-      # @option arguments [String] :parent The ID of the parent document
+      # @option arguments [String] :id The document ID
+      # @option arguments [String] :index The name of the index
       # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random)
       # @option arguments [Boolean] :realtime Specify whether to perform the operation in realtime or search mode
       # @option arguments [Boolean] :refresh Refresh the shard containing the document before performing the operation
@@ -39,53 +30,33 @@ module Elasticsearch
       # @option arguments [List] :_source_excludes A list of fields to exclude from the returned _source field
       # @option arguments [List] :_source_includes A list of fields to extract and return from the _source field
       # @option arguments [Number] :version Explicit version number for concurrency control
-      # @option arguments [String] :version_type Specific version type (options: internal, external, external_gte, force)
+      # @option arguments [String] :version_type Specific version type (options: internal, external, external_gte)
+      # @option arguments [Hash] :headers Custom HTTP headers
       #
-      # @see http://elasticsearch.org/guide/reference/api/get/
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html
       #
-      # @since 0.90.1
-      #
-      def get_source(arguments={})
+      def get_source(arguments = {})
         raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
-        raise ArgumentError, "Required argument 'id' missing"    unless arguments[:id]
-        arguments[:type] ||= DEFAULT_DOC
+        raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
 
-        method = HTTP_GET
+        headers = arguments.delete(:headers) || {}
 
-        if arguments[:type]
-          path   = Utils.__pathify Utils.__escape(arguments[:index]),
-                                   Utils.__escape(arguments[:type]),
-                                   Utils.__escape(arguments[:id]),
-                                   '_source'
-        else
-          path   = Utils.__pathify Utils.__escape(arguments[:index]),
-                                   '_source',
-                                   Utils.__escape(arguments[:id])
-        end
+        body = nil
 
+        arguments = arguments.clone
 
-        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-        body   = nil
+        _id = arguments.delete(:id)
 
-        params[:fields] = Utils.__listify(params[:fields]) if params[:fields]
+        _index = arguments.delete(:index)
 
-        perform_request(method, path, params, body).body
-      end
+        method = Elasticsearch::API::HTTP_GET
+        path   = "#{Utils.__listify(_index)}/_source/#{Utils.__listify(_id)}"
+        params = Utils.process_params(arguments)
 
-      # Register this action with its valid params when the module is loaded.
-      #
-      # @since 6.1.1
-      ParamsRegistry.register(:get_source, [
-          :parent,
-          :preference,
-          :realtime,
-          :refresh,
-          :routing,
-          :_source,
-          :_source_excludes,
-          :_source_includes,
-          :version,
-          :version_type ].freeze)
+        Elasticsearch::API::Response.new(
+          perform_request(method, path, params, body, headers)
+        )
+      end
     end
   end
 end

data/lib/elasticsearch/api/actions/graph/explore.rb

@@ -0,0 +1,59 @@
+# 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 Graph
+      module Actions
+        # Explore extracted and summarized information about the documents and terms in an index.
+        #
+        # @option arguments [List] :index A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
+        # @option arguments [String] :routing Specific routing value
+        # @option arguments [Time] :timeout Explicit operation timeout
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body Graph Query DSL
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/graph-explore-api.html
+        #
+        def explore(arguments = {})
+          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 = if body
+                     Elasticsearch::API::HTTP_POST
+                   else
+                     Elasticsearch::API::HTTP_GET
+                   end
+
+          path   = "#{Utils.__listify(_index)}/_graph/explore"
+          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/index.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,109 +18,52 @@
 module Elasticsearch
   module API
     module Actions
-
-      # Create or update a document.
-      #
-      # The `index` API will either _create_ a new document, or _update_ an existing one, when a document `:id`
-      # is passed. When creating a document, an ID will be auto-generated, when it's not passed as an argument.
-      #
-      # You can specifically enforce the _create_ operation by setting the `op_type` argument to `create`, or
-      # by using the {Actions#create} method.
-      #
-      # Optimistic concurrency control is performed, when the `version` argument is specified. By default,
-      # no version checks are performed.
-      #
-      # By default, the document will be available for {Actions#get} immediately, for {Actions#search} only
-      # after an index refresh operation has been performed (either automatically or manually).
-      #
-      # @example Create or update a document `myindex/mytype/1`
-      #
-      #     client.index index: 'myindex',
-      #                  type: 'mytype',
-      #                  id: '1',
-      #                  body: {
-      #                   title: 'Test 1',
-      #                   tags: ['y', 'z'],
-      #                   published: true,
-      #                   published_at: Time.now.utc.iso8601,
-      #                   counter: 1
-      #                 }
-      #
-      # @example Refresh the index after the operation (useful e.g. in integration tests)
-      #
-      #     client.index index: 'myindex', type: 'mytype', id: '1', body: { title: 'TEST' }, refresh: true
-      #     client.search index: 'myindex', q: 'title:test'
-      #
-      # @example Create a document with a specific expiration time (TTL)
-      #
-      #     # Decrease the default housekeeping interval first:
-      #     client.cluster.put_settings body: { transient: { 'indices.ttl.interval' => '1s' } }
-      #
-      #     # Enable the `_ttl` property for all types within the index
-      #     client.indices.create index: 'myindex', body: { mappings: { properties: { _ttl: { enabled: true } }  } }
-      #
-      #     client.index index: 'myindex', type: 'mytype', id: '1', body: { title: 'TEST' }, ttl: '5s'
+      # Creates or updates a document in an index.
       #
-      #     sleep 3 and client.get index: 'myindex', type: 'mytype', id: '1'
-      #     # => {"_index"=>"myindex" ... "_source"=>{"title"=>"TEST"}}
-      #
-      #     sleep 3 and client.get index: 'myindex', type: 'mytype', id: '1'
-      #     # => Elasticsearch::Transport::Transport::Errors::NotFound: [404] ...
-      #
-      # @option arguments [String] :id Document ID (optional, will be auto-generated if missing)
-      # @option arguments [String] :index The name of the index (*Required*)
-      # @option arguments [String] :type The type of the document (*Required*)
-      # @option arguments [Hash] :body The document
-      # @option arguments [String] :consistency Explicit write consistency setting for the operation
-      #                                         (options: one, quorum, all)
-      # @option arguments [Boolean] :include_type_name Whether a type should be expected in the body of the mappings.
-      # @option arguments [String] :op_type Explicit operation type (options: index, create)
-      # @option arguments [String] :parent ID of the parent document
-      # @option arguments [String] :percolate Percolator queries to execute while indexing the document
-      # @option arguments [Boolean] :refresh Refresh the index after performing the operation
-      # @option arguments [String] :replication Specific replication type (options: sync, async)
+      # @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] :op_type Explicit operation type. Defaults to `index` for requests with an explicit document ID, and to `create`for requests without an explicit document ID (options: index, create)
+      # @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 [Time] :timestamp Explicit timestamp for the document
-      # @option arguments [Duration] :ttl Expiration time for the document
       # @option arguments [Number] :version Explicit version number for concurrency control
-      # @option arguments [String] :version_type Specific version type (options: internal, external, external_gte, force)
-      #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-index_.html
-      #
-      def index(arguments={})
+      # @option arguments [String] :version_type Specific version type (options: internal, external, external_gte)
+      # @option arguments [Number] :if_seq_no only perform the index operation if the last operation that has changed the document has the specified sequence number
+      # @option arguments [Number] :if_primary_term only perform the index operation if the last operation that has changed the document has the specified primary term
+      # @option arguments [String] :pipeline The pipeline id to preprocess incoming documents with
+      # @option arguments [Boolean] :require_alias When true, requires destination to be an alias. Default is false
+      # @option arguments [Hash] :headers Custom HTTP headers
+      # @option arguments [Hash] :body The document (*Required*)
+      #
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html
+      #
+      def index(arguments = {})
+        raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
         raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
-        arguments[:type] ||= DEFAULT_DOC
-        method = arguments[:id] ? HTTP_PUT : HTTP_POST
-        path   = Utils.__pathify Utils.__escape(arguments[:index]),
-                                 Utils.__escape(arguments[:type]),
-                                 Utils.__escape(arguments[:id])
 
-        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-        body   = arguments[:body]
-        perform_request(method, path, params, body).body
-      end
+        headers = arguments.delete(:headers) || {}
 
-      # Register this action with its valid params when the module is loaded.
-      #
-      # @since 6.1.1
-      ParamsRegistry.register(:index, [
-          :consistency,
-          :include_type_name,
-          :op_type,
-          :parent,
-          :percolate,
-          :pipeline,
-          :refresh,
-          :replication,
-          :routing,
-          :timeout,
-          :timestamp,
-          :ttl,
-          :version,
-          :version_type,
-          :if_seq_no,
-          :if_primary_term ].freeze)
+        body = arguments.delete(:body)
+
+        arguments = arguments.clone
+
+        _id = arguments.delete(:id)
+
+        _index = arguments.delete(:index)
+
+        method = _id ? Elasticsearch::API::HTTP_PUT : Elasticsearch::API::HTTP_POST
+        path   = if _index && _id
+                   "#{Utils.__listify(_index)}/_doc/#{Utils.__listify(_id)}"
+                 else
+                   "#{Utils.__listify(_index)}/_doc"
+                 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/index_lifecycle_management/delete_lifecycle.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 IndexLifecycleManagement
+      module Actions
+        # Deletes the specified lifecycle policy definition. A currently used policy cannot be deleted.
+        #
+        # @option arguments [String] :policy The name of the index lifecycle policy
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-delete-lifecycle.html
+        #
+        def delete_lifecycle(arguments = {})
+          raise ArgumentError, "Required argument 'policy' missing" unless arguments[:policy]
+
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          arguments = arguments.clone
+
+          _policy = arguments.delete(:policy)
+
+          method = Elasticsearch::API::HTTP_DELETE
+          path   = "_ilm/policy/#{Utils.__listify(_policy)}"
+          params = {}
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/index_lifecycle_management/explain_lifecycle.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 IndexLifecycleManagement
+      module Actions
+        # Retrieves information about the index's current lifecycle state, such as the currently executing phase, action, and step.
+        #
+        # @option arguments [String] :index The name of the index to explain
+        # @option arguments [Boolean] :only_managed filters the indices included in the response to ones managed by ILM
+        # @option arguments [Boolean] :only_errors filters the indices included in the response to ones in an ILM error state, implies only_managed
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-explain-lifecycle.html
+        #
+        def explain_lifecycle(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)}/_ilm/explain"
+          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/index_lifecycle_management/get_lifecycle.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 IndexLifecycleManagement
+      module Actions
+        # Returns the specified policy definition. Includes the policy version and last modified date.
+        #
+        # @option arguments [String] :policy The name of the index lifecycle policy
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-get-lifecycle.html
+        #
+        def get_lifecycle(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          arguments = arguments.clone
+
+          _policy = arguments.delete(:policy)
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = if _policy
+                     "_ilm/policy/#{Utils.__listify(_policy)}"
+                   else
+                     "_ilm/policy"
+                   end
+          params = {}
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/index_lifecycle_management/get_status.rb

@@ -0,0 +1,46 @@
+# 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 IndexLifecycleManagement
+      module Actions
+        # Retrieves the current index lifecycle management (ILM) status.
+        #
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-get-status.html
+        #
+        def get_status(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          arguments = arguments.clone
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = "_ilm/status"
+          params = {}
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/index_lifecycle_management/migrate_to_data_tiers.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.
+
+module Elasticsearch
+  module API
+    module IndexLifecycleManagement
+      module Actions
+        # Migrates the indices and ILM policies away from custom node attribute allocation routing to data tiers routing
+        #
+        # @option arguments [Boolean] :dry_run If set to true it will simulate the migration, providing a way to retrieve the ILM policies and indices that need to be migrated. The default is false
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body Optionally specify a legacy index template name to delete and optionally specify a node attribute name used for index shard routing (defaults to "data")
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-migrate-to-data-tiers.html
+        #
+        def migrate_to_data_tiers(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
+          body = arguments.delete(:body)
+
+          arguments = arguments.clone
+
+          method = Elasticsearch::API::HTTP_POST
+          path   = "_ilm/migrate_to_data_tiers"
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end