RubyGems - elasticsearch-api - Versions diffs - 9.0.2 → 9.0.4 - Mend

elasticsearch-api 9.0.2 → 9.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (518) hide show

data/lib/elasticsearch/api/actions/machine_learning/delete_filter.rb CHANGED Viewed

@@ -27,6 +27,17 @@ module Elasticsearch
         # filter. You must update or delete the job before you can delete the filter.
         #
         # @option arguments [String] :filter_id A string that uniquely identifies a filter. (*Required*)
+        # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
         # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-delete-filter
@@ -50,7 +61,7 @@ module Elasticsearch
           method = Elasticsearch::API::HTTP_DELETE
           path   = "_ml/filters/#{Utils.listify(_filter_id)}"
-          params = {}
+          params = Utils.process_params(arguments)
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)

data/lib/elasticsearch/api/actions/machine_learning/delete_forecast.rb CHANGED Viewed

@@ -24,21 +24,32 @@ module Elasticsearch
       module Actions
         # Delete forecasts from a job.
         # By default, forecasts are retained for 14 days. You can specify a
-        # different retention period with the +expires_in+ parameter in the forecast
+        # different retention period with the `expires_in` parameter in the forecast
         # jobs API. The delete forecast API enables you to delete one or more
         # forecasts before they expire.
         #
         # @option arguments [String] :job_id Identifier for the anomaly detection job. (*Required*)
         # @option arguments [String] :forecast_id A comma-separated list of forecast identifiers. If you do not specify
-        #  this optional parameter or if you specify +_all+ or +*+ the API deletes
+        #  this optional parameter or if you specify `_all` or `*` the API deletes
         #  all forecasts from the job.
         # @option arguments [Boolean] :allow_no_forecasts Specifies whether an error occurs when there are no forecasts. In
-        #  particular, if this parameter is set to +false+ and there are no
+        #  particular, if this parameter is set to `false` and there are no
         #  forecasts associated with the job, attempts to delete all forecasts
         #  return an error. Server default: true.
         # @option arguments [Time] :timeout Specifies the period of time to wait for the completion of the delete
         #  operation. When this period of time elapses, the API fails and returns an
         #  error. Server default: 30s.
+        # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
         # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-delete-forecast

data/lib/elasticsearch/api/actions/machine_learning/delete_job.rb CHANGED Viewed

@@ -38,6 +38,17 @@ module Elasticsearch
         #  reset.
         # @option arguments [Boolean] :wait_for_completion Specifies whether the request should return immediately or wait until the
         #  job deletion completes. Server default: true.
+        # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
         # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-delete-job

data/lib/elasticsearch/api/actions/machine_learning/delete_model_snapshot.rb CHANGED Viewed

@@ -25,10 +25,21 @@ module Elasticsearch
         # Delete a model snapshot.
         # You cannot delete the active model snapshot. To delete that snapshot, first
         # revert to a different one. To identify the active model snapshot, refer to
-        # the +model_snapshot_id+ in the results from the get jobs API.
+        # the `model_snapshot_id` in the results from the get jobs API.
         #
         # @option arguments [String] :job_id Identifier for the anomaly detection job. (*Required*)
         # @option arguments [String] :snapshot_id Identifier for the model snapshot. (*Required*)
+        # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
         # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-delete-model-snapshot
@@ -55,7 +66,7 @@ module Elasticsearch
           method = Elasticsearch::API::HTTP_DELETE
           path   = "_ml/anomaly_detectors/#{Utils.listify(_job_id)}/model_snapshots/#{Utils.listify(_snapshot_id)}"
-          params = {}
+          params = Utils.process_params(arguments)
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)

data/lib/elasticsearch/api/actions/machine_learning/delete_trained_model.rb CHANGED Viewed

@@ -28,6 +28,17 @@ module Elasticsearch
         # @option arguments [String] :model_id The unique identifier of the trained model. (*Required*)
         # @option arguments [Boolean] :force Forcefully deletes a trained model that is referenced by ingest pipelines or has a started deployment.
         # @option arguments [Time] :timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
+        # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
         # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-delete-trained-model

data/lib/elasticsearch/api/actions/machine_learning/delete_trained_model_alias.rb CHANGED Viewed

