[XPACK] Update generated code with stability docs

picandocodigo · picandocodigo · commit 69fa52cc21ae · 2020-07-30T14:43:09.000+01:00
diff --git a/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/data_frame_transform_deprecated/delete_transform.rb b/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/data_frame_transform_deprecated/delete_transform.rb
@@ -21,6 +21,10 @@ module API
       module DataFrameTransformDeprecated
         module Actions
           # Deletes an existing transform.
+          # This functionality is in Beta and is subject to change. The design and
+          # code is less mature than official GA features and is being provided
+          # as-is with no warranties. Beta features are not subject to the support
+          # SLA of official GA features.
           #
           # @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.
diff --git a/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/data_frame_transform_deprecated/get_transform.rb b/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/data_frame_transform_deprecated/get_transform.rb
@@ -21,6 +21,10 @@ module API
       module DataFrameTransformDeprecated
         module Actions
           # Retrieves configuration information for transforms.
+          # This functionality is in Beta and is subject to change. The design and
+          # code is less mature than official GA features and is being provided
+          # as-is with no warranties. Beta features are not subject to the support
+          # SLA of official GA features.
           #
           # @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
diff --git a/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/data_frame_transform_deprecated/get_transform_stats.rb b/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/data_frame_transform_deprecated/get_transform_stats.rb
@@ -21,6 +21,10 @@ module API
       module DataFrameTransformDeprecated
         module Actions
           # Retrieves usage information for transforms.
+          # This functionality is in Beta and is subject to change. The design and
+          # code is less mature than official GA features and is being provided
+          # as-is with no warranties. Beta features are not subject to the support
+          # SLA of official GA features.
           #
           # @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
diff --git a/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/data_frame_transform_deprecated/preview_transform.rb b/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/data_frame_transform_deprecated/preview_transform.rb
@@ -21,6 +21,10 @@ module API
       module DataFrameTransformDeprecated
         module Actions
           # Previews a transform.
+          # This functionality is in Beta and is subject to change. The design and
+          # code is less mature than official GA features and is being provided
+          # as-is with no warranties. Beta features are not subject to the support
+          # SLA of official GA features.
           #
           # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body The definition for the transform to preview (*Required*)
diff --git a/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/data_frame_transform_deprecated/put_transform.rb b/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/data_frame_transform_deprecated/put_transform.rb
@@ -21,6 +21,10 @@ module API
       module DataFrameTransformDeprecated
         module Actions
           # Instantiates a transform.
+          # This functionality is in Beta and is subject to change. The design and
+          # code is less mature than official GA features and is being provided
+          # as-is with no warranties. Beta features are not subject to the support
+          # SLA of official GA features.
           #
           # @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.
diff --git a/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/data_frame_transform_deprecated/start_transform.rb b/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/data_frame_transform_deprecated/start_transform.rb
@@ -21,6 +21,10 @@ module API
       module DataFrameTransformDeprecated
         module Actions
           # Starts one or more transforms.
+          # This functionality is in Beta and is subject to change. The design and
+          # code is less mature than official GA features and is being provided
+          # as-is with no warranties. Beta features are not subject to the support
+          # SLA of official GA features.
           #
           # @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
diff --git a/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/data_frame_transform_deprecated/stop_transform.rb b/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/data_frame_transform_deprecated/stop_transform.rb
@@ -21,6 +21,10 @@ module API
       module DataFrameTransformDeprecated
         module Actions
           # Stops one or more transforms.
+          # This functionality is in Beta and is subject to change. The design and
+          # code is less mature than official GA features and is being provided
+          # as-is with no warranties. Beta features are not subject to the support
+          # SLA of official GA features.
           #
           # @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
diff --git a/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/data_frame_transform_deprecated/update_transform.rb b/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/data_frame_transform_deprecated/update_transform.rb
@@ -21,6 +21,10 @@ module API
       module DataFrameTransformDeprecated
         module Actions
           # Updates certain properties of a transform.
+          # This functionality is in Beta and is subject to change. The design and
+          # code is less mature than official GA features and is being provided
+          # as-is with no warranties. Beta features are not subject to the support
+          # SLA of official GA features.
           #
           # @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.
diff --git a/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/machine_learning/delete_data_frame_analytics.rb b/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/machine_learning/delete_data_frame_analytics.rb
@@ -21,6 +21,10 @@ module API
       module MachineLearning
         module Actions
           # Deletes an existing data frame analytics job.
