diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/async_search/submit.rb b/elasticsearch-api/lib/elasticsearch/api/actions/async_search/submit.rb index 818e4470cd..c8126d24c7 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/async_search/submit.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/async_search/submit.rb @@ -51,6 +51,13 @@ module Actions # @option arguments [Boolean] :lenient Specify whether format-based query failures (such as providing text to a numeric field) should be ignored # @option arguments [Integer] :max_concurrent_shard_requests The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random) + # @option arguments [String] :project_routing Specifies a subset of projects to target for a search using project metadata + # tags in a subset Lucene syntax. Allowed Lucene queries: the _alias tag + # and a single value (possible wildcarded). Examples: + # _alias:my-project + # _alias:_origin + # _alias:*pr* + # Supported in serverless only. # @option arguments [Boolean] :request_cache Specify if request cache should be used for this request or not, defaults to true Server default: true. # @option arguments [String] :routing A comma-separated list of specific routing values # @option arguments [String] :search_type Search operation type diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/aliases.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/aliases.rb index 952f8190d7..4e704ea7d3 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/aliases.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/aliases.rb @@ -43,6 +43,15 @@ module Actions # @option arguments [Boolean] :help When set to `true` will output available columns. This option # can't be combined with any other query string option. # @option arguments [Boolean] :v When set to `true` will enable verbose output. + # @option arguments [String] :bytes Sets the units for columns that contain a byte-size value. + # Note that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes. + # If omitted, byte-size values are rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`. + # If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit. + # Values that are not an exact multiple of the chosen unit are rounded down. + # @option arguments [String] :time Sets the units for columns that contain a time duration. + # If omitted, time duration values are rendered with a suffix such as `ms`, `s`, `m` or `h`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`. + # If given, time duration values are rendered as an integer with no suffix. + # Values that are not an exact multiple of the chosen unit are rounded down. # @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] :filter_path Comma-separated list of filters in dot notation which reduce the response diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/allocation.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/allocation.rb index 3094858f1e..f6d0fea87b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/allocation.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/allocation.rb @@ -27,7 +27,6 @@ module Actions # IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. # # @option arguments [String, Array] :node_id A comma-separated list of node identifiers or names used to limit the returned information. - # @option arguments [String] :bytes The unit used to display byte values. # @option arguments [String, Array] :h A comma-separated list of columns names to display. It supports simple wildcards. # @option arguments [String, Array] :s List of columns that determine how the table should be sorted. # Sorting defaults to ascending and can be changed by setting `:asc` @@ -42,6 +41,15 @@ module Actions # @option arguments [Boolean] :help When set to `true` will output available columns. This option # can't be combined with any other query string option. # @option arguments [Boolean] :v When set to `true` will enable verbose output. + # @option arguments [String] :bytes Sets the units for columns that contain a byte-size value. + # Note that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes. + # If omitted, byte-size values are rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`. + # If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit. + # Values that are not an exact multiple of the chosen unit are rounded down. + # @option arguments [String] :time Sets the units for columns that contain a time duration. + # If omitted, time duration values are rendered with a suffix such as `ms`, `s`, `m` or `h`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`. + # If given, time duration values are rendered as an integer with no suffix. + # Values that are not an exact multiple of the chosen unit are rounded down. # @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] :filter_path Comma-separated list of filters in dot notation which reduce the response diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/component_templates.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/component_templates.rb index e9386e2dc1..9632145e5e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/component_templates.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/component_templates.rb @@ -45,6 +45,15 @@ module Actions # @option arguments [Boolean] :help When set to `true` will output available columns. This option # can't be combined with any other query string option. # @option arguments [Boolean] :v When set to `true` will enable verbose output. + # @option arguments [String] :bytes Sets the units for columns that contain a byte-size value. + # Note that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes. + # If omitted, byte-size values are rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`. + # If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit. + # Values that are not an exact multiple of the chosen unit are rounded down. + # @option arguments [String] :time Sets the units for columns that contain a time duration. + # If omitted, time duration values are rendered with a suffix such as `ms`, `s`, `m` or `h`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`. + # If given, time duration values are rendered as an integer with no suffix. + # Values that are not an exact multiple of the chosen unit are rounded down. # @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] :filter_path Comma-separated list of filters in dot notation which reduce the response diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/count.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/count.rb index bd5ab98e08..11529813bb 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/count.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/count.rb @@ -40,6 +40,15 @@ module Actions # @option arguments [Boolean] :help When set to `true` will output available columns. This option # can't be combined with any other query string option. # @option arguments [Boolean] :v When set to `true` will enable verbose output. + # @option arguments [String] :bytes Sets the units for columns that contain a byte-size value. + # Note that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes. + # If omitted, byte-size values are rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`. + # If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit. + # Values that are not an exact multiple of the chosen unit are rounded down. + # @option arguments [String] :time Sets the units for columns that contain a time duration. + # If omitted, time duration values are rendered with a suffix such as `ms`, `s`, `m` or `h`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`. + # If given, time duration values are rendered as an integer with no suffix. + # Values that are not an exact multiple of the chosen unit are rounded down. # @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] :filter_path Comma-separated list of filters in dot notation which reduce the response diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/fielddata.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/fielddata.rb index 85d743dd7d..1ee0f6e424 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/fielddata.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/fielddata.rb @@ -29,7 +29,6 @@ module Actions # # @option arguments [String, Array] :fields Comma-separated list of fields used to limit returned information. # To retrieve all fields, omit this parameter. - # @option arguments [String] :bytes The unit used to display byte values. # @option arguments [String, Array] :h A comma-separated list of columns names to display. It supports simple wildcards. # @option arguments [String, Array] :s List of columns that determine how the table should be sorted. # Sorting defaults to ascending and can be changed by setting `:asc` @@ -39,6 +38,15 @@ module Actions # @option arguments [Boolean] :help When set to `true` will output available columns. This option # can't be combined with any other query string option. # @option arguments [Boolean] :v When set to `true` will enable verbose output. + # @option arguments [String] :bytes Sets the units for columns that contain a byte-size value. + # Note that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes. + # If omitted, byte-size values are rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`. + # If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit. + # Values that are not an exact multiple of the chosen unit are rounded down. + # @option arguments [String] :time Sets the units for columns that contain a time duration. + # If omitted, time duration values are rendered with a suffix such as `ms`, `s`, `m` or `h`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`. + # If given, time duration values are rendered as an integer with no suffix. + # Values that are not an exact multiple of the chosen unit are rounded down. # @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] :filter_path Comma-separated list of filters in dot notation which reduce the response diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/health.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/health.rb index cb1f606f61..f5a3d42bd3 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/health.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/health.rb @@ -33,7 +33,6 @@ module Actions # You can use the cat health API to verify cluster health across multiple nodes. # You also can use the API to track the recovery of a large cluster over a longer period of time. # - # @option arguments [String] :time The unit used to display time values. # @option arguments [Boolean] :ts If true, returns `HH:MM:SS` and Unix epoch timestamps. Server default: true. # @option arguments [String, Array] :h A comma-separated list of columns names to display. It supports simple wildcards. # @option arguments [String, Array] :s List of columns that determine how the table should be sorted. @@ -44,6 +43,15 @@ module Actions # @option arguments [Boolean] :help When set to `true` will output available columns. This option # can't be combined with any other query string option. # @option arguments [Boolean] :v When set to `true` will enable verbose output. + # @option arguments [String] :bytes Sets the units for columns that contain a byte-size value. + # Note that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes. + # If omitted, byte-size values are rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`. + # If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit. + # Values that are not an exact multiple of the chosen unit are rounded down. + # @option arguments [String] :time Sets the units for columns that contain a time duration. + # If omitted, time duration values are rendered with a suffix such as `ms`, `s`, `m` or `h`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`. + # If given, time duration values are rendered as an integer with no suffix. + # Values that are not an exact multiple of the chosen unit are rounded down. # @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] :filter_path Comma-separated list of filters in dot notation which reduce the response diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/indices.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/indices.rb index 5ab9363bd7..c2da534a04 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/indices.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/indices.rb @@ -37,12 +37,10 @@ module Actions # # @option arguments [String, Array] :index Comma-separated list of data streams, indices, and aliases used to limit the request. # Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. - # @option arguments [String] :bytes The unit used to display byte values. # @option arguments [String, Array] :expand_wildcards The type of index that wildcard patterns can match. # @option arguments [String] :health The health status used to limit returned indices. By default, the response includes indices of any health status. # @option arguments [Boolean] :include_unloaded_segments If true, the response includes information from segments that are not loaded into memory. # @option arguments [Boolean] :pri If true, the response only includes information from primary shards. - # @option arguments [String] :time The unit used to display time values. # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s. # @option arguments [String, Array] :h A comma-separated list of columns names to display. It supports simple wildcards. # @option arguments [String, Array] :s List of columns that determine how the table should be sorted. @@ -53,6 +51,15 @@ module Actions # @option arguments [Boolean] :help When set to `true` will output available columns. This option # can't be combined with any other query string option. # @option arguments [Boolean] :v When set to `true` will enable verbose output. + # @option arguments [String] :bytes Sets the units for columns that contain a byte-size value. + # Note that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes. + # If omitted, byte-size values are rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`. + # If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit. + # Values that are not an exact multiple of the chosen unit are rounded down. + # @option arguments [String] :time Sets the units for columns that contain a time duration. + # If omitted, time duration values are rendered with a suffix such as `ms`, `s`, `m` or `h`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`. + # If given, time duration values are rendered as an integer with no suffix. + # Values that are not an exact multiple of the chosen unit are rounded down. # @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] :filter_path Comma-separated list of filters in dot notation which reduce the response diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/master.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/master.rb index 13b6fff2d3..81453ff23d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/master.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/master.rb @@ -40,6 +40,15 @@ module Actions # @option arguments [Boolean] :help When set to `true` will output available columns. This option # can't be combined with any other query string option. # @option arguments [Boolean] :v When set to `true` will enable verbose output. + # @option arguments [String] :bytes Sets the units for columns that contain a byte-size value. + # Note that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes. + # If omitted, byte-size values are rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`. + # If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit. + # Values that are not an exact multiple of the chosen unit are rounded down. + # @option arguments [String] :time Sets the units for columns that contain a time duration. + # If omitted, time duration values are rendered with a suffix such as `ms`, `s`, `m` or `h`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`. + # If given, time duration values are rendered as an integer with no suffix. + # Values that are not an exact multiple of the chosen unit are rounded down. # @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] :filter_path Comma-separated list of filters in dot notation which reduce the response diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_data_frame_analytics.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_data_frame_analytics.rb index 128bb733f5..bf7a3fa08b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_data_frame_analytics.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_data_frame_analytics.rb @@ -30,16 +30,23 @@ module Actions # # @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 configs. (This includes `_all` string or when no configs have been specified) - # @option arguments [String] :bytes The unit in which to display byte values # @option arguments [String, Array] :h Comma-separated list of column names to display. Server default: create_time,id,state,type. # @option arguments [String, Array] :s Comma-separated list of column names or column aliases used to sort the # response. - # @option arguments [String] :time Unit used to display time values. # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to # `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text. # @option arguments [Boolean] :help When set to `true` will output available columns. This option # can't be combined with any other query string option. # @option arguments [Boolean] :v When set to `true` will enable verbose output. + # @option arguments [String] :bytes Sets the units for columns that contain a byte-size value. + # Note that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes. + # If omitted, byte-size values are rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`. + # If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit. + # Values that are not an exact multiple of the chosen unit are rounded down. + # @option arguments [String] :time Sets the units for columns that contain a time duration. + # If omitted, time duration values are rendered with a suffix such as `ms`, `s`, `m` or `h`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`. + # If given, time duration values are rendered as an integer with no suffix. + # Values that are not an exact multiple of the chosen unit are rounded down. # @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] :filter_path Comma-separated list of filters in dot notation which reduce the response diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_datafeeds.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_datafeeds.rb index 0784babd32..28a3ebd246 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_datafeeds.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_datafeeds.rb @@ -41,12 +41,20 @@ module Actions # partial matches. Server default: true. # @option arguments [String, Array] :h Comma-separated list of column names to display. Server default: ['bc', 'id', 'sc', 's']. # @option arguments [String, Array] :s Comma-separated list of column names or column aliases used to sort the response. - # @option arguments [String] :time The unit used to display time values. # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to # `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text. # @option arguments [Boolean] :help When set to `true` will output available columns. This option # can't be combined with any other query string option. # @option arguments [Boolean] :v When set to `true` will enable verbose output. + # @option arguments [String] :bytes Sets the units for columns that contain a byte-size value. + # Note that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes. + # If omitted, byte-size values are rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`. + # If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit. + # Values that are not an exact multiple of the chosen unit are rounded down. + # @option arguments [String] :time Sets the units for columns that contain a time duration. + # If omitted, time duration values are rendered with a suffix such as `ms`, `s`, `m` or `h`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`. + # If given, time duration values are rendered as an integer with no suffix. + # Values that are not an exact multiple of the chosen unit are rounded down. # @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] :filter_path Comma-separated list of filters in dot notation which reduce the response diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_jobs.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_jobs.rb index d662ab78e3..5718276465 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_jobs.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_jobs.rb @@ -39,15 +39,22 @@ module Actions # If `true`, the API returns an empty jobs array when there are no matches and the subset of results when there # are partial matches. If `false`, the API returns a 404 status code when there are no matches or only partial # matches. Server default: true. - # @option arguments [String] :bytes The unit used to display byte values. # @option arguments [String, Array] :h Comma-separated list of column names to display. Server default: buckets.count,data.processed_records,forecasts.total,id,model.bytes,model.memory_status,state. # @option arguments [String, Array] :s Comma-separated list of column names or column aliases used to sort the response. - # @option arguments [String] :time The unit used to display time values. # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to # `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text. # @option arguments [Boolean] :help When set to `true` will output available columns. This option # can't be combined with any other query string option. # @option arguments [Boolean] :v When set to `true` will enable verbose output. + # @option arguments [String] :bytes Sets the units for columns that contain a byte-size value. + # Note that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes. + # If omitted, byte-size values are rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`. + # If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit. + # Values that are not an exact multiple of the chosen unit are rounded down. + # @option arguments [String] :time Sets the units for columns that contain a time duration. + # If omitted, time duration values are rendered with a suffix such as `ms`, `s`, `m` or `h`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`. + # If given, time duration values are rendered as an integer with no suffix. + # Values that are not an exact multiple of the chosen unit are rounded down. # @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] :filter_path Comma-separated list of filters in dot notation which reduce the response diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_trained_models.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_trained_models.rb index 3bce7e63f1..12e9aabdd8 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_trained_models.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_trained_models.rb @@ -32,17 +32,24 @@ module Actions # @option arguments [Boolean] :allow_no_match Specifies what to do when the request: contains wildcard expressions and there are no models that match; contains the `_all` string or no identifiers and there are no matches; contains wildcard expressions and there are only partial matches. # If `true`, the API returns an empty array when there are no matches and the subset of results when there are partial matches. # If `false`, the API returns a 404 status code when there are no matches or only partial matches. Server default: true. - # @option arguments [String] :bytes The unit used to display byte values. # @option arguments [String, Array] :h A comma-separated list of column names to display. # @option arguments [String, Array] :s A comma-separated list of column names or aliases used to sort the response. # @option arguments [Integer] :from Skips the specified number of transforms. # @option arguments [Integer] :size The maximum number of transforms to display. - # @option arguments [String] :time Unit used to display time values. # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to # `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text. # @option arguments [Boolean] :help When set to `true` will output available columns. This option # can't be combined with any other query string option. # @option arguments [Boolean] :v When set to `true` will enable verbose output. + # @option arguments [String] :bytes Sets the units for columns that contain a byte-size value. + # Note that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes. + # If omitted, byte-size values are rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`. + # If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit. + # Values that are not an exact multiple of the chosen unit are rounded down. + # @option arguments [String] :time Sets the units for columns that contain a time duration. + # If omitted, time duration values are rendered with a suffix such as `ms`, `s`, `m` or `h`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`. + # If given, time duration values are rendered as an integer with no suffix. + # Values that are not an exact multiple of the chosen unit are rounded down. # @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] :filter_path Comma-separated list of filters in dot notation which reduce the response diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/nodeattrs.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/nodeattrs.rb index 499611b149..2385fe494c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/nodeattrs.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/nodeattrs.rb @@ -40,6 +40,15 @@ module Actions # @option arguments [Boolean] :help When set to `true` will output available columns. This option # can't be combined with any other query string option. # @option arguments [Boolean] :v When set to `true` will enable verbose output. + # @option arguments [String] :bytes Sets the units for columns that contain a byte-size value. + # Note that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes. + # If omitted, byte-size values are rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`. + # If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit. + # Values that are not an exact multiple of the chosen unit are rounded down. + # @option arguments [String] :time Sets the units for columns that contain a time duration. + # If omitted, time duration values are rendered with a suffix such as `ms`, `s`, `m` or `h`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`. + # If given, time duration values are rendered as an integer with no suffix. + # Values that are not an exact multiple of the chosen unit are rounded down. # @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] :filter_path Comma-separated list of filters in dot notation which reduce the response diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/nodes.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/nodes.rb index e2faefd3a1..6ec1a366a8 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/nodes.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/nodes.rb @@ -26,7 +26,6 @@ module Actions # Get information about the nodes in a cluster. # IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API. # - # @option arguments [String] :bytes The unit used to display byte values. # @option arguments [Boolean, String] :full_id If `true`, return the full node ID. If `false`, return the shortened node ID. Server default: false. # @option arguments [Boolean] :include_unloaded_segments If true, the response includes information from segments that are not loaded into memory. # @option arguments [String, Array] :h A comma-separated list of columns names to display. @@ -35,12 +34,20 @@ module Actions # Sorting defaults to ascending and can be changed by setting `:asc` # or `:desc` as a suffix to the column name. # @option arguments [Time] :master_timeout The period to wait for a connection to the master node. Server default: 30s. - # @option arguments [String] :time The unit used to display time values. # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to # `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text. # @option arguments [Boolean] :help When set to `true` will output available columns. This option # can't be combined with any other query string option. # @option arguments [Boolean] :v When set to `true` will enable verbose output. + # @option arguments [String] :bytes Sets the units for columns that contain a byte-size value. + # Note that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes. + # If omitted, byte-size values are rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`. + # If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit. + # Values that are not an exact multiple of the chosen unit are rounded down. + # @option arguments [String] :time Sets the units for columns that contain a time duration. + # If omitted, time duration values are rendered with a suffix such as `ms`, `s`, `m` or `h`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`. + # If given, time duration values are rendered as an integer with no suffix. + # Values that are not an exact multiple of the chosen unit are rounded down. # @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] :filter_path Comma-separated list of filters in dot notation which reduce the response diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/pending_tasks.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/pending_tasks.rb index 31df5a32dc..6049943792 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/pending_tasks.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/pending_tasks.rb @@ -35,12 +35,20 @@ module Actions # from the cluster state of the master node. In both cases the coordinating # node will send requests for further information to each selected node. # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s. - # @option arguments [String] :time Unit used to display time values. # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to # `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text. # @option arguments [Boolean] :help When set to `true` will output available columns. This option # can't be combined with any other query string option. # @option arguments [Boolean] :v When set to `true` will enable verbose output. + # @option arguments [String] :bytes Sets the units for columns that contain a byte-size value. + # Note that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes. + # If omitted, byte-size values are rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`. + # If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit. + # Values that are not an exact multiple of the chosen unit are rounded down. + # @option arguments [String] :time Sets the units for columns that contain a time duration. + # If omitted, time duration values are rendered with a suffix such as `ms`, `s`, `m` or `h`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`. + # If given, time duration values are rendered as an integer with no suffix. + # Values that are not an exact multiple of the chosen unit are rounded down. # @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] :filter_path Comma-separated list of filters in dot notation which reduce the response diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/plugins.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/plugins.rb index 375243a45f..bc34c2fb4f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/plugins.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/plugins.rb @@ -41,6 +41,15 @@ module Actions # @option arguments [Boolean] :help When set to `true` will output available columns. This option # can't be combined with any other query string option. # @option arguments [Boolean] :v When set to `true` will enable verbose output. + # @option arguments [String] :bytes Sets the units for columns that contain a byte-size value. + # Note that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes. + # If omitted, byte-size values are rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`. + # If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit. + # Values that are not an exact multiple of the chosen unit are rounded down. + # @option arguments [String] :time Sets the units for columns that contain a time duration. + # If omitted, time duration values are rendered with a suffix such as `ms`, `s`, `m` or `h`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`. + # If given, time duration values are rendered as an integer with no suffix. + # Values that are not an exact multiple of the chosen unit are rounded down. # @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] :filter_path Comma-separated list of filters in dot notation which reduce the response diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/recovery.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/recovery.rb index fff0d8e372..f48e3375cd 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/recovery.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/recovery.rb @@ -31,19 +31,26 @@ module Actions # @option arguments [String, Array] :index A comma-separated list of data streams, indices, and aliases used to limit the request. # Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. # @option arguments [Boolean] :active_only If `true`, the response only includes ongoing shard recoveries. - # @option arguments [String] :bytes The unit used to display byte values. # @option arguments [Boolean] :detailed If `true`, the response includes detailed information about shard recoveries. # @option arguments [String, Array] :h A comma-separated list of columns names to display. # It supports simple wildcards. Server default: ip,hp,rp,r,m,n,cpu,l. # @option arguments [String, Array] :s A comma-separated list of column names or aliases that determines the sort order. # Sorting defaults to ascending and can be changed by setting `:asc` # or `:desc` as a suffix to the column name. - # @option arguments [String] :time The unit used to display time values. # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to # `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text. # @option arguments [Boolean] :help When set to `true` will output available columns. This option # can't be combined with any other query string option. # @option arguments [Boolean] :v When set to `true` will enable verbose output. + # @option arguments [String] :bytes Sets the units for columns that contain a byte-size value. + # Note that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes. + # If omitted, byte-size values are rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`. + # If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit. + # Values that are not an exact multiple of the chosen unit are rounded down. + # @option arguments [String] :time Sets the units for columns that contain a time duration. + # If omitted, time duration values are rendered with a suffix such as `ms`, `s`, `m` or `h`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`. + # If given, time duration values are rendered as an integer with no suffix. + # Values that are not an exact multiple of the chosen unit are rounded down. # @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] :filter_path Comma-separated list of filters in dot notation which reduce the response diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/repositories.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/repositories.rb index 99166828fb..41226355be 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/repositories.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/repositories.rb @@ -40,6 +40,15 @@ module Actions # @option arguments [Boolean] :help When set to `true` will output available columns. This option # can't be combined with any other query string option. # @option arguments [Boolean] :v When set to `true` will enable verbose output. + # @option arguments [String] :bytes Sets the units for columns that contain a byte-size value. + # Note that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes. + # If omitted, byte-size values are rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`. + # If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit. + # Values that are not an exact multiple of the chosen unit are rounded down. + # @option arguments [String] :time Sets the units for columns that contain a time duration. + # If omitted, time duration values are rendered with a suffix such as `ms`, `s`, `m` or `h`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`. + # If given, time duration values are rendered as an integer with no suffix. + # Values that are not an exact multiple of the chosen unit are rounded down. # @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] :filter_path Comma-separated list of filters in dot notation which reduce the response diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/segments.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/segments.rb index 73210c272b..e1d33519e0 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/segments.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/segments.rb @@ -30,7 +30,6 @@ module Actions # @option arguments [String, Array] :index A comma-separated list of data streams, indices, and aliases used to limit the request. # Supports wildcards (`*`). # To target all data streams and indices, omit this parameter or use `*` or `_all`. - # @option arguments [String] :bytes The unit used to display byte values. # @option arguments [String, Array] :h A comma-separated list of columns names to display. # It supports simple wildcards. Server default: ip,hp,rp,r,m,n,cpu,l. # @option arguments [String, Array] :s A comma-separated list of column names or aliases that determines the sort order. @@ -46,6 +45,15 @@ module Actions # @option arguments [Boolean] :help When set to `true` will output available columns. This option # can't be combined with any other query string option. # @option arguments [Boolean] :v When set to `true` will enable verbose output. + # @option arguments [String] :bytes Sets the units for columns that contain a byte-size value. + # Note that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes. + # If omitted, byte-size values are rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`. + # If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit. + # Values that are not an exact multiple of the chosen unit are rounded down. + # @option arguments [String] :time Sets the units for columns that contain a time duration. + # If omitted, time duration values are rendered with a suffix such as `ms`, `s`, `m` or `h`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`. + # If given, time duration values are rendered as an integer with no suffix. + # Values that are not an exact multiple of the chosen unit are rounded down. # @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] :filter_path Comma-separated list of filters in dot notation which reduce the response diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/shards.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/shards.rb index c040372628..9fc8fa7e70 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/shards.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/shards.rb @@ -30,18 +30,25 @@ module Actions # @option arguments [String, Array] :index A comma-separated list of data streams, indices, and aliases used to limit the request. # Supports wildcards (`*`). # To target all data streams and indices, omit this parameter or use `*` or `_all`. - # @option arguments [String] :bytes The unit used to display byte values. # @option arguments [String, Array] :h List of columns to appear in the response. Supports simple wildcards. # @option arguments [String, Array] :s A comma-separated list of column names or aliases that determines the sort order. # Sorting defaults to ascending and can be changed by setting `:asc` # or `:desc` as a suffix to the column name. # @option arguments [Time] :master_timeout The period to wait for a connection to the master node. Server default: 30s. - # @option arguments [String] :time The unit used to display time values. # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to # `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text. # @option arguments [Boolean] :help When set to `true` will output available columns. This option # can't be combined with any other query string option. # @option arguments [Boolean] :v When set to `true` will enable verbose output. + # @option arguments [String] :bytes Sets the units for columns that contain a byte-size value. + # Note that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes. + # If omitted, byte-size values are rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`. + # If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit. + # Values that are not an exact multiple of the chosen unit are rounded down. + # @option arguments [String] :time Sets the units for columns that contain a time duration. + # If omitted, time duration values are rendered with a suffix such as `ms`, `s`, `m` or `h`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`. + # If given, time duration values are rendered as an integer with no suffix. + # Values that are not an exact multiple of the chosen unit are rounded down. # @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] :filter_path Comma-separated list of filters in dot notation which reduce the response diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/snapshots.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/snapshots.rb index 819d85ea77..076d7c1e5c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/snapshots.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/snapshots.rb @@ -38,12 +38,20 @@ module Actions # Sorting defaults to ascending and can be changed by setting `:asc` # or `:desc` as a suffix to the column name. # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s. - # @option arguments [String] :time Unit used to display time values. # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to # `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text. # @option arguments [Boolean] :help When set to `true` will output available columns. This option # can't be combined with any other query string option. # @option arguments [Boolean] :v When set to `true` will enable verbose output. + # @option arguments [String] :bytes Sets the units for columns that contain a byte-size value. + # Note that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes. + # If omitted, byte-size values are rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`. + # If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit. + # Values that are not an exact multiple of the chosen unit are rounded down. + # @option arguments [String] :time Sets the units for columns that contain a time duration. + # If omitted, time duration values are rendered with a suffix such as `ms`, `s`, `m` or `h`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`. + # If given, time duration values are rendered as an integer with no suffix. + # Values that are not an exact multiple of the chosen unit are rounded down. # @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] :filter_path Comma-separated list of filters in dot notation which reduce the response diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/tasks.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/tasks.rb index 84bde32003..3606817691 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/tasks.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/tasks.rb @@ -38,7 +38,6 @@ module Actions # @option arguments [String, Array] :s List of columns that determine how the table should be sorted. # Sorting defaults to ascending and can be changed by setting `:asc` # or `:desc` as a suffix to the column name. - # @option arguments [String] :time Unit used to display time values. # @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] :wait_for_completion If `true`, the request blocks until the task has completed. @@ -47,6 +46,15 @@ module Actions # @option arguments [Boolean] :help When set to `true` will output available columns. This option # can't be combined with any other query string option. # @option arguments [Boolean] :v When set to `true` will enable verbose output. + # @option arguments [String] :bytes Sets the units for columns that contain a byte-size value. + # Note that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes. + # If omitted, byte-size values are rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`. + # If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit. + # Values that are not an exact multiple of the chosen unit are rounded down. + # @option arguments [String] :time Sets the units for columns that contain a time duration. + # If omitted, time duration values are rendered with a suffix such as `ms`, `s`, `m` or `h`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`. + # If given, time duration values are rendered as an integer with no suffix. + # Values that are not an exact multiple of the chosen unit are rounded down. # @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] :filter_path Comma-separated list of filters in dot notation which reduce the response diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/templates.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/templates.rb index 653dde5968..6e490342bd 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/templates.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/templates.rb @@ -43,6 +43,15 @@ module Actions # @option arguments [Boolean] :help When set to `true` will output available columns. This option # can't be combined with any other query string option. # @option arguments [Boolean] :v When set to `true` will enable verbose output. + # @option arguments [String] :bytes Sets the units for columns that contain a byte-size value. + # Note that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes. + # If omitted, byte-size values are rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`. + # If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit. + # Values that are not an exact multiple of the chosen unit are rounded down. + # @option arguments [String] :time Sets the units for columns that contain a time duration. + # If omitted, time duration values are rendered with a suffix such as `ms`, `s`, `m` or `h`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`. + # If given, time duration values are rendered as an integer with no suffix. + # Values that are not an exact multiple of the chosen unit are rounded down. # @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] :filter_path Comma-separated list of filters in dot notation which reduce the response diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/thread_pool.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/thread_pool.rb index fd934c3c34..491c092e64 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/thread_pool.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/thread_pool.rb @@ -33,7 +33,6 @@ module Actions # @option arguments [String, Array] :s A comma-separated list of column names or aliases that determines the sort order. # Sorting defaults to ascending and can be changed by setting `:asc` # or `:desc` as a suffix to the column name. - # @option arguments [String] :time The unit used to display time values. # @option arguments [Boolean] :local If `true`, the request computes the list of selected nodes from the # local cluster state. If `false` the list of selected nodes are computed # from the cluster state of the master node. In both cases the coordinating @@ -44,6 +43,15 @@ module Actions # @option arguments [Boolean] :help When set to `true` will output available columns. This option # can't be combined with any other query string option. # @option arguments [Boolean] :v When set to `true` will enable verbose output. + # @option arguments [String] :bytes Sets the units for columns that contain a byte-size value. + # Note that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes. + # If omitted, byte-size values are rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`. + # If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit. + # Values that are not an exact multiple of the chosen unit are rounded down. + # @option arguments [String] :time Sets the units for columns that contain a time duration. + # If omitted, time duration values are rendered with a suffix such as `ms`, `s`, `m` or `h`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`. + # If given, time duration values are rendered as an integer with no suffix. + # Values that are not an exact multiple of the chosen unit are rounded down. # @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] :filter_path Comma-separated list of filters in dot notation which reduce the response diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/transforms.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/transforms.rb index 44f17c0104..097ea7d6e8 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/transforms.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/transforms.rb @@ -36,13 +36,21 @@ module Actions # @option arguments [Integer] :from Skips the specified number of transforms. Server default: 0. # @option arguments [String, Array] :h Comma-separated list of column names to display. Server default: changes_last_detection_time,checkpoint,checkpoint_progress,documents_processed,id,last_search_time,state. # @option arguments [String, Array] :s Comma-separated list of column names or column aliases used to sort the response. - # @option arguments [String] :time The unit used to display time values. # @option arguments [Integer] :size The maximum number of transforms to obtain. Server default: 100. # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to # `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text. # @option arguments [Boolean] :help When set to `true` will output available columns. This option # can't be combined with any other query string option. # @option arguments [Boolean] :v When set to `true` will enable verbose output. + # @option arguments [String] :bytes Sets the units for columns that contain a byte-size value. + # Note that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes. + # If omitted, byte-size values are rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`. + # If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit. + # Values that are not an exact multiple of the chosen unit are rounded down. + # @option arguments [String] :time Sets the units for columns that contain a time duration. + # If omitted, time duration values are rendered with a suffix such as `ms`, `s`, `m` or `h`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`. + # If given, time duration values are rendered as an integer with no suffix. + # Values that are not an exact multiple of the chosen unit are rounded down. # @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] :filter_path Comma-separated list of filters in dot notation which reduce the response diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/search.rb b/elasticsearch-api/lib/elasticsearch/api/actions/search.rb index eec96bb2ea..5c4b1fdf71 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/search.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/search.rb @@ -84,6 +84,13 @@ module Actions # - The request targets more than 128 shards. # - The request targets one or more read-only index. # - The primary sort of the query targets an indexed field. + # @option arguments [String] :project_routing Specifies a subset of projects to target for a search using project metadata + # tags in a subset Lucene syntax. Allowed Lucene queries: the _alias tag + # and a single value (possible wildcarded). Examples: + # _alias:my-project + # _alias:_origin + # _alias:*pr* + # Supported in serverless only. # @option arguments [Boolean] :request_cache If `true`, the caching of search results is enabled for requests where `size` is `0`. # It defaults to index level settings. # @option arguments [String] :routing A custom value that is used to route operations to a specific shard. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/streams/logs_disable.rb b/elasticsearch-api/lib/elasticsearch/api/actions/streams/logs_disable.rb index 6c1d312257..2166137c4a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/streams/logs_disable.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/streams/logs_disable.rb @@ -22,11 +22,31 @@ module Elasticsearch module API module Streams module Actions - # Disable the Logs Streams feature for this cluster + # Disable logs stream + # This disables the logs stream feature for this cluster. + # 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 [Time] :master_timeout The period to wait for a connection to the master node. + # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. + # @option arguments [Time] :timeout The 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] :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 + # `"exists_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/guide/en/elasticsearch/reference/master/streams-logs-disable.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch#TODO # def logs_disable(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'streams.logs_disable' } @@ -38,7 +58,7 @@ def logs_disable(arguments = {}) method = Elasticsearch::API::HTTP_POST path = '_streams/logs/_disable' - params = {} + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/streams/logs_enable.rb b/elasticsearch-api/lib/elasticsearch/api/actions/streams/logs_enable.rb index b5863eb80d..8fe9cb8872 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/streams/logs_enable.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/streams/logs_enable.rb @@ -22,11 +22,34 @@ module Elasticsearch module API module Streams module Actions - # Enable the Logs Streams feature for this cluster + # Enable logs stream + # This enables the logs stream feature for this cluster. + # Note: To protect existing data, this feature can only be enabled on a cluster if + # it does not have existing indices or data streams matching the pattern `logs|logs.*`. + # If this is the case, a `409 - Conflict` response and error will be returned. + # 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 [Time] :master_timeout The period to wait for a connection to the master node. + # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. + # @option arguments [Time] :timeout The 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] :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 + # `"exists_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/guide/en/elasticsearch/reference/master/streams-logs-enable.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch#TODO # def logs_enable(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'streams.logs_enable' } @@ -38,7 +61,7 @@ def logs_enable(arguments = {}) method = Elasticsearch::API::HTTP_POST path = '_streams/logs/_enable' - params = {} + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/streams/status.rb b/elasticsearch-api/lib/elasticsearch/api/actions/streams/status.rb index 45f8d28c12..60b69d08af 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/streams/status.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/streams/status.rb @@ -22,11 +22,28 @@ module Elasticsearch module API module Streams module Actions - # Return the current status of the streams feature for each streams type + # Get the status of streams + # Gets the current status of all stream types + # 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] :master_timeout Period to wait for a connection to the master node. 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] :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 + # `"exists_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/guide/en/elasticsearch/reference/master/streams-status.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch#TODO # def status(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'streams.status' } @@ -38,7 +55,7 @@ def status(arguments = {}) method = Elasticsearch::API::HTTP_GET path = '_streams/status' - params = {} + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/put_watch.rb b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/put_watch.rb index c252173e11..3b5e92e7ec 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/put_watch.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/put_watch.rb @@ -62,6 +62,7 @@ def put_watch(arguments = {}) end request_opts[:defined_params] = defined_params unless defined_params.empty? + raise ArgumentError, "Required argument 'body' missing" unless arguments[:body] raise ArgumentError, "Required argument 'id' missing" unless arguments[:id] arguments = arguments.clone diff --git a/elasticsearch-api/lib/elasticsearch/api/version.rb b/elasticsearch-api/lib/elasticsearch/api/version.rb index 6f86aff4f4..b7fc422b62 100644 --- a/elasticsearch-api/lib/elasticsearch/api/version.rb +++ b/elasticsearch-api/lib/elasticsearch/api/version.rb @@ -18,6 +18,6 @@ module Elasticsearch module API VERSION = '9.2.0'.freeze - ES_SPECIFICATION_COMMIT = 'a4676aabf1b13839ec5bef82f775aad25dbdec22'.freeze + ES_SPECIFICATION_COMMIT = 'e22c10134264a91aca0f736153460a3e988c27b5'.freeze end end