@@ -25,10 +25,21 @@ module Elasticsearch
         # Delete a trained model alias.
         # This API deletes an existing model alias that refers to a trained model. If
         # the model alias is missing or refers to a model other than the one identified
-        # by the +model_id+, this API returns an error.
+        # by the `model_id`, this API returns an error.
         #
         # @option arguments [String] :model_alias The model alias to delete. (*Required*)
         # @option arguments [String] :model_id The trained model ID to which the model alias refers. (*Required*)
+        # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
         # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-delete-trained-model-alias
@@ -55,7 +66,7 @@ module Elasticsearch
           method = Elasticsearch::API::HTTP_DELETE
           path   = "_ml/trained_models/#{Utils.listify(_model_id)}/model_aliases/#{Utils.listify(_model_alias)}"
-          params = {}
+          params = Utils.process_params(arguments)
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)

data/lib/elasticsearch/api/actions/machine_learning/estimate_model_memory.rb CHANGED Viewed

@@ -27,6 +27,17 @@ module Elasticsearch
         # The estimate is based on analysis configuration details for the job and cardinality
         # estimates for the fields it references.
         #
+        # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body request body
         #
@@ -44,7 +55,7 @@ module Elasticsearch
           method = Elasticsearch::API::HTTP_POST
           path   = '_ml/anomaly_detectors/_estimate_model_memory'
-          params = {}
+          params = Utils.process_params(arguments)
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)

data/lib/elasticsearch/api/actions/machine_learning/evaluate_data_frame.rb CHANGED Viewed

@@ -28,6 +28,17 @@ module Elasticsearch
         # created by data frame analytics. Evaluation requires both a ground truth
         # field and an analytics result field to be present.
         #
+        # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body request body
         #
@@ -45,7 +56,7 @@ module Elasticsearch
           method = Elasticsearch::API::HTTP_POST
           path   = '_ml/data_frame/_evaluate'
-          params = {}
+          params = Utils.process_params(arguments)
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)

data/lib/elasticsearch/api/actions/machine_learning/explain_data_frame_analytics.rb CHANGED Viewed

@@ -33,6 +33,17 @@ module Elasticsearch
         # @option arguments [String] :id Identifier for the data frame analytics job. This identifier can contain
         #  lowercase alphanumeric characters (a-z and 0-9), hyphens, and
         #  underscores. It must start and end with alphanumeric characters.
+        # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body request body
         #
@@ -64,7 +75,7 @@ module Elasticsearch
                    else
                      '_ml/data_frame/analytics/_explain'
                    end
-          params = {}
+          params = Utils.process_params(arguments)
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)

data/lib/elasticsearch/api/actions/machine_learning/flush_job.rb CHANGED Viewed

@@ -37,12 +37,23 @@ module Elasticsearch
         #  and the model is updated for data from the specified time interval.
         # @option arguments [Boolean] :calc_interim If true, calculates the interim results for the most recent bucket or all
         #  buckets within the latency period.
-        # @option arguments [String, Time] :end When used in conjunction with +calc_interim+ and +start+, specifies the
+        # @option arguments [String, Time] :end When used in conjunction with `calc_interim` and `start`, specifies the
         #  range of buckets on which to calculate interim results.
         # @option arguments [String, Time] :skip_time Specifies to skip to a particular time value. Results are not generated
         #  and the model is not updated for data from the specified time interval.
-        # @option arguments [String, Time] :start When used in conjunction with +calc_interim+, specifies the range of
+        # @option arguments [String, Time] :start When used in conjunction with `calc_interim`, specifies the range of
         #  buckets on which to calculate interim results.
+        # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body request body
         #

data/lib/elasticsearch/api/actions/machine_learning/forecast.rb CHANGED Viewed

@@ -25,13 +25,13 @@ module Elasticsearch
         # Predict future behavior of a time series.
         # Forecasts are not supported for jobs that perform population analysis; an
         # error occurs if you try to create a forecast for a job that has an
-        # +over_field_name+ in its configuration. Forcasts predict future behavior
+        # `over_field_name` in its configuration. Forcasts predict future behavior
         # based on historical data.
         #
         # @option arguments [String] :job_id Identifier for the anomaly detection job. The job must be open when you
         #  create a forecast; otherwise, an error occurs. (*Required*)
         # @option arguments [Time] :duration A period of time that indicates how far into the future to forecast. For
