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 @@ -42,7 +42,7 @@ module Actions
# @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
# @option arguments [Boolean] :ignore_throttled Whether specified concrete, expanded or aliased indices should be ignored when throttled
# @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)
# @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
# @option arguments [List] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
# @option arguments [Boolean] :lenient Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
# @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random)
# @option arguments [Boolean] :rest_total_hits_as_int Indicates whether hits.total should be rendered as an integer or an object in the rest search response
Expand Down
2 changes: 1 addition & 1 deletion elasticsearch-api/lib/elasticsearch/api/actions/bulk.rb
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ module Actions
# @option arguments [String] :index Default index for items which don't provide one
# @option arguments [String] :wait_for_active_shards Sets the number of shard copies that must be active before proceeding with the bulk operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)
# @option arguments [String] :refresh If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes. (options: true, false, wait_for)
# @option arguments [String] :routing Specific routing value
# @option arguments [List] :routing Specific routing value
# @option arguments [Time] :timeout Explicit operation timeout
# @option arguments [List] :_source True or false to return the _source field or not, or default list of fields to return, can be overridden on each sub-request
# @option arguments [List] :_source_excludes Default list of fields to exclude from the returned _source field, can be overridden on each sub-request
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,11 @@ module Actions
# @option arguments [List] :name A comma-separated list of alias names to return
# @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
# @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
# @option arguments [List] :h Comma-separated list of column names to display
# @option arguments [List] :h Comma-separated list of column names to display (options: alias, index, filter, routing.index, routing.search, is_write_index)
# @option arguments [Boolean] :help Return help information
# @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
# @option arguments [Boolean] :v Verbose mode. Display column headers
# @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
# @option arguments [List] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
# @option arguments [String] :bytes The unit in which to display byte values (options: b, kb, mb, gb, tb, pb)
# @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos)
# @option arguments [Hash] :headers Custom HTTP headers
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ module Actions
# @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos)
# @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
# @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
# @option arguments [List] :h Comma-separated list of column names to display
# @option arguments [List] :h Comma-separated list of column names to display (options: shards, shards.undesired, write_load.forecast, disk.indices.forecast, disk.indices, disk.used, disk.avail, disk.total, disk.percent, host, ip, node, node.role)
# @option arguments [Boolean] :help Return help information
# @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
# @option arguments [Boolean] :v Verbose mode. Display column headers
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ module Actions
# @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
# @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
# @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
# @option arguments [List] :h Comma-separated list of column names to display
# @option arguments [List] :h Comma-separated list of column names to display (options: name, version, alias_count, mapping_count, settings_count, metadata_count, included_in)
# @option arguments [Boolean] :help Return help information
# @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
# @option arguments [Boolean] :v Verbose mode. Display column headers
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ module Actions
#
# @option arguments [List] :index A comma-separated list of index names to limit the returned information
# @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
# @option arguments [List] :h Comma-separated list of column names to display
# @option arguments [List] :h Comma-separated list of column names to display (options: epoch, timestamp, count)
# @option arguments [Boolean] :help Return help information
# @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
# @option arguments [Boolean] :v Verbose mode. Display column headers
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ module Actions
# @option arguments [List] :fields A comma-separated list of fields to return the fielddata size
# @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
# @option arguments [String] :bytes The unit in which to display byte values (options: b, kb, mb, gb, tb, pb)
# @option arguments [List] :h Comma-separated list of column names to display
# @option arguments [List] :h Comma-separated list of column names to display (options: id, host, ip, node, field, size)
# @option arguments [Boolean] :help Return help information
# @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
# @option arguments [Boolean] :v Verbose mode. Display column headers
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ module Actions
# Get the cluster health status
#
# @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
# @option arguments [List] :h Comma-separated list of column names to display
# @option arguments [List] :h Comma-separated list of column names to display (options: epoch, timestamp, cluster, status, node.total, node.data, shards, pri, relo, init, unassign, unassign.pri, pending_tasks, max_task_wait_time, active_shards_percent)
# @option arguments [Boolean] :help Return help information
# @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
# @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,15 +28,15 @@ module Actions
# @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
# @option arguments [String] :bytes The unit in which to display byte values (options: b, kb, mb, gb, tb, pb)
# @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
# @option arguments [List] :h Comma-separated list of column names to display
# @option arguments [String] :health A health status ("green", "yellow", or "red" to filter only indices matching the specified health status (options: green, yellow, red)
# @option arguments [List] :h Comma-separated list of column names to display (options: health, status, index, uuid, pri, rep, docs.count, docs.deleted, creation.date, creation.date.string, store.size, pri.store.size, dataset.size, completion.size, pri.completion.size, fielddata.memory_size, pri.fielddata.memory_size, fielddata.evictions, pri.fielddata.evictions, query_cache.memory_size, pri.query_cache.memory_size, query_cache.evictions, pri.query_cache.evictions, request_cache.memory_size, pri.request_cache.memory_size, request_cache.evictions, pri.request_cache.evictions, request_cache.hit_count, pri.request_cache.hit_count, request_cache.miss_count, pri.request_cache.miss_count, flush.total, pri.flush.total, flush.total_time, pri.flush.total_time, get.current, pri.get.current, get.time, pri.get.time, get.total, pri.get.total, get.exists_time, pri.get.exists_time, get.exists_total, pri.get.exists_total, get.missing_time, pri.get.missing_time, get.missing_total, pri.get.missing_total, indexing.delete_current, pri.indexing.delete_current, indexing.delete_time, pri.indexing.delete_time, indexing.delete_total, pri.indexing.delete_total, indexing.index_current, pri.indexing.index_current, indexing.index_time, pri.indexing.index_time, indexing.index_total, pri.indexing.index_total, indexing.index_failed, pri.indexing.index_failed, indexing.index_failed_due_to_version_conflict, pri.indexing.index_failed_due_to_version_conflict, merges.current, pri.merges.current, merges.current_docs, pri.merges.current_docs, merges.current_size, pri.merges.current_size, merges.total, pri.merges.total, merges.total_docs, pri.merges.total_docs, merges.total_size, pri.merges.total_size, merges.total_time, pri.merges.total_time, refresh.total, pri.refresh.total, refresh.time, pri.refresh.time, refresh.external_total, pri.refresh.external_total, refresh.external_time, pri.refresh.external_time, refresh.listeners, pri.refresh.listeners, search.fetch_current, pri.search.fetch_current, search.fetch_time, pri.search.fetch_time, search.fetch_total, pri.search.fetch_total, search.open_contexts, pri.search.open_contexts, search.query_current, pri.search.query_current, search.query_time, pri.search.query_time, search.query_total, pri.search.query_total, search.scroll_current, pri.search.scroll_current, search.scroll_time, pri.search.scroll_time, search.scroll_total, pri.search.scroll_total, segments.count, pri.segments.count, segments.memory, pri.segments.memory, segments.index_writer_memory, pri.segments.index_writer_memory, segments.version_map_memory, pri.segments.version_map_memory, segments.fixed_bitset_memory, pri.segments.fixed_bitset_memory, warmer.current, pri.warmer.current, warmer.total, pri.warmer.total, warmer.total_time, pri.warmer.total_time, suggest.current, pri.suggest.current, suggest.time, pri.suggest.time, suggest.total, pri.suggest.total, memory.total, pri.memory.total, bulk.total_operations, pri.bulk.total_operations, bulk.total_time, pri.bulk.total_time, bulk.total_size_in_bytes, pri.bulk.total_size_in_bytes, bulk.avg_time, pri.bulk.avg_time, bulk.avg_size_in_bytes, pri.bulk.avg_size_in_bytes, dense_vector.value_count, pri.dense_vector.value_count, sparse_vector.value_count, pri.sparse_vector.value_count)
# @option arguments [String] :health A health status ("green", "yellow", or "red" to filter only indices matching the specified health status (options: green, yellow, red, unknown, unavailable)
# @option arguments [Boolean] :help Return help information
# @option arguments [Boolean] :pri Set to true to return stats only for primary shards
# @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
# @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos)
# @option arguments [Boolean] :v Verbose mode. Display column headers
# @option arguments [Boolean] :include_unloaded_segments If set to true segment stats will include stats for segments that are not currently loaded into memory
# @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
# @option arguments [List] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-indices.html
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ module Actions
# @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
# @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
# @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
# @option arguments [List] :h Comma-separated list of column names to display
# @option arguments [List] :h Comma-separated list of column names to display (options: id, host, ip, node)
# @option arguments [Boolean] :help Return help information
# @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
# @option arguments [Boolean] :v Verbose mode. Display column headers
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@ module Actions
# @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 (options: b, kb, mb, gb, tb, pb)
# @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
# @option arguments [List] :h Comma-separated list of column names to display
# @option arguments [List] :h Comma-separated list of column names to display (options: assignment_explanation, create_time, description, dest_index, failure_reason, id, model_memory_limit, node.address, node.ephemeral_id, node.id, node.name, progress, source_index, state, type, version)
# @option arguments [Boolean] :help Return help information
# @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
# @option arguments [List] :s Comma-separated list of column names or column aliases to sort by (options: assignment_explanation, create_time, description, dest_index, failure_reason, id, model_memory_limit, node.address, node.ephemeral_id, node.id, node.name, progress, source_index, state, type, version)
# @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos)
# @option arguments [Boolean] :v Verbose mode. Display column headers
# @option arguments [Hash] :headers Custom HTTP headers
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,9 @@ module Actions
# @option arguments [String] :datafeed_id The ID of the datafeeds stats to fetch
# @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified)
# @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
# @option arguments [List] :h Comma-separated list of column names to display
# @option arguments [List] :h Comma-separated list of column names to display (options: ae, bc, id, na, ne, ni, nn, sba, sc, seah, st, s)
# @option arguments [Boolean] :help Return help information
# @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
# @option arguments [List] :s Comma-separated list of column names or column aliases to sort by (options: ae, bc, id, na, ne, ni, nn, sba, sc, seah, st, s)
# @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos)
# @option arguments [Boolean] :v Verbose mode. Display column headers
# @option arguments [String] :bytes The unit in which to display byte values (options: b, kb, mb, gb, tb, pb)
Expand Down
Loading