elasticsearch-xpack 7.4.0 → 7.5.0.pre.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7913c8a63a2df01c7d876709583348cb2eaac5fb46532164567c8095d527c377
-  data.tar.gz: 3c512f17307d2014b39c7ae9b0ca0f8b9ae558efa70f9f160aa0f39e6f931391
+  metadata.gz: 91a0184d49c7a454d3ee071e35266936cb5d502191da37c720713a10c3d4243f
+  data.tar.gz: c45db719a9eb9df0f90f69aa0fa0ec613e442df072d8ce255b36d86f43ed95c8
 SHA512:
-  metadata.gz: 4e7ff84451376fc5f87cefe883ff79fca0fe2415ecbd87f1cdc92890d48a01d9575bfd4bb7314b017173d3d3e5db47212a55a375ffc98cae5b963e5ee59cf5fd
-  data.tar.gz: fc1a7fb35baf259cd4b2f7a031107c80b43180a31d0b08d70dee8eb386bf39582413b531b726e9257dec12d6b225aba32f78282e071efd5955b4f46b61e2f494
+  metadata.gz: b28c0aab9d81fd11e79eaa29398b95ab369264df1e90c780c3f04fbe0ff2306ec4c1c6d81ad7cc6842f6b35cc6b454e4bdfb2c5f47a11c895f29319a7c400e85
+  data.tar.gz: a6fcb2cda776b525e1adb0e78088d6ce96b6feeb21e990119a77ec483fc7edae3373192ed23e2569e3b6ae4730f8aa32e2fd4a6fcf9d83975362b012b7cb9e66

data/lib/elasticsearch/xpack/api/actions/{data_frame/delete_data_frame_transform.rb → data_frame_transform_deprecated/delete_transform.rb}

@@ -5,37 +5,45 @@
 module Elasticsearch
   module XPack
     module API
-      module DataFrame
+      module DataFrameTransformDeprecated
         module Actions
+          # TODO: Description
 
-          # Deletes an existing data frame transform.
           #
-          # @option arguments [String] :transform_id The id of the transform to delete. *Required*
-          # @option arguments [Boolean] :force When `true`, the transform is deleted regardless of its current state.
-          #   The default value is `false`, meaning that the transform must be `stopped` before it can be deleted.
+          # @option arguments [String] :transform_id The id of the transform to delete
+          # @option arguments [Boolean] :force When `true`, the transform is deleted regardless of its current state. The default value is `false`, meaning that the transform must be `stopped` before it can be deleted.
+
+          #
+          # *Deprecation notice*:
+          # [_data_frame/transforms/] is deprecated, use [_transform/] in the future.
+          # Deprecated since version 7.5.0
+          #
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-data-frame-transform.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-transform.html
           #
-          # @since 7.2.0
-          def delete_data_frame_transform(arguments={})
+          def delete_transform(arguments = {})
             raise ArgumentError, "Required argument 'transform_id' missing" unless arguments[:transform_id]
-            arguments.clone
-            transform_id = URI.escape(arguments.delete(:transform_id))
+
+            arguments = arguments.clone
+
+            _transform_id = arguments.delete(:transform_id)
 
             method = Elasticsearch::API::HTTP_DELETE
-            path   = "_data_frame/transforms/#{transform_id}"
-            params = Elasticsearch::API::Utils.__validate_and_extract_params(arguments, ParamsRegistry.get(__method__))
-            body   = nil
+            path   = "_data_frame/transforms/#{Elasticsearch::API::Utils.__listify(_transform_id)}"
+            params = Elasticsearch::API::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 7.4.0
-          ParamsRegistry.register(:delete_data_frame_transform, [ :force ].freeze)
-        end
+          # @since 6.2.0
+          ParamsRegistry.register(:delete_transform, [
+            :force
+          ].freeze)
       end
     end
+    end
   end
 end

data/lib/elasticsearch/xpack/api/actions/data_frame_transform_deprecated/get_transform.rb