-        #  example, +30d+ corresponds to 30 days. The forecast starts at the last
+        #  example, `30d` corresponds to 30 days. The forecast starts at the last
         #  record that was processed. Server default: 1d.
         # @option arguments [Time] :expires_in The period of time that forecast results are retained. After a forecast
         #  expires, the results are deleted. If set to a value of 0, the forecast is
@@ -41,6 +41,17 @@ module Elasticsearch
         #  maximum is 500mb and minimum is 1mb. If set to 40% or more of the job’s
         #  configured memory limit, it is automatically reduced to below that
         #  amount. Server default: 20mb.
+        # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body request body
         #

data/lib/elasticsearch/api/actions/machine_learning/get_buckets.rb CHANGED Viewed

@@ -29,16 +29,27 @@ module Elasticsearch
         # @option arguments [String, Time] :timestamp The timestamp of a single bucket result. If you do not specify this
         #  parameter, the API returns information about all buckets.
         # @option arguments [Float] :anomaly_score Returns buckets with anomaly scores greater or equal than this value. Server default: 0.
-        # @option arguments [Boolean] :desc If +true+, the buckets are sorted in descending order.
-        # @option arguments [String, Time] :end Returns buckets with timestamps earlier than this time. +-1+ means it is
+        # @option arguments [Boolean] :desc If `true`, the buckets are sorted in descending order.
+        # @option arguments [String, Time] :end Returns buckets with timestamps earlier than this time. `-1` means it is
         #  unset and results are not limited to specific timestamps. Server default: -1.
-        # @option arguments [Boolean] :exclude_interim If +true+, the output excludes interim results.
+        # @option arguments [Boolean] :exclude_interim If `true`, the output excludes interim results.
         # @option arguments [Boolean] :expand If true, the output includes anomaly records.
         # @option arguments [Integer] :from Skips the specified number of buckets. Server default: 0.
         # @option arguments [Integer] :size Specifies the maximum number of buckets to obtain. Server default: 100.
         # @option arguments [String] :sort Specifies the sort field for the requested buckets. Server default: timestamp.
-        # @option arguments [String, Time] :start Returns buckets with timestamps after this time. +-1+ means it is unset
+        # @option arguments [String, Time] :start Returns buckets with timestamps after this time. `-1` means it is unset
         #  and results are not limited to specific timestamps. Server default: -1.
+        # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body request body
         #

data/lib/elasticsearch/api/actions/machine_learning/get_calendar_events.rb CHANGED Viewed

@@ -24,12 +24,23 @@ module Elasticsearch
       module Actions
         # Get info about events in calendars.
         #
-        # @option arguments [String] :calendar_id A string that uniquely identifies a calendar. You can get information for multiple calendars by using a comma-separated list of ids or a wildcard expression. You can get information for all calendars by using +_all+ or +*+ or by omitting the calendar identifier. (*Required*)
+        # @option arguments [String] :calendar_id A string that uniquely identifies a calendar. You can get information for multiple calendars by using a comma-separated list of ids or a wildcard expression. You can get information for all calendars by using `_all` or `*` or by omitting the calendar identifier. (*Required*)
         # @option arguments [String, Time] :end Specifies to get events with timestamps earlier than this time.
         # @option arguments [Integer] :from Skips the specified number of events. Server default: 0.
-        # @option arguments [String] :job_id Specifies to get events for a specific anomaly detection job identifier or job group. It must be used with a calendar identifier of +_all+ or +*+.
+        # @option arguments [String] :job_id Specifies to get events for a specific anomaly detection job identifier or job group. It must be used with a calendar identifier of `_all` or `*`.
         # @option arguments [Integer] :size Specifies the maximum number of events to obtain. Server default: 100.
         # @option arguments [String, Time] :start Specifies to get events with timestamps after this time.
+        # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
         # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-get-calendar-events

data/lib/elasticsearch/api/actions/machine_learning/get_calendars.rb CHANGED Viewed

@@ -24,9 +24,20 @@ module Elasticsearch
       module Actions
         # Get calendar configuration info.
         #
