Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -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<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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<String>] :h A comma-separated list of columns names to display. It supports simple wildcards.
# @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
# Sorting defaults to ascending and can be changed by setting `:asc`
Expand All @@ -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<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
Expand Down
9 changes: 9 additions & 0 deletions elasticsearch-api/lib/elasticsearch/api/actions/cat/count.rb
Original file line number Diff line number Diff line change
Expand Up @@ -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<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@ module Actions
#
# @option arguments [String, Array<String>] :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<String>] :h A comma-separated list of columns names to display. It supports simple wildcards.
# @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
# Sorting defaults to ascending and can be changed by setting `:asc`
Expand All @@ -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<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
Expand Down
10 changes: 9 additions & 1 deletion elasticsearch-api/lib/elasticsearch/api/actions/cat/health.rb
Original file line number Diff line number Diff line change
Expand Up @@ -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<String>] :h A comma-separated list of columns names to display. It supports simple wildcards.
# @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
Expand All @@ -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<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
Expand Down
11 changes: 9 additions & 2 deletions elasticsearch-api/lib/elasticsearch/api/actions/cat/indices.rb
Original file line number Diff line number Diff line change
Expand Up @@ -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<String>] :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<String>] :h A comma-separated list of columns names to display. It supports simple wildcards.
# @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
Expand All @@ -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<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
Expand Down
9 changes: 9 additions & 0 deletions elasticsearch-api/lib/elasticsearch/api/actions/cat/master.rb
Original file line number Diff line number Diff line change
Expand Up @@ -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<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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<String>] :h Comma-separated list of column names to display. Server default: create_time,id,state,type.
# @option arguments [String, Array<String>] :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<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
Expand Down
Loading