elasticsearch-api 9.1.2 → 9.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/elasticsearch/api/actions/async_search/submit.rb +12 -4
- data/lib/elasticsearch/api/actions/cat/aliases.rb +9 -0
- data/lib/elasticsearch/api/actions/cat/allocation.rb +9 -1
- data/lib/elasticsearch/api/actions/cat/component_templates.rb +9 -0
- data/lib/elasticsearch/api/actions/cat/count.rb +17 -0
- data/lib/elasticsearch/api/actions/cat/fielddata.rb +9 -1
- data/lib/elasticsearch/api/actions/cat/health.rb +10 -2
- data/lib/elasticsearch/api/actions/cat/indices.rb +10 -3
- data/lib/elasticsearch/api/actions/cat/master.rb +10 -1
- data/lib/elasticsearch/api/actions/cat/ml_data_frame_analytics.rb +11 -3
- data/lib/elasticsearch/api/actions/cat/ml_datafeeds.rb +9 -1
- data/lib/elasticsearch/api/actions/cat/ml_jobs.rb +9 -2
- data/lib/elasticsearch/api/actions/cat/ml_trained_models.rb +11 -4
- data/lib/elasticsearch/api/actions/cat/nodeattrs.rb +10 -1
- data/lib/elasticsearch/api/actions/cat/nodes.rb +10 -3
- data/lib/elasticsearch/api/actions/cat/pending_tasks.rb +10 -2
- data/lib/elasticsearch/api/actions/cat/plugins.rb +10 -1
- data/lib/elasticsearch/api/actions/cat/recovery.rb +9 -2
- data/lib/elasticsearch/api/actions/cat/repositories.rb +9 -0
- data/lib/elasticsearch/api/actions/cat/segments.rb +9 -1
- data/lib/elasticsearch/api/actions/cat/shards.rb +9 -2
- data/lib/elasticsearch/api/actions/cat/snapshots.rb +9 -1
- data/lib/elasticsearch/api/actions/cat/tasks.rb +10 -2
- data/lib/elasticsearch/api/actions/cat/templates.rb +10 -1
- data/lib/elasticsearch/api/actions/cat/thread_pool.rb +9 -1
- data/lib/elasticsearch/api/actions/cat/transforms.rb +9 -1
- data/lib/elasticsearch/api/actions/close_point_in_time.rb +2 -0
- data/lib/elasticsearch/api/actions/cluster/allocation_explain.rb +5 -0
- data/lib/elasticsearch/api/actions/cluster/state.rb +1 -1
- data/lib/elasticsearch/api/actions/connector/delete.rb +1 -1
- data/lib/elasticsearch/api/actions/connector/list.rb +2 -2
- data/lib/elasticsearch/api/actions/connector/sync_job_list.rb +2 -2
- data/lib/elasticsearch/api/actions/count.rb +10 -2
- data/lib/elasticsearch/api/actions/cross_cluster_replication/follow.rb +1 -1
- data/lib/elasticsearch/api/actions/dangling_indices/delete_dangling_index.rb +1 -1
- data/lib/elasticsearch/api/actions/dangling_indices/import_dangling_index.rb +1 -1
- data/lib/elasticsearch/api/actions/delete_by_query.rb +2 -2
- data/lib/elasticsearch/api/actions/eql/get.rb +1 -1
- data/lib/elasticsearch/api/actions/eql/search.rb +8 -0
- data/lib/elasticsearch/api/actions/esql/async_query.rb +1 -1
- data/lib/elasticsearch/api/actions/esql/query.rb +1 -1
- data/lib/elasticsearch/api/actions/explain.rb +2 -2
- data/lib/elasticsearch/api/actions/field_caps.rb +8 -0
- data/lib/elasticsearch/api/actions/fleet/search.rb +2 -6
- data/lib/elasticsearch/api/actions/get.rb +1 -0
- data/lib/elasticsearch/api/actions/get_script.rb +1 -1
- data/lib/elasticsearch/api/actions/graph/explore.rb +2 -6
- data/lib/elasticsearch/api/actions/index_lifecycle_management/move_to_step.rb +1 -0
- data/lib/elasticsearch/api/actions/index_lifecycle_management/put_lifecycle.rb +1 -0
- data/lib/elasticsearch/api/actions/indices/analyze.rb +3 -6
- data/lib/elasticsearch/api/actions/indices/create_from.rb +0 -1
- data/lib/elasticsearch/api/actions/indices/delete_data_lifecycle.rb +1 -1
- data/lib/elasticsearch/api/actions/indices/delete_data_stream_options.rb +1 -1
- data/lib/elasticsearch/api/actions/indices/disk_usage.rb +1 -0
- data/lib/elasticsearch/api/actions/indices/explain_data_lifecycle.rb +1 -1
- data/lib/elasticsearch/api/actions/indices/forcemerge.rb +1 -1
- data/lib/elasticsearch/api/actions/indices/get_data_stream_mappings.rb +75 -0
- data/lib/elasticsearch/api/actions/indices/put_data_lifecycle.rb +1 -0
- data/lib/elasticsearch/api/actions/indices/put_data_stream_mappings.rb +84 -0
- data/lib/elasticsearch/api/actions/indices/put_data_stream_options.rb +1 -0
- data/lib/elasticsearch/api/actions/indices/put_index_template.rb +1 -1
- data/lib/elasticsearch/api/actions/indices/put_template.rb +1 -1
- data/lib/elasticsearch/api/actions/indices/refresh.rb +1 -0
- data/lib/elasticsearch/api/actions/indices/resolve_index.rb +9 -0
- data/lib/elasticsearch/api/actions/indices/rollover.rb +1 -1
- data/lib/elasticsearch/api/actions/indices/shrink.rb +1 -0
- data/lib/elasticsearch/api/actions/indices/simulate_index_template.rb +2 -1
- data/lib/elasticsearch/api/actions/indices/simulate_template.rb +1 -1
- data/lib/elasticsearch/api/actions/indices/split.rb +1 -0
- data/lib/elasticsearch/api/actions/indices/stats.rb +1 -1
- data/lib/elasticsearch/api/actions/indices/validate_query.rb +1 -1
- data/lib/elasticsearch/api/actions/inference/completion.rb +1 -0
- data/lib/elasticsearch/api/actions/inference/inference.rb +1 -0
- data/lib/elasticsearch/api/actions/inference/put.rb +2 -1
- data/lib/elasticsearch/api/actions/inference/put_ai21.rb +79 -0
- data/lib/elasticsearch/api/actions/inference/put_alibabacloud.rb +1 -0
- data/lib/elasticsearch/api/actions/inference/put_amazonbedrock.rb +1 -0
- data/lib/elasticsearch/api/actions/inference/put_amazonsagemaker.rb +1 -0
- data/lib/elasticsearch/api/actions/inference/put_anthropic.rb +1 -0
- data/lib/elasticsearch/api/actions/inference/put_azureaistudio.rb +1 -0
- data/lib/elasticsearch/api/actions/inference/put_azureopenai.rb +1 -0
- data/lib/elasticsearch/api/actions/inference/put_cohere.rb +1 -0
- data/lib/elasticsearch/api/actions/inference/put_contextualai.rb +84 -0
- data/lib/elasticsearch/api/actions/inference/put_custom.rb +1 -0
- data/lib/elasticsearch/api/actions/inference/put_deepseek.rb +1 -0
- data/lib/elasticsearch/api/actions/inference/put_elasticsearch.rb +1 -0
- data/lib/elasticsearch/api/actions/inference/put_elser.rb +1 -0
- data/lib/elasticsearch/api/actions/inference/put_googleaistudio.rb +1 -0
- data/lib/elasticsearch/api/actions/inference/put_googlevertexai.rb +1 -0
- data/lib/elasticsearch/api/actions/inference/put_hugging_face.rb +1 -0
- data/lib/elasticsearch/api/actions/inference/put_jinaai.rb +1 -0
- data/lib/elasticsearch/api/actions/inference/put_llama.rb +79 -0
- data/lib/elasticsearch/api/actions/inference/put_mistral.rb +1 -0
- data/lib/elasticsearch/api/actions/inference/put_openai.rb +1 -0
- data/lib/elasticsearch/api/actions/inference/put_voyageai.rb +1 -0
- data/lib/elasticsearch/api/actions/inference/put_watsonx.rb +1 -0
- data/lib/elasticsearch/api/actions/inference/rerank.rb +1 -0
- data/lib/elasticsearch/api/actions/inference/sparse_embedding.rb +1 -0
- data/lib/elasticsearch/api/actions/inference/stream_completion.rb +1 -0
- data/lib/elasticsearch/api/actions/inference/text_embedding.rb +1 -0
- data/lib/elasticsearch/api/actions/license/get.rb +3 -1
- data/lib/elasticsearch/api/actions/logstash/put_pipeline.rb +2 -1
- data/lib/elasticsearch/api/actions/machine_learning/get_overall_buckets.rb +1 -1
- data/lib/elasticsearch/api/actions/msearch.rb +7 -0
- data/lib/elasticsearch/api/actions/msearch_template.rb +8 -0
- data/lib/elasticsearch/api/actions/nodes/stats.rb +1 -1
- data/lib/elasticsearch/api/actions/open_point_in_time.rb +8 -0
- data/lib/elasticsearch/api/actions/project/tags.rb +65 -0
- data/lib/elasticsearch/api/actions/query_rules/list_rulesets.rb +1 -1
- data/lib/elasticsearch/api/actions/reindex.rb +1 -1
- data/lib/elasticsearch/api/actions/render_search_template.rb +3 -6
- data/lib/elasticsearch/api/actions/scripts_painless_execute.rb +3 -6
- data/lib/elasticsearch/api/actions/search.rb +11 -2
- data/lib/elasticsearch/api/actions/search_mvt.rb +9 -1
- data/lib/elasticsearch/api/actions/search_template.rb +8 -0
- data/lib/elasticsearch/api/actions/searchable_snapshots/stats.rb +1 -1
- data/lib/elasticsearch/api/actions/security/get_settings.rb +1 -1
- data/lib/elasticsearch/api/actions/security/get_stats.rb +62 -0
- data/lib/elasticsearch/api/actions/security/update_settings.rb +1 -1
- data/lib/elasticsearch/api/actions/simulate/ingest.rb +4 -0
- data/lib/elasticsearch/api/actions/snapshot/get_repository.rb +1 -1
- data/lib/elasticsearch/api/actions/snapshot/repository_analyze.rb +17 -10
- data/lib/elasticsearch/api/actions/snapshot/status.rb +5 -0
- data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/put_lifecycle.rb +1 -0
- data/lib/elasticsearch/api/actions/sql/get_async.rb +1 -1
- data/lib/elasticsearch/api/actions/sql/query.rb +8 -0
- data/lib/elasticsearch/api/actions/streams/logs_disable.rb +23 -3
- data/lib/elasticsearch/api/actions/streams/logs_enable.rb +26 -3
- data/lib/elasticsearch/api/actions/streams/status.rb +20 -3
- data/lib/elasticsearch/api/actions/tasks/list.rb +1 -1
- data/lib/elasticsearch/api/actions/terms_enum.rb +2 -6
- data/lib/elasticsearch/api/actions/transform/get_node_stats.rb +1 -1
- data/lib/elasticsearch/api/actions/update_by_query.rb +2 -2
- data/lib/elasticsearch/api/actions/watcher/get_settings.rb +1 -1
- data/lib/elasticsearch/api/actions/watcher/put_watch.rb +1 -0
- data/lib/elasticsearch/api/actions/watcher/update_settings.rb +1 -1
- data/lib/elasticsearch/api/version.rb +2 -2
- data/lib/elasticsearch/api.rb +1 -0
- metadata +9 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 6e2038b3f672cc606ab10912496c8ca767b970532ab39f0200631f248ffb5ded
|
|
4
|
+
data.tar.gz: 29f3e2870f65ad58c5f1a5bd2bd5d17c85ddc6da65fc9843bc2d8f27a1225378
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: a9679ac647fc9165740fc38d71decdc4b11a61c2b17f5aabe3bee3ccd008f4f55ed72534f3784018dea55b22cbf2cddb084c0d34c6e3601a0fff5228a3f40ccd
|
|
7
|
+
data.tar.gz: 741518f968028106d28fe6bcb2cc320dbc6e2b147b244520eed4d737adf69fe8f3ae4bea34d5746bf65a38d813e7451c630c5a028b6ec90ae5a3fc1992850a85
|
|
@@ -35,13 +35,13 @@ module Elasticsearch
|
|
|
35
35
|
# Ongoing async searches and any saved search results are deleted after this period. Server default: 5d.
|
|
36
36
|
# @option arguments [Boolean] :keep_on_completion If `true`, results are stored for later retrieval when the search completes within the `wait_for_completion_timeout`.
|
|
37
37
|
# @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
|
|
38
|
-
# @option arguments [Boolean] :allow_partial_search_results Indicate if an error should be returned if there is a partial search failure or timeout
|
|
38
|
+
# @option arguments [Boolean] :allow_partial_search_results Indicate if an error should be returned if there is a partial search failure or timeout Server default: true.
|
|
39
39
|
# @option arguments [String] :analyzer The analyzer to use for the query string
|
|
40
40
|
# @option arguments [Boolean] :analyze_wildcard Specify whether wildcard and prefix queries should be analyzed (default: false)
|
|
41
41
|
# @option arguments [Integer] :batched_reduce_size Affects how often partial results become available, which happens whenever shard results are reduced.
|
|
42
42
|
# A partial reduction is performed every time the coordinating node has received a certain number of new shard responses (5 by default). Server default: 5.
|
|
43
43
|
# @option arguments [Boolean] :ccs_minimize_roundtrips The default value is the only supported value.
|
|
44
|
-
# @option arguments [String] :default_operator The default operator for query string query (AND or OR)
|
|
44
|
+
# @option arguments [String] :default_operator The default operator for query string query (AND or OR) Server default: or.
|
|
45
45
|
# @option arguments [String] :df The field to use as default where no field prefix is given in the query string
|
|
46
46
|
# @option arguments [String, Array<String>] :docvalue_fields A comma-separated list of fields to return as the docvalue representation of a field for each hit
|
|
47
47
|
# @option arguments [String, Array<String>] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
|
|
@@ -49,15 +49,23 @@ module Elasticsearch
|
|
|
49
49
|
# @option arguments [Boolean] :ignore_throttled Whether specified concrete, expanded or aliased indices should be ignored when throttled
|
|
50
50
|
# @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
|
|
51
51
|
# @option arguments [Boolean] :lenient Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
|
|
52
|
-
# @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
|
|
52
|
+
# @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 Server default: 5.
|
|
53
53
|
# @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random)
|
|
54
|
+
# @option arguments [String] :project_routing Specifies a subset of projects to target for the search using project
|
|
55
|
+
# metadata tags in a subset of Lucene query syntax.
|
|
56
|
+
# Allowed Lucene queries: the _alias tag and a single value (possibly wildcarded).
|
|
57
|
+
# Examples:
|
|
58
|
+
# _alias:my-project
|
|
59
|
+
# _alias:_origin
|
|
60
|
+
# _alias:*pr*
|
|
61
|
+
# Supported in serverless only.
|
|
54
62
|
# @option arguments [Boolean] :request_cache Specify if request cache should be used for this request or not, defaults to true Server default: true.
|
|
55
63
|
# @option arguments [String] :routing A comma-separated list of specific routing values
|
|
56
64
|
# @option arguments [String] :search_type Search operation type
|
|
57
65
|
# @option arguments [Array<String>] :stats Specific 'tag' of the request for logging and statistical purposes
|
|
58
66
|
# @option arguments [String, Array<String>] :stored_fields A comma-separated list of stored fields to return as part of a hit
|
|
59
67
|
# @option arguments [String] :suggest_field Specifies which field to use for suggestions.
|
|
60
|
-
# @option arguments [String] :suggest_mode Specify suggest mode
|
|
68
|
+
# @option arguments [String] :suggest_mode Specify suggest mode Server default: missing.
|
|
61
69
|
# @option arguments [Integer] :suggest_size How many suggestions to return in response
|
|
62
70
|
# @option arguments [String] :suggest_text The source text for which the suggestions should be returned.
|
|
63
71
|
# @option arguments [Integer] :terminate_after The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.
|
|
@@ -43,6 +43,15 @@ module Elasticsearch
|
|
|
43
43
|
# @option arguments [Boolean] :help When set to `true` will output available columns. This option
|
|
44
44
|
# can't be combined with any other query string option.
|
|
45
45
|
# @option arguments [Boolean] :v When set to `true` will enable verbose output.
|
|
46
|
+
# @option arguments [String] :bytes Sets the units for columns that contain a byte-size value.
|
|
47
|
+
# Note that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes.
|
|
48
|
+
# 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`.
|
|
49
|
+
# If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit.
|
|
50
|
+
# Values that are not an exact multiple of the chosen unit are rounded down.
|
|
51
|
+
# @option arguments [String] :time Sets the units for columns that contain a time duration.
|
|
52
|
+
# 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`.
|
|
53
|
+
# If given, time duration values are rendered as an integer with no suffix.
|
|
54
|
+
# Values that are not an exact multiple of the chosen unit are rounded down.
|
|
46
55
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
47
56
|
# when they occur.
|
|
48
57
|
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
|
@@ -27,7 +27,6 @@ module Elasticsearch
|
|
|
27
27
|
# IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.
|
|
28
28
|
#
|
|
29
29
|
# @option arguments [String, Array] :node_id A comma-separated list of node identifiers or names used to limit the returned information.
|
|
30
|
-
# @option arguments [String] :bytes The unit used to display byte values.
|
|
31
30
|
# @option arguments [String, Array<String>] :h A comma-separated list of columns names to display. It supports simple wildcards.
|
|
32
31
|
# @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
|
|
33
32
|
# Sorting defaults to ascending and can be changed by setting `:asc`
|
|
@@ -42,6 +41,15 @@ module Elasticsearch
|
|
|
42
41
|
# @option arguments [Boolean] :help When set to `true` will output available columns. This option
|
|
43
42
|
# can't be combined with any other query string option.
|
|
44
43
|
# @option arguments [Boolean] :v When set to `true` will enable verbose output.
|
|
44
|
+
# @option arguments [String] :bytes Sets the units for columns that contain a byte-size value.
|
|
45
|
+
# Note that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes.
|
|
46
|
+
# 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`.
|
|
47
|
+
# If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit.
|
|
48
|
+
# Values that are not an exact multiple of the chosen unit are rounded down.
|
|
49
|
+
# @option arguments [String] :time Sets the units for columns that contain a time duration.
|
|
50
|
+
# 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`.
|
|
51
|
+
# If given, time duration values are rendered as an integer with no suffix.
|
|
52
|
+
# Values that are not an exact multiple of the chosen unit are rounded down.
|
|
45
53
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
46
54
|
# when they occur.
|
|
47
55
|
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
|
@@ -45,6 +45,15 @@ module Elasticsearch
|
|
|
45
45
|
# @option arguments [Boolean] :help When set to `true` will output available columns. This option
|
|
46
46
|
# can't be combined with any other query string option.
|
|
47
47
|
# @option arguments [Boolean] :v When set to `true` will enable verbose output.
|
|
48
|
+
# @option arguments [String] :bytes Sets the units for columns that contain a byte-size value.
|
|
49
|
+
# Note that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes.
|
|
50
|
+
# 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`.
|
|
51
|
+
# If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit.
|
|
52
|
+
# Values that are not an exact multiple of the chosen unit are rounded down.
|
|
53
|
+
# @option arguments [String] :time Sets the units for columns that contain a time duration.
|
|
54
|
+
# 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`.
|
|
55
|
+
# If given, time duration values are rendered as an integer with no suffix.
|
|
56
|
+
# Values that are not an exact multiple of the chosen unit are rounded down.
|
|
48
57
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
49
58
|
# when they occur.
|
|
50
59
|
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
|
@@ -32,6 +32,14 @@ module Elasticsearch
|
|
|
32
32
|
# It supports wildcards (`*`).
|
|
33
33
|
# To target all data streams and indices, omit this parameter or use `*` or `_all`.
|
|
34
34
|
# @option arguments [String, Array<String>] :h A comma-separated list of columns names to display. It supports simple wildcards.
|
|
35
|
+
# @option arguments [String] :project_routing Specifies a subset of projects to target for the search using project
|
|
36
|
+
# metadata tags in a subset of Lucene query syntax.
|
|
37
|
+
# Allowed Lucene queries: the _alias tag and a single value (possibly wildcarded).
|
|
38
|
+
# Examples:
|
|
39
|
+
# _alias:my-project
|
|
40
|
+
# _alias:_origin
|
|
41
|
+
# _alias:*pr*
|
|
42
|
+
# Supported in serverless only.
|
|
35
43
|
# @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
|
|
36
44
|
# Sorting defaults to ascending and can be changed by setting `:asc`
|
|
37
45
|
# or `:desc` as a suffix to the column name.
|
|
@@ -40,6 +48,15 @@ module Elasticsearch
|
|
|
40
48
|
# @option arguments [Boolean] :help When set to `true` will output available columns. This option
|
|
41
49
|
# can't be combined with any other query string option.
|
|
42
50
|
# @option arguments [Boolean] :v When set to `true` will enable verbose output.
|
|
51
|
+
# @option arguments [String] :bytes Sets the units for columns that contain a byte-size value.
|
|
52
|
+
# Note that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes.
|
|
53
|
+
# 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`.
|
|
54
|
+
# If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit.
|
|
55
|
+
# Values that are not an exact multiple of the chosen unit are rounded down.
|
|
56
|
+
# @option arguments [String] :time Sets the units for columns that contain a time duration.
|
|
57
|
+
# 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`.
|
|
58
|
+
# If given, time duration values are rendered as an integer with no suffix.
|
|
59
|
+
# Values that are not an exact multiple of the chosen unit are rounded down.
|
|
43
60
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
44
61
|
# when they occur.
|
|
45
62
|
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
|
@@ -29,7 +29,6 @@ module Elasticsearch
|
|
|
29
29
|
#
|
|
30
30
|
# @option arguments [String, Array<String>] :fields Comma-separated list of fields used to limit returned information.
|
|
31
31
|
# To retrieve all fields, omit this parameter.
|
|
32
|
-
# @option arguments [String] :bytes The unit used to display byte values.
|
|
33
32
|
# @option arguments [String, Array<String>] :h A comma-separated list of columns names to display. It supports simple wildcards.
|
|
34
33
|
# @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
|
|
35
34
|
# Sorting defaults to ascending and can be changed by setting `:asc`
|
|
@@ -39,6 +38,15 @@ module Elasticsearch
|
|
|
39
38
|
# @option arguments [Boolean] :help When set to `true` will output available columns. This option
|
|
40
39
|
# can't be combined with any other query string option.
|
|
41
40
|
# @option arguments [Boolean] :v When set to `true` will enable verbose output.
|
|
41
|
+
# @option arguments [String] :bytes Sets the units for columns that contain a byte-size value.
|
|
42
|
+
# Note that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes.
|
|
43
|
+
# 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`.
|
|
44
|
+
# If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit.
|
|
45
|
+
# Values that are not an exact multiple of the chosen unit are rounded down.
|
|
46
|
+
# @option arguments [String] :time Sets the units for columns that contain a time duration.
|
|
47
|
+
# 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`.
|
|
48
|
+
# If given, time duration values are rendered as an integer with no suffix.
|
|
49
|
+
# Values that are not an exact multiple of the chosen unit are rounded down.
|
|
42
50
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
43
51
|
# when they occur.
|
|
44
52
|
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
|
@@ -33,9 +33,8 @@ module Elasticsearch
|
|
|
33
33
|
# You can use the cat health API to verify cluster health across multiple nodes.
|
|
34
34
|
# You also can use the API to track the recovery of a large cluster over a longer period of time.
|
|
35
35
|
#
|
|
36
|
-
# @option arguments [String] :time The unit used to display time values.
|
|
37
36
|
# @option arguments [Boolean] :ts If true, returns `HH:MM:SS` and Unix epoch timestamps. Server default: true.
|
|
38
|
-
# @option arguments [String, Array<String>] :h
|
|
37
|
+
# @option arguments [String, Array<String>] :h A comma-separated list of columns names to display. It supports simple wildcards.
|
|
39
38
|
# @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
|
|
40
39
|
# Sorting defaults to ascending and can be changed by setting `:asc`
|
|
41
40
|
# or `:desc` as a suffix to the column name.
|
|
@@ -44,6 +43,15 @@ module Elasticsearch
|
|
|
44
43
|
# @option arguments [Boolean] :help When set to `true` will output available columns. This option
|
|
45
44
|
# can't be combined with any other query string option.
|
|
46
45
|
# @option arguments [Boolean] :v When set to `true` will enable verbose output.
|
|
46
|
+
# @option arguments [String] :bytes Sets the units for columns that contain a byte-size value.
|
|
47
|
+
# Note that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes.
|
|
48
|
+
# 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`.
|
|
49
|
+
# If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit.
|
|
50
|
+
# Values that are not an exact multiple of the chosen unit are rounded down.
|
|
51
|
+
# @option arguments [String] :time Sets the units for columns that contain a time duration.
|
|
52
|
+
# 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`.
|
|
53
|
+
# If given, time duration values are rendered as an integer with no suffix.
|
|
54
|
+
# Values that are not an exact multiple of the chosen unit are rounded down.
|
|
47
55
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
48
56
|
# when they occur.
|
|
49
57
|
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
|
@@ -37,14 +37,12 @@ module Elasticsearch
|
|
|
37
37
|
#
|
|
38
38
|
# @option arguments [String, Array] :index Comma-separated list of data streams, indices, and aliases used to limit the request.
|
|
39
39
|
# Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`.
|
|
40
|
-
# @option arguments [String] :bytes The unit used to display byte values.
|
|
41
40
|
# @option arguments [String, Array<String>] :expand_wildcards The type of index that wildcard patterns can match.
|
|
42
41
|
# @option arguments [String] :health The health status used to limit returned indices. By default, the response includes indices of any health status.
|
|
43
42
|
# @option arguments [Boolean] :include_unloaded_segments If true, the response includes information from segments that are not loaded into memory.
|
|
44
43
|
# @option arguments [Boolean] :pri If true, the response only includes information from primary shards.
|
|
45
|
-
# @option arguments [String] :time The unit used to display time values.
|
|
46
44
|
# @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
|
|
47
|
-
# @option arguments [String, Array<String>] :h
|
|
45
|
+
# @option arguments [String, Array<String>] :h A comma-separated list of columns names to display. It supports simple wildcards.
|
|
48
46
|
# @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
|
|
49
47
|
# Sorting defaults to ascending and can be changed by setting `:asc`
|
|
50
48
|
# or `:desc` as a suffix to the column name.
|
|
@@ -53,6 +51,15 @@ module Elasticsearch
|
|
|
53
51
|
# @option arguments [Boolean] :help When set to `true` will output available columns. This option
|
|
54
52
|
# can't be combined with any other query string option.
|
|
55
53
|
# @option arguments [Boolean] :v When set to `true` will enable verbose output.
|
|
54
|
+
# @option arguments [String] :bytes Sets the units for columns that contain a byte-size value.
|
|
55
|
+
# Note that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes.
|
|
56
|
+
# 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`.
|
|
57
|
+
# If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit.
|
|
58
|
+
# Values that are not an exact multiple of the chosen unit are rounded down.
|
|
59
|
+
# @option arguments [String] :time Sets the units for columns that contain a time duration.
|
|
60
|
+
# 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`.
|
|
61
|
+
# If given, time duration values are rendered as an integer with no suffix.
|
|
62
|
+
# Values that are not an exact multiple of the chosen unit are rounded down.
|
|
56
63
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
57
64
|
# when they occur.
|
|
58
65
|
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
|
@@ -26,7 +26,7 @@ module Elasticsearch
|
|
|
26
26
|
# Get information about the master node, including the ID, bound IP address, and name.
|
|
27
27
|
# 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.
|
|
28
28
|
#
|
|
29
|
-
# @option arguments [String, Array<String>] :h
|
|
29
|
+
# @option arguments [String, Array<String>] :h A comma-separated list of columns names to display. It supports simple wildcards.
|
|
30
30
|
# @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
|
|
31
31
|
# Sorting defaults to ascending and can be changed by setting `:asc`
|
|
32
32
|
# or `:desc` as a suffix to the column name.
|
|
@@ -40,6 +40,15 @@ module Elasticsearch
|
|
|
40
40
|
# @option arguments [Boolean] :help When set to `true` will output available columns. This option
|
|
41
41
|
# can't be combined with any other query string option.
|
|
42
42
|
# @option arguments [Boolean] :v When set to `true` will enable verbose output.
|
|
43
|
+
# @option arguments [String] :bytes Sets the units for columns that contain a byte-size value.
|
|
44
|
+
# Note that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes.
|
|
45
|
+
# 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`.
|
|
46
|
+
# If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit.
|
|
47
|
+
# Values that are not an exact multiple of the chosen unit are rounded down.
|
|
48
|
+
# @option arguments [String] :time Sets the units for columns that contain a time duration.
|
|
49
|
+
# 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`.
|
|
50
|
+
# If given, time duration values are rendered as an integer with no suffix.
|
|
51
|
+
# Values that are not an exact multiple of the chosen unit are rounded down.
|
|
43
52
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
44
53
|
# when they occur.
|
|
45
54
|
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
|
@@ -29,17 +29,25 @@ module Elasticsearch
|
|
|
29
29
|
# application consumption, use the get data frame analytics jobs statistics API.
|
|
30
30
|
#
|
|
31
31
|
# @option arguments [String] :id The ID of the data frame analytics to fetch
|
|
32
|
-
# @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no configs.
|
|
33
|
-
#
|
|
32
|
+
# @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no configs.
|
|
33
|
+
# (This includes `_all` string or when no configs have been specified.)
|
|
34
34
|
# @option arguments [String, Array<String>] :h Comma-separated list of column names to display. Server default: create_time,id,state,type.
|
|
35
35
|
# @option arguments [String, Array<String>] :s Comma-separated list of column names or column aliases used to sort the
|
|
36
36
|
# response.
|
|
37
|
-
# @option arguments [String] :time Unit used to display time values.
|
|
38
37
|
# @option arguments [String] :format Specifies the format to return the columnar data in, can be set to
|
|
39
38
|
# `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text.
|
|
40
39
|
# @option arguments [Boolean] :help When set to `true` will output available columns. This option
|
|
41
40
|
# can't be combined with any other query string option.
|
|
42
41
|
# @option arguments [Boolean] :v When set to `true` will enable verbose output.
|
|
42
|
+
# @option arguments [String] :bytes Sets the units for columns that contain a byte-size value.
|
|
43
|
+
# Note that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes.
|
|
44
|
+
# 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`.
|
|
45
|
+
# If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit.
|
|
46
|
+
# Values that are not an exact multiple of the chosen unit are rounded down.
|
|
47
|
+
# @option arguments [String] :time Sets the units for columns that contain a time duration.
|
|
48
|
+
# 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`.
|
|
49
|
+
# If given, time duration values are rendered as an integer with no suffix.
|
|
50
|
+
# Values that are not an exact multiple of the chosen unit are rounded down.
|
|
43
51
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
44
52
|
# when they occur.
|
|
45
53
|
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
|
@@ -41,12 +41,20 @@ module Elasticsearch
|
|
|
41
41
|
# partial matches. Server default: true.
|
|
42
42
|
# @option arguments [String, Array<String>] :h Comma-separated list of column names to display. Server default: ['bc', 'id', 'sc', 's'].
|
|
43
43
|
# @option arguments [String, Array<String>] :s Comma-separated list of column names or column aliases used to sort the response.
|
|
44
|
-
# @option arguments [String] :time The unit used to display time values.
|
|
45
44
|
# @option arguments [String] :format Specifies the format to return the columnar data in, can be set to
|
|
46
45
|
# `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text.
|
|
47
46
|
# @option arguments [Boolean] :help When set to `true` will output available columns. This option
|
|
48
47
|
# can't be combined with any other query string option.
|
|
49
48
|
# @option arguments [Boolean] :v When set to `true` will enable verbose output.
|
|
49
|
+
# @option arguments [String] :bytes Sets the units for columns that contain a byte-size value.
|
|
50
|
+
# Note that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes.
|
|
51
|
+
# 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`.
|
|
52
|
+
# If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit.
|
|
53
|
+
# Values that are not an exact multiple of the chosen unit are rounded down.
|
|
54
|
+
# @option arguments [String] :time Sets the units for columns that contain a time duration.
|
|
55
|
+
# 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`.
|
|
56
|
+
# If given, time duration values are rendered as an integer with no suffix.
|
|
57
|
+
# Values that are not an exact multiple of the chosen unit are rounded down.
|
|
50
58
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
51
59
|
# when they occur.
|
|
52
60
|
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
|
@@ -39,15 +39,22 @@ module Elasticsearch
|
|
|
39
39
|
# If `true`, the API returns an empty jobs array when there are no matches and the subset of results when there
|
|
40
40
|
# are partial matches. If `false`, the API returns a 404 status code when there are no matches or only partial
|
|
41
41
|
# matches. Server default: true.
|
|
42
|
-
# @option arguments [String] :bytes The unit used to display byte values.
|
|
43
42
|
# @option arguments [String, Array<String>] :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.
|
|
44
43
|
# @option arguments [String, Array<String>] :s Comma-separated list of column names or column aliases used to sort the response.
|
|
45
|
-
# @option arguments [String] :time The unit used to display time values.
|
|
46
44
|
# @option arguments [String] :format Specifies the format to return the columnar data in, can be set to
|
|
47
45
|
# `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text.
|
|
48
46
|
# @option arguments [Boolean] :help When set to `true` will output available columns. This option
|
|
49
47
|
# can't be combined with any other query string option.
|
|
50
48
|
# @option arguments [Boolean] :v When set to `true` will enable verbose output.
|
|
49
|
+
# @option arguments [String] :bytes Sets the units for columns that contain a byte-size value.
|
|
50
|
+
# Note that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes.
|
|
51
|
+
# 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`.
|
|
52
|
+
# If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit.
|
|
53
|
+
# Values that are not an exact multiple of the chosen unit are rounded down.
|
|
54
|
+
# @option arguments [String] :time Sets the units for columns that contain a time duration.
|
|
55
|
+
# 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`.
|
|
56
|
+
# If given, time duration values are rendered as an integer with no suffix.
|
|
57
|
+
# Values that are not an exact multiple of the chosen unit are rounded down.
|
|
51
58
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
52
59
|
# when they occur.
|
|
53
60
|
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
|
@@ -32,17 +32,24 @@ module Elasticsearch
|
|
|
32
32
|
# @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.
|
|
33
33
|
# If `true`, the API returns an empty array when there are no matches and the subset of results when there are partial matches.
|
|
34
34
|
# If `false`, the API returns a 404 status code when there are no matches or only partial matches. Server default: true.
|
|
35
|
-
# @option arguments [String] :bytes The unit used to display byte values.
|
|
36
35
|
# @option arguments [String, Array<String>] :h A comma-separated list of column names to display.
|
|
37
36
|
# @option arguments [String, Array<String>] :s A comma-separated list of column names or aliases used to sort the response.
|
|
38
|
-
# @option arguments [Integer] :from Skips the specified number of transforms.
|
|
39
|
-
# @option arguments [Integer] :size The maximum number of transforms to display.
|
|
40
|
-
# @option arguments [String] :time Unit used to display time values.
|
|
37
|
+
# @option arguments [Integer] :from Skips the specified number of transforms. Server default: 0.
|
|
38
|
+
# @option arguments [Integer] :size The maximum number of transforms to display. Server default: 100.
|
|
41
39
|
# @option arguments [String] :format Specifies the format to return the columnar data in, can be set to
|
|
42
40
|
# `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text.
|
|
43
41
|
# @option arguments [Boolean] :help When set to `true` will output available columns. This option
|
|
44
42
|
# can't be combined with any other query string option.
|
|
45
43
|
# @option arguments [Boolean] :v When set to `true` will enable verbose output.
|
|
44
|
+
# @option arguments [String] :bytes Sets the units for columns that contain a byte-size value.
|
|
45
|
+
# Note that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes.
|
|
46
|
+
# 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`.
|
|
47
|
+
# If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit.
|
|
48
|
+
# Values that are not an exact multiple of the chosen unit are rounded down.
|
|
49
|
+
# @option arguments [String] :time Sets the units for columns that contain a time duration.
|
|
50
|
+
# 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`.
|
|
51
|
+
# If given, time duration values are rendered as an integer with no suffix.
|
|
52
|
+
# Values that are not an exact multiple of the chosen unit are rounded down.
|
|
46
53
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
47
54
|
# when they occur.
|
|
48
55
|
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
|
@@ -26,7 +26,7 @@ module Elasticsearch
|
|
|
26
26
|
# Get information about custom node attributes.
|
|
27
27
|
# 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.
|
|
28
28
|
#
|
|
29
|
-
# @option arguments [String, Array<String>] :h
|
|
29
|
+
# @option arguments [String, Array<String>] :h A comma-separated list of columns names to display. It supports simple wildcards.
|
|
30
30
|
# @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
|
|
31
31
|
# Sorting defaults to ascending and can be changed by setting `:asc`
|
|
32
32
|
# or `:desc` as a suffix to the column name.
|
|
@@ -40,6 +40,15 @@ module Elasticsearch
|
|
|
40
40
|
# @option arguments [Boolean] :help When set to `true` will output available columns. This option
|
|
41
41
|
# can't be combined with any other query string option.
|
|
42
42
|
# @option arguments [Boolean] :v When set to `true` will enable verbose output.
|
|
43
|
+
# @option arguments [String] :bytes Sets the units for columns that contain a byte-size value.
|
|
44
|
+
# Note that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes.
|
|
45
|
+
# 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`.
|
|
46
|
+
# If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit.
|
|
47
|
+
# Values that are not an exact multiple of the chosen unit are rounded down.
|
|
48
|
+
# @option arguments [String] :time Sets the units for columns that contain a time duration.
|
|
49
|
+
# 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`.
|
|
50
|
+
# If given, time duration values are rendered as an integer with no suffix.
|
|
51
|
+
# Values that are not an exact multiple of the chosen unit are rounded down.
|
|
43
52
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
44
53
|
# when they occur.
|
|
45
54
|
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
|
@@ -26,8 +26,7 @@ module Elasticsearch
|
|
|
26
26
|
# Get information about the nodes in a cluster.
|
|
27
27
|
# 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.
|
|
28
28
|
#
|
|
29
|
-
# @option arguments [
|
|
30
|
-
# @option arguments [Boolean, String] :full_id If `true`, return the full node ID. If `false`, return the shortened node ID. Server default: false.
|
|
29
|
+
# @option arguments [Boolean] :full_id If `true`, return the full node ID. If `false`, return the shortened node ID.
|
|
31
30
|
# @option arguments [Boolean] :include_unloaded_segments If true, the response includes information from segments that are not loaded into memory.
|
|
32
31
|
# @option arguments [String, Array<String>] :h A comma-separated list of columns names to display.
|
|
33
32
|
# It supports simple wildcards. Server default: ip,hp,rp,r,m,n,cpu,l.
|
|
@@ -35,12 +34,20 @@ module Elasticsearch
|
|
|
35
34
|
# Sorting defaults to ascending and can be changed by setting `:asc`
|
|
36
35
|
# or `:desc` as a suffix to the column name.
|
|
37
36
|
# @option arguments [Time] :master_timeout The period to wait for a connection to the master node. Server default: 30s.
|
|
38
|
-
# @option arguments [String] :time The unit used to display time values.
|
|
39
37
|
# @option arguments [String] :format Specifies the format to return the columnar data in, can be set to
|
|
40
38
|
# `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text.
|
|
41
39
|
# @option arguments [Boolean] :help When set to `true` will output available columns. This option
|
|
42
40
|
# can't be combined with any other query string option.
|
|
43
41
|
# @option arguments [Boolean] :v When set to `true` will enable verbose output.
|
|
42
|
+
# @option arguments [String] :bytes Sets the units for columns that contain a byte-size value.
|
|
43
|
+
# Note that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes.
|
|
44
|
+
# 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`.
|
|
45
|
+
# If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit.
|
|
46
|
+
# Values that are not an exact multiple of the chosen unit are rounded down.
|
|
47
|
+
# @option arguments [String] :time Sets the units for columns that contain a time duration.
|
|
48
|
+
# 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`.
|
|
49
|
+
# If given, time duration values are rendered as an integer with no suffix.
|
|
50
|
+
# Values that are not an exact multiple of the chosen unit are rounded down.
|
|
44
51
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
45
52
|
# when they occur.
|
|
46
53
|
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
|
@@ -26,7 +26,7 @@ module Elasticsearch
|
|
|
26
26
|
# Get information about cluster-level changes that have not yet taken effect.
|
|
27
27
|
# 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 pending cluster tasks API.
|
|
28
28
|
#
|
|
29
|
-
# @option arguments [String, Array<String>] :h
|
|
29
|
+
# @option arguments [String, Array<String>] :h A comma-separated list of columns names to display. It supports simple wildcards.
|
|
30
30
|
# @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
|
|
31
31
|
# Sorting defaults to ascending and can be changed by setting `:asc`
|
|
32
32
|
# or `:desc` as a suffix to the column name.
|
|
@@ -35,12 +35,20 @@ module Elasticsearch
|
|
|
35
35
|
# from the cluster state of the master node. In both cases the coordinating
|
|
36
36
|
# node will send requests for further information to each selected node.
|
|
37
37
|
# @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
|
|
38
|
-
# @option arguments [String] :time Unit used to display time values.
|
|
39
38
|
# @option arguments [String] :format Specifies the format to return the columnar data in, can be set to
|
|
40
39
|
# `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text.
|
|
41
40
|
# @option arguments [Boolean] :help When set to `true` will output available columns. This option
|
|
42
41
|
# can't be combined with any other query string option.
|
|
43
42
|
# @option arguments [Boolean] :v When set to `true` will enable verbose output.
|
|
43
|
+
# @option arguments [String] :bytes Sets the units for columns that contain a byte-size value.
|
|
44
|
+
# Note that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes.
|
|
45
|
+
# 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`.
|
|
46
|
+
# If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit.
|
|
47
|
+
# Values that are not an exact multiple of the chosen unit are rounded down.
|
|
48
|
+
# @option arguments [String] :time Sets the units for columns that contain a time duration.
|
|
49
|
+
# 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`.
|
|
50
|
+
# If given, time duration values are rendered as an integer with no suffix.
|
|
51
|
+
# Values that are not an exact multiple of the chosen unit are rounded down.
|
|
44
52
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
45
53
|
# when they occur.
|
|
46
54
|
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
|
@@ -26,7 +26,7 @@ module Elasticsearch
|
|
|
26
26
|
# Get a list of plugins running on each node of a cluster.
|
|
27
27
|
# 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.
|
|
28
28
|
#
|
|
29
|
-
# @option arguments [String, Array<String>] :h
|
|
29
|
+
# @option arguments [String, Array<String>] :h A comma-separated list of columns names to display. It supports simple wildcards.
|
|
30
30
|
# @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
|
|
31
31
|
# Sorting defaults to ascending and can be changed by setting `:asc`
|
|
32
32
|
# or `:desc` as a suffix to the column name.
|
|
@@ -41,6 +41,15 @@ module Elasticsearch
|
|
|
41
41
|
# @option arguments [Boolean] :help When set to `true` will output available columns. This option
|
|
42
42
|
# can't be combined with any other query string option.
|
|
43
43
|
# @option arguments [Boolean] :v When set to `true` will enable verbose output.
|
|
44
|
+
# @option arguments [String] :bytes Sets the units for columns that contain a byte-size value.
|
|
45
|
+
# Note that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes.
|
|
46
|
+
# 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`.
|
|
47
|
+
# If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit.
|
|
48
|
+
# Values that are not an exact multiple of the chosen unit are rounded down.
|
|
49
|
+
# @option arguments [String] :time Sets the units for columns that contain a time duration.
|
|
50
|
+
# 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`.
|
|
51
|
+
# If given, time duration values are rendered as an integer with no suffix.
|
|
52
|
+
# Values that are not an exact multiple of the chosen unit are rounded down.
|
|
44
53
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
45
54
|
# when they occur.
|
|
46
55
|
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
|
@@ -31,19 +31,26 @@ module Elasticsearch
|
|
|
31
31
|
# @option arguments [String, Array] :index A comma-separated list of data streams, indices, and aliases used to limit the request.
|
|
32
32
|
# Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`.
|
|
33
33
|
# @option arguments [Boolean] :active_only If `true`, the response only includes ongoing shard recoveries.
|
|
34
|
-
# @option arguments [String] :bytes The unit used to display byte values.
|
|
35
34
|
# @option arguments [Boolean] :detailed If `true`, the response includes detailed information about shard recoveries.
|
|
36
35
|
# @option arguments [String, Array<String>] :h A comma-separated list of columns names to display.
|
|
37
36
|
# It supports simple wildcards. Server default: ip,hp,rp,r,m,n,cpu,l.
|
|
38
37
|
# @option arguments [String, Array<String>] :s A comma-separated list of column names or aliases that determines the sort order.
|
|
39
38
|
# Sorting defaults to ascending and can be changed by setting `:asc`
|
|
40
39
|
# or `:desc` as a suffix to the column name.
|
|
41
|
-
# @option arguments [String] :time The unit used to display time values.
|
|
42
40
|
# @option arguments [String] :format Specifies the format to return the columnar data in, can be set to
|
|
43
41
|
# `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text.
|
|
44
42
|
# @option arguments [Boolean] :help When set to `true` will output available columns. This option
|
|
45
43
|
# can't be combined with any other query string option.
|
|
46
44
|
# @option arguments [Boolean] :v When set to `true` will enable verbose output.
|
|
45
|
+
# @option arguments [String] :bytes Sets the units for columns that contain a byte-size value.
|
|
46
|
+
# Note that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes.
|
|
47
|
+
# 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`.
|
|
48
|
+
# If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit.
|
|
49
|
+
# Values that are not an exact multiple of the chosen unit are rounded down.
|
|
50
|
+
# @option arguments [String] :time Sets the units for columns that contain a time duration.
|
|
51
|
+
# 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`.
|
|
52
|
+
# If given, time duration values are rendered as an integer with no suffix.
|
|
53
|
+
# Values that are not an exact multiple of the chosen unit are rounded down.
|
|
47
54
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
48
55
|
# when they occur.
|
|
49
56
|
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
|
@@ -40,6 +40,15 @@ module Elasticsearch
|
|
|
40
40
|
# @option arguments [Boolean] :help When set to `true` will output available columns. This option
|
|
41
41
|
# can't be combined with any other query string option.
|
|
42
42
|
# @option arguments [Boolean] :v When set to `true` will enable verbose output.
|
|
43
|
+
# @option arguments [String] :bytes Sets the units for columns that contain a byte-size value.
|
|
44
|
+
# Note that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes.
|
|
45
|
+
# 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`.
|
|
46
|
+
# If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit.
|
|
47
|
+
# Values that are not an exact multiple of the chosen unit are rounded down.
|
|
48
|
+
# @option arguments [String] :time Sets the units for columns that contain a time duration.
|
|
49
|
+
# 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`.
|
|
50
|
+
# If given, time duration values are rendered as an integer with no suffix.
|
|
51
|
+
# Values that are not an exact multiple of the chosen unit are rounded down.
|
|
43
52
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
44
53
|
# when they occur.
|
|
45
54
|
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
|
@@ -30,7 +30,6 @@ module Elasticsearch
|
|
|
30
30
|
# @option arguments [String, Array] :index A comma-separated list of data streams, indices, and aliases used to limit the request.
|
|
31
31
|
# Supports wildcards (`*`).
|
|
32
32
|
# To target all data streams and indices, omit this parameter or use `*` or `_all`.
|
|
33
|
-
# @option arguments [String] :bytes The unit used to display byte values.
|
|
34
33
|
# @option arguments [String, Array<String>] :h A comma-separated list of columns names to display.
|
|
35
34
|
# It supports simple wildcards. Server default: ip,hp,rp,r,m,n,cpu,l.
|
|
36
35
|
# @option arguments [String, Array<String>] :s A comma-separated list of column names or aliases that determines the sort order.
|
|
@@ -46,6 +45,15 @@ module Elasticsearch
|
|
|
46
45
|
# @option arguments [Boolean] :help When set to `true` will output available columns. This option
|
|
47
46
|
# can't be combined with any other query string option.
|
|
48
47
|
# @option arguments [Boolean] :v When set to `true` will enable verbose output.
|
|
48
|
+
# @option arguments [String] :bytes Sets the units for columns that contain a byte-size value.
|
|
49
|
+
# Note that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes.
|
|
50
|
+
# 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`.
|
|
51
|
+
# If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit.
|
|
52
|
+
# Values that are not an exact multiple of the chosen unit are rounded down.
|
|
53
|
+
# @option arguments [String] :time Sets the units for columns that contain a time duration.
|
|
54
|
+
# 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`.
|
|
55
|
+
# If given, time duration values are rendered as an integer with no suffix.
|
|
56
|
+
# Values that are not an exact multiple of the chosen unit are rounded down.
|
|
49
57
|
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
|
50
58
|
# when they occur.
|
|
51
59
|
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|