-        # @option arguments [String] :calendar_id A string that uniquely identifies a calendar. You can get information for multiple calendars by using a comma-separated list of ids or a wildcard expression. You can get information for all calendars by using +_all+ or +*+ or by omitting the calendar identifier.
+        # @option arguments [String] :calendar_id A string that uniquely identifies a calendar. You can get information for multiple calendars by using a comma-separated list of ids or a wildcard expression. You can get information for all calendars by using `_all` or `*` or by omitting the calendar identifier.
         # @option arguments [Integer] :from Skips the specified number of calendars. This parameter is supported only when you omit the calendar identifier. Server default: 0.
         # @option arguments [Integer] :size Specifies the maximum number of calendars to obtain. This parameter is supported only when you omit the calendar identifier. Server default: 10000.
+        # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body request body
         #

data/lib/elasticsearch/api/actions/machine_learning/get_categories.rb CHANGED Viewed

@@ -33,6 +33,17 @@ module Elasticsearch
         # @option arguments [Integer] :from Skips the specified number of categories. Server default: 0.
         # @option arguments [String] :partition_field_value Only return categories for the specified partition.
         # @option arguments [Integer] :size Specifies the maximum number of categories to obtain. Server default: 100.
+        # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body request body
         #

data/lib/elasticsearch/api/actions/machine_learning/get_data_frame_analytics.rb CHANGED Viewed

@@ -33,17 +33,28 @@ module Elasticsearch
         # @option arguments [Boolean] :allow_no_match Specifies what to do when the request:
         #  - Contains wildcard expressions and there are no data frame analytics
         #  jobs that match.
-        #  - Contains the +_all+ string or no identifiers and there are no matches.
+        #  - Contains the `_all` string or no identifiers and there are no matches.
         #  - Contains wildcard expressions and there are only partial matches.
         #  The default value returns an empty data_frame_analytics array when there
         #  are no matches and the subset of results when there are partial matches.
-        #  If this parameter is +false+, the request returns a 404 status code when
+        #  If this parameter is `false`, the request returns a 404 status code when
         #  there are no matches or only partial matches. Server default: true.
         # @option arguments [Integer] :from Skips the specified number of data frame analytics jobs. Server default: 0.
         # @option arguments [Integer] :size Specifies the maximum number of data frame analytics jobs to obtain. Server default: 100.
         # @option arguments [Boolean] :exclude_generated Indicates if certain fields should be removed from the configuration on
         #  retrieval. This allows the configuration to be in an acceptable format to
         #  be retrieved and then added to another cluster.
+        # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
         # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-get-data-frame-analytics

data/lib/elasticsearch/api/actions/machine_learning/get_data_frame_analytics_stats.rb CHANGED Viewed

@@ -22,7 +22,7 @@ module Elasticsearch
   module API
     module MachineLearning
       module Actions
-        # Get data frame analytics jobs usage info.
+        # Get data frame analytics job stats.
         #
         # @option arguments [String] :id Identifier for the data frame analytics job. If you do not specify this
         #  option, the API returns information for the first hundred data frame
@@ -30,15 +30,26 @@ module Elasticsearch
         # @option arguments [Boolean] :allow_no_match Specifies what to do when the request:
         #  - Contains wildcard expressions and there are no data frame analytics
         #  jobs that match.
-        #  - Contains the +_all+ string or no identifiers and there are no matches.
+        #  - Contains the `_all` string or no identifiers and there are no matches.
         #  - Contains wildcard expressions and there are only partial matches.
         #  The default value returns an empty data_frame_analytics array when there
         #  are no matches and the subset of results when there are partial matches.
-        #  If this parameter is +false+, the request returns a 404 status code when
+        #  If this parameter is `false`, the request returns a 404 status code when
         #  there are no matches or only partial matches. Server default: true.
         # @option arguments [Integer] :from Skips the specified number of data frame analytics jobs. Server default: 0.
         # @option arguments [Integer] :size Specifies the maximum number of data frame analytics jobs to obtain. Server default: 100.
         # @option arguments [Boolean] :verbose Defines whether the stats response should be verbose.
+        # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
         # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-get-data-frame-analytics-stats

data/lib/elasticsearch/api/actions/machine_learning/get_datafeed_stats.rb CHANGED Viewed

@@ -22,12 +22,12 @@ module Elasticsearch
   module API
     module MachineLearning
       module Actions