+          # 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] :id The ID of the data frame analytics to delete
           # @option arguments [Boolean] :force True if the job should be forcefully deleted
diff --git a/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/machine_learning/delete_trained_model.rb b/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/machine_learning/delete_trained_model.rb
@@ -21,6 +21,10 @@ module API
       module MachineLearning
         module Actions
           # Deletes an existing trained inference model that is currently not referenced by an ingest pipeline.
+          # 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] :model_id The ID of the trained model to delete
           # @option arguments [Hash] :headers Custom HTTP headers
diff --git a/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/machine_learning/evaluate_data_frame.rb b/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/machine_learning/evaluate_data_frame.rb
@@ -21,6 +21,10 @@ module API
       module MachineLearning
         module Actions
           # Evaluates the data frame analytics for an annotated index.
+          # 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 [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body The evaluation definition (*Required*)
diff --git a/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/machine_learning/explain_data_frame_analytics.rb b/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/machine_learning/explain_data_frame_analytics.rb
@@ -21,6 +21,10 @@ module API
       module MachineLearning
         module Actions
           # Explains a data frame analytics config.
+          # 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] :id The ID of the data frame analytics to explain
           # @option arguments [Hash] :headers Custom HTTP headers
diff --git a/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/machine_learning/find_file_structure.rb b/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/machine_learning/find_file_structure.rb
@@ -21,6 +21,10 @@ module API
       module MachineLearning
         module Actions
           # Finds the structure of a text file. The text file must contain data that is suitable to be ingested into Elasticsearch.
+          # 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 [Int] :lines_to_sample How many lines of the file should be included in the analysis
           # @option arguments [Int] :line_merge_size_limit Maximum number of characters permitted in a single message when lines are merged to create messages.
diff --git a/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/machine_learning/get_data_frame_analytics.rb b/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/machine_learning/get_data_frame_analytics.rb
@@ -21,6 +21,10 @@ module API
       module MachineLearning
         module Actions
           # Retrieves configuration information for data frame analytics jobs.
+          # 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] :id The ID of the data frame analytics to fetch
           # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no data frame analytics. (This includes `_all` string or when no data frame analytics have been specified)
diff --git a/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/machine_learning/get_data_frame_analytics_stats.rb b/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/machine_learning/get_data_frame_analytics_stats.rb
@@ -21,6 +21,10 @@ module API
       module MachineLearning
         module Actions
           # Retrieves usage information for data frame analytics jobs.
+          # 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] :id The ID of the data frame analytics stats to fetch
           # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no data frame analytics. (This includes `_all` string or when no data frame analytics have been specified)
diff --git a/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/machine_learning/get_trained_models.rb b/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/machine_learning/get_trained_models.rb
@@ -21,6 +21,10 @@ module API
       module MachineLearning
         module Actions
           # Retrieves configuration information for a trained inference model.
+          # 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] :model_id The ID of the trained models to fetch
           # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no trained models. (This includes `_all` string or when no trained models have been specified)
diff --git a/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/machine_learning/get_trained_models_stats.rb b/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/machine_learning/get_trained_models_stats.rb
@@ -21,6 +21,10 @@ module API
       module MachineLearning
         module Actions
           # Retrieves usage information for trained inference models.
+          # 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] :model_id The ID of the trained models stats to fetch
           # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no trained models. (This includes `_all` string or when no trained models have been specified)
diff --git a/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/machine_learning/put_data_frame_analytics.rb b/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/machine_learning/put_data_frame_analytics.rb
@@ -21,6 +21,10 @@ module API
       module MachineLearning
         module Actions
           # Instantiates a data frame analytics job.
+          # 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] :id The ID of the data frame analytics to create
           # @option arguments [Hash] :headers Custom HTTP headers
diff --git a/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/machine_learning/put_trained_model.rb b/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/machine_learning/put_trained_model.rb
@@ -21,6 +21,10 @@ module API
       module MachineLearning
         module Actions
           # Creates an inference trained model.
+          # 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] :model_id The ID of the trained models to store
           # @option arguments [Hash] :headers Custom HTTP headers
diff --git a/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/machine_learning/start_data_frame_analytics.rb b/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/machine_learning/start_data_frame_analytics.rb
@@ -21,6 +21,10 @@ module API
       module MachineLearning
         module Actions
           # Starts a data frame analytics job.