@@ -0,0 +1,55 @@
+# 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
+
+module Elasticsearch
+  module XPack
+    module API
+      module DataFrameTransformDeprecated
+        module Actions
+          # TODO: Description
+
+          #
+          # @option arguments [String] :transform_id The id or comma delimited list of id expressions of the transforms to get, '_all' or '*' implies get all transforms
+          # @option arguments [Int] :from skips a number of transform configs, defaults to 0
+          # @option arguments [Int] :size specifies a max number of transforms to get, defaults to 100
+          # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no transforms. (This includes `_all` string or when no transforms have been specified)
+
+          #
+          # *Deprecation notice*:
+          # [_data_frame/transforms/] is deprecated, use [_transform/] in the future.
+          # Deprecated since version 7.5.0
+          #
+          #
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform.html
+          #
+          def get_transform(arguments = {})
+            arguments = arguments.clone
+
+            _transform_id = arguments.delete(:transform_id)
+
+            method = Elasticsearch::API::HTTP_GET
+            path   = if _transform_id
+                       "_data_frame/transforms/#{Elasticsearch::API::Utils.__listify(_transform_id)}"
+                     else
+                       "_data_frame/transforms"
+  end
+            params = Elasticsearch::API::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(:get_transform, [
+            :from,
+            :size,
+            :allow_no_match
+          ].freeze)
+      end
+    end
+    end
+  end
+end

data/lib/elasticsearch/xpack/api/actions/data_frame_transform_deprecated/get_transform_stats.rb

@@ -0,0 +1,53 @@
+# 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
+
+module Elasticsearch
+  module XPack
+    module API
+      module DataFrameTransformDeprecated
+        module Actions
+          # TODO: Description
+
+          #
+          # @option arguments [String] :transform_id The id of the transform for which to get stats. '_all' or '*' implies all transforms
+          # @option arguments [Number] :from skips a number of transform stats, defaults to 0
+          # @option arguments [Number] :size specifies a max number of transform stats to get, defaults to 100
+          # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no transforms. (This includes `_all` string or when no transforms have been specified)
+
+          #
+          # *Deprecation notice*:
+          # [_data_frame/transforms/] is deprecated, use [_transform/] in the future.
+          # Deprecated since version 7.5.0
+          #
+          #
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform-stats.html
+          #
+          def get_transform_stats(arguments = {})
+            raise ArgumentError, "Required argument 'transform_id' missing" unless arguments[:transform_id]
+
+            arguments = arguments.clone
+
+            _transform_id = arguments.delete(:transform_id)
+
+            method = Elasticsearch::API::HTTP_GET
+            path   = "_data_frame/transforms/#{Elasticsearch::API::Utils.__listify(_transform_id)}/_stats"
+            params = Elasticsearch::API::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(:get_transform_stats, [
+            :from,
+            :size,
+            :allow_no_match
+          ].freeze)
+      end
+    end
+    end
+  end
+end

data/lib/elasticsearch/xpack/api/actions/{data_frame → data_frame_transform_deprecated}/params_registry.rb

@@ -5,10 +5,9 @@
 module Elasticsearch
   module XPack
     module API
-      module DataFrame
+      module DataFrameTransformDeprecated
         module Actions
           module ParamsRegistry
-
             extend self
 
             # A Mapping of all the actions to their list of valid params.

data/lib/elasticsearch/xpack/api/actions/{data_frame/preview_data_frame_transform.rb → data_frame_transform_deprecated/preview_transform.rb}

@@ -5,27 +5,33 @@
 module Elasticsearch
   module XPack
     module API
-      module DataFrame
+      module DataFrameTransformDeprecated
         module Actions
+          # TODO: Description
 
-          # Previews a data frame transform.
+          # @option arguments [Hash] :body The definition for the transform to preview (*Required*)
           #
-          # @option arguments [Hash] :body The definition for the data_frame transform to preview. *Required*
+          # *Deprecation notice*:
+          # [_data_frame/transforms/] is deprecated, use [_transform/] in the future.
+          # Deprecated since version 7.5.0
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/preview-data-frame-transform.html
           #
-          # @sicne 7.2.0
-          def preview_data_frame_transform(arguments={})
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/preview-transform.html
+          #
+          def preview_transform(arguments = {})
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+
+            arguments = arguments.clone
+
             method = Elasticsearch::API::HTTP_POST
-            path   = '_data_frame/transforms/_preview'
+            path   = "_data_frame/transforms/_preview"
             params = {}
-            body   = arguments[:body]
 
+            body = arguments[:body]
             perform_request(method, path, params, body).body
           end