-        # Get datafeeds usage info.
+        # Get datafeed stats.
         # You can get statistics for multiple datafeeds in a single API request by
         # using a comma-separated list of datafeeds or a wildcard expression. You can
-        # get statistics for all datafeeds by using +_all+, by specifying +*+ as the
-        # +<feed_id>+, or by omitting the +<feed_id>+. If the datafeed is stopped, the
-        # only information you receive is the +datafeed_id+ and the +state+.
+        # get statistics for all datafeeds by using `_all`, by specifying `*` as the
+        # `<feed_id>`, or by omitting the `<feed_id>`. If the datafeed is stopped, the
+        # only information you receive is the `datafeed_id` and the `state`.
         # This API returns a maximum of 10,000 datafeeds.
         #
         # @option arguments [String, Array] :datafeed_id Identifier for the datafeed. It can be a datafeed identifier or a
@@ -35,12 +35,23 @@ module Elasticsearch
         #  returns information about all datafeeds.
         # @option arguments [Boolean] :allow_no_match Specifies what to do when the request:
         #  - Contains wildcard expressions and there are no datafeeds that match.
-        #  - Contains the +_all+ string or no identifiers and there are no matches.
+        #  - Contains the `_all` string or no identifiers and there are no matches.
         #  - Contains wildcard expressions and there are only partial matches.
-        #  The default value is +true+, which returns an empty +datafeeds+ array
+        #  The default value is `true`, which returns an empty `datafeeds` array
         #  when there are no matches and the subset of results when there are
-        #  partial matches. If this parameter is +false+, the request returns a
-        #  +404+ status code when there are no matches or only partial matches.
+        #  partial matches. If this parameter is `false`, the request returns a
+        #  `404` status code when there are no matches or only partial matches.
+        # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
         # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-get-datafeed-stats

data/lib/elasticsearch/api/actions/machine_learning/get_datafeeds.rb CHANGED Viewed

@@ -25,8 +25,8 @@ module Elasticsearch
         # Get datafeeds configuration info.
         # You can get information for multiple datafeeds in a single API request by
         # using a comma-separated list of datafeeds or a wildcard expression. You can
-        # get information for all datafeeds by using +_all+, by specifying +*+ as the
-        # +<feed_id>+, or by omitting the +<feed_id>+.
+        # get information for all datafeeds by using `_all`, by specifying `*` as the
+        # `<feed_id>`, or by omitting the `<feed_id>`.
         # This API returns a maximum of 10,000 datafeeds.
         #
         # @option arguments [String, Array] :datafeed_id Identifier for the datafeed. It can be a datafeed identifier or a
@@ -34,15 +34,26 @@ module Elasticsearch
         #  returns information about all datafeeds.
         # @option arguments [Boolean] :allow_no_match Specifies what to do when the request:
         #  - Contains wildcard expressions and there are no datafeeds that match.
-        #  - Contains the +_all+ string or no identifiers and there are no matches.
+        #  - Contains the `_all` string or no identifiers and there are no matches.
         #  - Contains wildcard expressions and there are only partial matches.
-        #  The default value is +true+, which returns an empty +datafeeds+ array
+        #  The default value is `true`, which returns an empty `datafeeds` array
         #  when there are no matches and the subset of results when there are
-        #  partial matches. If this parameter is +false+, the request returns a
-        #  +404+ status code when there are no matches or only partial matches.
+        #  partial matches. If this parameter is `false`, the request returns a
+        #  `404` status code when there are no matches or only partial matches.
         # @option arguments [Boolean] :exclude_generated Indicates if certain fields should be removed from the configuration on
         #  retrieval. This allows the configuration to be in an acceptable format to
         #  be retrieved and then added to another cluster.
+        # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
         # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-get-datafeeds

data/lib/elasticsearch/api/actions/machine_learning/get_filters.rb CHANGED Viewed

@@ -28,6 +28,17 @@ module Elasticsearch
         # @option arguments [String, Array] :filter_id A string that uniquely identifies a filter.
         # @option arguments [Integer] :from Skips the specified number of filters. Server default: 0.
         # @option arguments [Integer] :size Specifies the maximum number of filters to obtain. Server default: 100.
+        # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
         # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-get-filters