+          # 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] :id The ID of the data frame analytics to start
           # @option arguments [Time] :timeout Controls the time to wait until the task has started. Defaults to 20 seconds
diff --git a/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/machine_learning/stop_data_frame_analytics.rb b/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/machine_learning/stop_data_frame_analytics.rb
@@ -21,6 +21,10 @@ module API
       module MachineLearning
         module Actions
           # Stops one or more data frame analytics jobs.
+          # 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] :id The ID of the data frame analytics to stop
           # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no data frame analytics. (This includes `_all` string or when no data frame analytics have been specified)
diff --git a/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/monitoring/bulk.rb b/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/monitoring/bulk.rb
@@ -21,6 +21,10 @@ module API
       module Monitoring
         module Actions
           # Used by the monitoring features to send monitoring data.
+          # 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] :type Default document type for items which don't provide one   *Deprecated*
           # @option arguments [String] :system_id Identifier of the monitored system
diff --git a/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/rollup/delete_job.rb b/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/rollup/delete_job.rb
@@ -21,6 +21,10 @@ module API
       module Rollup
         module Actions
           # Deletes an existing rollup job.
+          # 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] :id The ID of the job to delete
           # @option arguments [Hash] :headers Custom HTTP headers
diff --git a/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/rollup/get_jobs.rb b/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/rollup/get_jobs.rb
@@ -21,6 +21,10 @@ module API
       module Rollup
         module Actions
           # Retrieves the configuration, stats, and status of rollup jobs.
+          # 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] :id The ID of the job(s) to fetch. Accepts glob patterns, or left blank for all jobs
           # @option arguments [Hash] :headers Custom HTTP headers
diff --git a/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/rollup/get_rollup_caps.rb b/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/rollup/get_rollup_caps.rb
@@ -21,6 +21,10 @@ module API
       module Rollup
         module Actions
           # Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern.
+          # 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] :id The ID of the index to check rollup capabilities on, or left blank for all jobs
           # @option arguments [Hash] :headers Custom HTTP headers
diff --git a/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/rollup/get_rollup_index_caps.rb b/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/rollup/get_rollup_index_caps.rb
@@ -21,6 +21,10 @@ module API
       module Rollup
         module Actions
           # Returns the rollup capabilities of all jobs inside of a rollup index (e.g. the index where rollup data is stored).
+          # 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 The rollup index or index pattern to obtain rollup capabilities from.
           # @option arguments [Hash] :headers Custom HTTP headers
diff --git a/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/rollup/put_job.rb b/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/rollup/put_job.rb
@@ -21,6 +21,10 @@ module API
       module Rollup
         module Actions
           # Creates a rollup job.
+          # 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] :id The ID of the job to create
           # @option arguments [Hash] :headers Custom HTTP headers
diff --git a/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/rollup/rollup_search.rb b/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/rollup/rollup_search.rb
@@ -21,6 +21,10 @@ module API
       module Rollup
         module Actions
           # Enables searching rolled-up data using the standard query DSL.
+          # 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 [List] :index The indices or index-pattern(s) (containing rollup or regular data) that should be searched
           # @option arguments [String] :type The doc type inside the index   *Deprecated*
diff --git a/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/rollup/start_job.rb b/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/rollup/start_job.rb
@@ -21,6 +21,10 @@ module API
       module Rollup
         module Actions
           # Starts an existing, stopped rollup job.
+          # 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] :id The ID of the job to start
           # @option arguments [Hash] :headers Custom HTTP headers
diff --git a/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/rollup/stop_job.rb b/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/rollup/stop_job.rb
@@ -21,6 +21,10 @@ module API
       module Rollup
         module Actions
           # Stops an existing, started rollup job.
+          # 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] :id The ID of the job to stop
           # @option arguments [Boolean] :wait_for_completion True if the API should block until the job has fully stopped, false if should be executed async. Defaults to false.
diff --git a/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/searchable_snapshots/clear_cache.rb b/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/searchable_snapshots/clear_cache.rb
diff --git a/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/searchable_snapshots/mount.rb b/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/searchable_snapshots/mount.rb
diff --git a/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/searchable_snapshots/repository_stats.rb b/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/searchable_snapshots/repository_stats.rb
diff --git a/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/searchable_snapshots/stats.rb b/elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/searchable_snapshots/stats.rb