-        end
       end
     end
+    end
   end
 end

data/lib/elasticsearch/xpack/api/actions/{data_frame/put_data_frame_transform.rb → data_frame_transform_deprecated/put_transform.rb}

@@ -5,40 +5,47 @@
 module Elasticsearch
   module XPack
     module API
-      module DataFrame
+      module DataFrameTransformDeprecated
         module Actions
+          # TODO: Description
 
-          # Instantiates a data frame transform.
           #
-          # @option arguments [Hash] :transform_id The id of the new transform. *Required*
-          # @option arguments [Hash] :body The data frame transform definition. *Required*
-          # @option arguments [Boolean] :defer_validation If validations should be deferred until transform starts,
-          #   defaults to false.
+          # @option arguments [String] :transform_id The id of the new transform.
+          # @option arguments [Boolean] :defer_validation If validations should be deferred until transform starts, defaults to false.
+
+          # @option arguments [Hash] :body The transform definition (*Required*)
+          #
+          # *Deprecation notice*:
+          # [_data_frame/transforms/] is deprecated, use [_transform/] in the future.
+          # Deprecated since version 7.5.0
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/put-data-frame-transform.html
           #
-          # @since 7.2.0
-          def put_data_frame_transform(arguments={})
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/put-transform.html
+          #
+          def put_transform(arguments = {})
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
             raise ArgumentError, "Required argument 'transform_id' missing" unless arguments[:transform_id]
 
             arguments = arguments.clone
-            transform_id = URI.escape(arguments.delete(:transform_id))
-            body = arguments[:body]
+
+            _transform_id = arguments.delete(:transform_id)
 
             method = Elasticsearch::API::HTTP_PUT
-            path   = "_data_frame/transforms/#{transform_id}"
-            params = Elasticsearch::API::Utils.__validate_and_extract_params(arguments, ParamsRegistry.get(__method__))
+            path   = "_data_frame/transforms/#{Elasticsearch::API::Utils.__listify(_transform_id)}"
+            params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
+            body = arguments[:body]
             perform_request(method, path, params, body).body
           end
 
           # Register this action with its valid params when the module is loaded.
           #
-          # @since 7.4.0
-          ParamsRegistry.register(:put_data_frame_transform, [ :defer_validation ].freeze)
-        end
+          # @since 6.2.0
+          ParamsRegistry.register(:put_transform, [
+            :defer_validation
+          ].freeze)
       end
     end
+    end
   end
 end

data/lib/elasticsearch/xpack/api/actions/{data_frame/start_data_frame_transform.rb → data_frame_transform_deprecated/start_transform.rb}

@@ -5,36 +5,45 @@
 module Elasticsearch
   module XPack
     module API
-      module DataFrame
+      module DataFrameTransformDeprecated
         module Actions
+          # TODO: Description
 
-          # Start a data frame analytics job.
           #
-          # @option arguments [String] :transform_id The id of the transform to start. *Required*
-          # @option arguments [String] :timeout Controls the time to wait for the transform to start.
+          # @option arguments [String] :transform_id The id of the transform to start
+          # @option arguments [Time] :timeout Controls the time to wait for the transform to start
+
+          #
+          # *Deprecation notice*:
+          # [_data_frame/transforms/] is deprecated, use [_transform/] in the future.
+          # Deprecated since version 7.5.0
+          #
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/start-data-frame-transform.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/start-transform.html
           #
-          # @since 7.2.0
-          def start_data_frame_transform(arguments={})
+          def start_transform(arguments = {})
             raise ArgumentError, "Required argument 'transform_id' missing" unless arguments[:transform_id]
+
             arguments = arguments.clone
-            transform_id = URI.escape(arguments.delete(:transform_id))
+
+            _transform_id = arguments.delete(:transform_id)
 
             method = Elasticsearch::API::HTTP_POST
-            path   = "_data_frame/transforms/#{transform_id}/_start"
+            path   = "_data_frame/transforms/#{Elasticsearch::API::Utils.__listify(_transform_id)}/_start"
             params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-            body   = nil
 
+            body = nil
             perform_request(method, path, params, body).body
           end
 
           # Register this action with its valid params when the module is loaded.
           #
-          # @since 7.4.0
-          ParamsRegistry.register(:start_data_frame_transform, [ :timeout ].freeze)
-        end
+          # @since 6.2.0
+          ParamsRegistry.register(:start_transform, [
+            :timeout
+          ].freeze)
       end
     end
+    end
   end
 end

data/lib/elasticsearch/xpack/api/actions/data_frame_transform_deprecated/stop_transform.rb

@@ -0,0 +1,53 @@
+# 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
+
+module Elasticsearch
+  module XPack
+    module API
+      module DataFrameTransformDeprecated
+        module Actions
+          # TODO: Description
+
+          #
+          # @option arguments [String] :transform_id The id of the transform to stop
+          # @option arguments [Boolean] :wait_for_completion Whether to wait for the transform to fully stop before returning or not. Default to false
+          # @option arguments [Time] :timeout Controls the time to wait until the transform has stopped. Default to 30 seconds
+          # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no transforms. (This includes `_all` string or when no transforms have been specified)
+
+          #
+          # *Deprecation notice*:
+          # [_data_frame/transforms/] is deprecated, use [_transform/] in the future.
+          # Deprecated since version 7.5.0
+          #
+          #
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-transform.html
+          #
+          def stop_transform(arguments = {})
+            raise ArgumentError, "Required argument 'transform_id' missing" unless arguments[:transform_id]
+
+            arguments = arguments.clone
+
+            _transform_id = arguments.delete(:transform_id)
+
+            method = Elasticsearch::API::HTTP_POST
+            path   = "_data_frame/transforms/#{Elasticsearch::API::Utils.__listify(_transform_id)}/_stop"
+            params = Elasticsearch::API::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(:stop_transform, [
+            :wait_for_completion,
+            :timeout,
+            :allow_no_match
+          ].freeze)
+      end
+    end
+    end
+  end
+end

data/lib/elasticsearch/xpack/api/actions/{data_frame/update_data_frame_transform.rb → data_frame_transform_deprecated/update_transform.rb}

@@ -5,41 +5,47 @@
 module Elasticsearch
   module XPack
     module API
-      module DataFrame
+      module DataFrameTransformDeprecated
         module Actions
+          # TODO: Description
 
-          # Updates an existing data frame transform.
           #
-          # @option arguments [Hash] :transform_id The id of the new transform. *Required*
-          # @option arguments [Hash] :body The update data frame transform definition. *Required*
-          # @option arguments [Boolean] :defer_validation If validations should be deferred until data frame
-          #   transform starts, defaults to false.
+          # @option arguments [String] :transform_id The id of the transform.  (*Required*)
+          # @option arguments [Boolean] :defer_validation If validations should be deferred until transform starts, defaults to false.
+
+          # @option arguments [Hash] :body The update transform definition (*Required*)
+          #
+          # *Deprecation notice*:
+          # [_data_frame/transforms/] is deprecated, use [_transform/] in the future.
+          # Deprecated since version 7.5.0
+          #
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/update-data-frame-transform.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/update-transform.html
           #
-          # @since 7.4.0
-          def update_data_frame_transform(arguments={})
+          def update_transform(arguments = {})
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
             raise ArgumentError, "Required argument 'transform_id' missing" unless arguments[:transform_id]
+
             arguments = arguments.clone
 
-            transform_id = URI.escape(arguments.delete(:transform_id))
-            body = arguments.delete(:body)
+            _transform_id = arguments.delete(:transform_id)
 
             method = Elasticsearch::API::HTTP_POST
-            path   = "_data_frame/transforms/#{transform_id}/_update"
-            params = Elasticsearch::API::Utils.__validate_and_extract_params(arguments, ParamsRegistry.get(__method__))
+            path   = "_data_frame/transforms/#{Elasticsearch::API::Utils.__listify(_transform_id)}/_update"
+            params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
+            body = arguments[:body]
             perform_request(method, path, params, body).body
           end
 
-
           # Register this action with its valid params when the module is loaded.
           #
-          # @since 7.4.0
-          ParamsRegistry.register(:update_data_frame_transform, [ :defer_validation ].freeze)
-        end
+          # @since 6.2.0
+          ParamsRegistry.register(:update_transform, [
+            :defer_validation
+          ].freeze)
       end
     end
+    end
   end
 end