module Elasticsearch::API::Cat::Actions

Public Instance Methods

aliases(arguments = {}) click to toggle source

Shows information about currently configured aliases to indices including filter and routing infos.

@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 [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 [Hash] :headers Custom HTTP headers

@see www.elastic.co/guide/en/elasticsearch/reference/7.15/cat-alias.html

# File lib/elasticsearch/api/actions/cat/aliases.rb, line 36
def aliases(arguments = {})
  headers = arguments.delete(:headers) || {}

  arguments = arguments.clone

  _name = arguments.delete(:name)

  method = Elasticsearch::API::HTTP_GET
  path   = if _name
             "_cat/aliases/#{Utils.__listify(_name)}"
           else
             "_cat/aliases"
           end
  params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
  params[:h] = Utils.__listify(params[:h]) if params[:h]

  body = nil
  perform_request(method, path, params, body, headers).body
end
allocation(arguments = {}) click to toggle source

Provides a snapshot of how many shards are allocated to each data node and how much disk space they are using.

@option arguments [List] :node_id A comma-separated list of node IDs or names to limit the returned information @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, k, kb, m, mb, g, gb, t, tb, p, pb) @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 [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 [Hash] :headers Custom HTTP headers

@see www.elastic.co/guide/en/elasticsearch/reference/7.15/cat-allocation.html

# File lib/elasticsearch/api/actions/cat/allocation.rb, line 37
def allocation(arguments = {})
  headers = arguments.delete(:headers) || {}

  arguments = arguments.clone

  _node_id = arguments.delete(:node_id)

  method = Elasticsearch::API::HTTP_GET
  path   = if _node_id
             "_cat/allocation/#{Utils.__listify(_node_id)}"
           else
             "_cat/allocation"
           end
  params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
  params[:h] = Utils.__listify(params[:h]) if params[:h]

  body = nil
  perform_request(method, path, params, body, headers).body
end
count(arguments = {}) click to toggle source

Provides quick access to the document count of the entire cluster, or individual indices.

@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 [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 [Hash] :headers Custom HTTP headers

@see www.elastic.co/guide/en/elasticsearch/reference/7.15/cat-count.html

# File lib/elasticsearch/api/actions/cat/count.rb, line 34
def count(arguments = {})
  headers = arguments.delete(:headers) || {}

  arguments = arguments.clone

  _index = arguments.delete(:index)

  method = Elasticsearch::API::HTTP_GET
  path   = if _index
             "_cat/count/#{Utils.__listify(_index)}"
           else
             "_cat/count"
           end
  params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
  params[:h] = Utils.__listify(params[:h]) if params[:h]

  body = nil
  perform_request(method, path, params, body, headers).body
end
fielddata(arguments = {}) click to toggle source

Shows how much heap memory is currently being used by fielddata on every data node in the cluster.

@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, k, kb, m, mb, g, gb, t, tb, p, pb) @option arguments [List] :h Comma-separated list of column names to display @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 [Hash] :headers Custom HTTP headers

@see www.elastic.co/guide/en/elasticsearch/reference/7.15/cat-fielddata.html

# File lib/elasticsearch/api/actions/cat/fielddata.rb, line 35
def fielddata(arguments = {})
  headers = arguments.delete(:headers) || {}

  arguments = arguments.clone

  _fields = arguments.delete(:fields)

  method = Elasticsearch::API::HTTP_GET
  path   = if _fields
             "_cat/fielddata/#{Utils.__listify(_fields)}"
           else
             "_cat/fielddata"
           end
  params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)

  body = nil
  perform_request(method, path, params, body, headers).body
end
health(arguments = {}) click to toggle source

Returns a concise representation of the cluster health.

@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 [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) @option arguments [Boolean] :ts Set to false to disable timestamping @option arguments [Boolean] :v Verbose mode. Display column headers @option arguments [Hash] :headers Custom HTTP headers

@see www.elastic.co/guide/en/elasticsearch/reference/7.15/cat-health.html

# File lib/elasticsearch/api/actions/cat/health.rb, line 35
def health(arguments = {})
  headers = arguments.delete(:headers) || {}

  arguments = arguments.clone

  method = Elasticsearch::API::HTTP_GET
  path   = "_cat/health"
  params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
  params[:h] = Utils.__listify(params[:h]) if params[:h]

  body = nil
  perform_request(method, path, params, body, headers).body
end
help(arguments = {}) click to toggle source

Returns help for the Cat APIs.

@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 [Hash] :headers Custom HTTP headers

@see www.elastic.co/guide/en/elasticsearch/reference/7.15/cat.html

# File lib/elasticsearch/api/actions/cat/help.rb, line 30
def help(arguments = {})
  headers = arguments.delete(:headers) || {}

  arguments = arguments.clone

  method = Elasticsearch::API::HTTP_GET
  path   = "_cat"
  params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)

  body = nil
  perform_request(method, path, params, body, headers).body
end
indices(arguments = {}) click to toggle source

Returns information about indices: number of primaries and replicas, document counts, disk size, …

@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 [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb) @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) Deprecated @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 [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 [Hash] :headers Custom HTTP headers

@see www.elastic.co/guide/en/elasticsearch/reference/7.15/cat-indices.html

# File lib/elasticsearch/api/actions/cat/indices.rb, line 42
def indices(arguments = {})
  headers = arguments.delete(:headers) || {}

  arguments = arguments.clone

  _index = arguments.delete(:index)

  method = Elasticsearch::API::HTTP_GET
  path   = if _index
             "_cat/indices/#{Utils.__listify(_index)}"
           else
             "_cat/indices"
           end
  params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
  params[:h] = Utils.__listify(params[:h]) if params[:h]

  body = nil
  perform_request(method, path, params, body, headers).body
end
master(arguments = {}) click to toggle source

Returns information about the master node.

@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 [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 [Hash] :headers Custom HTTP headers

@see www.elastic.co/guide/en/elasticsearch/reference/7.15/cat-master.html

# File lib/elasticsearch/api/actions/cat/master.rb, line 35
def master(arguments = {})
  headers = arguments.delete(:headers) || {}

  arguments = arguments.clone

  method = Elasticsearch::API::HTTP_GET
  path   = "_cat/master"
  params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)

  body = nil
  perform_request(method, path, params, body, headers).body
end
nodeattrs(arguments = {}) click to toggle source

Returns information about custom node attributes.

@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 [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 [Hash] :headers Custom HTTP headers

@see www.elastic.co/guide/en/elasticsearch/reference/7.15/cat-nodeattrs.html

# File lib/elasticsearch/api/actions/cat/nodeattrs.rb, line 35
def nodeattrs(arguments = {})
  headers = arguments.delete(:headers) || {}

  arguments = arguments.clone

  method = Elasticsearch::API::HTTP_GET
  path   = "_cat/nodeattrs"
  params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)

  body = nil
  perform_request(method, path, params, body, headers).body
end
nodes(arguments = {}) click to toggle source

Returns basic statistics about performance of cluster nodes.

@option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb) @option arguments [String] :format a short version of the Accept header, e.g. json, yaml @option arguments [Boolean] :full_id Return the full node ID instead of the shortened version (default: false) @option arguments [Boolean] :local Calculate the selected nodes using the local cluster state rather than the state from master node (default: false) Deprecated @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 [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) @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 [Hash] :headers Custom HTTP headers

@see www.elastic.co/guide/en/elasticsearch/reference/7.15/cat-nodes.html

# File lib/elasticsearch/api/actions/cat/nodes.rb, line 39
def nodes(arguments = {})
  headers = arguments.delete(:headers) || {}

  arguments = arguments.clone

  method = Elasticsearch::API::HTTP_GET
  path   = "_cat/nodes"
  params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
  params[:h] = Utils.__listify(params[:h], escape: false) if params[:h]

  body = nil
  perform_request(method, path, params, body, headers).body
end
pending_tasks(arguments = {}) click to toggle source

Returns a concise representation of the cluster pending tasks.

@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 [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) @option arguments [Boolean] :v Verbose mode. Display column headers @option arguments [Hash] :headers Custom HTTP headers

@see www.elastic.co/guide/en/elasticsearch/reference/7.15/cat-pending-tasks.html

# File lib/elasticsearch/api/actions/cat/pending_tasks.rb, line 36
def pending_tasks(arguments = {})
  headers = arguments.delete(:headers) || {}

  arguments = arguments.clone

  method = Elasticsearch::API::HTTP_GET
  path   = "_cat/pending_tasks"
  params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
  params[:h] = Utils.__listify(params[:h]) if params[:h]

  body = nil
  perform_request(method, path, params, body, headers).body
end
plugins(arguments = {}) click to toggle source

Returns information about installed plugins across nodes node.

@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 [Boolean] :help Return help information @option arguments [Boolean] :include_bootstrap Include bootstrap plugins in the response @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 [Hash] :headers Custom HTTP headers

@see www.elastic.co/guide/en/elasticsearch/reference/7.15/cat-plugins.html

# File lib/elasticsearch/api/actions/cat/plugins.rb, line 36
def plugins(arguments = {})
  headers = arguments.delete(:headers) || {}

  arguments = arguments.clone

  method = Elasticsearch::API::HTTP_GET
  path   = "_cat/plugins"
  params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)

  body = nil
  perform_request(method, path, params, body, headers).body
end
recovery(arguments = {}) click to toggle source

Returns information about index shard recoveries, both on-going completed.

@option arguments [List] :index Comma-separated list or wildcard expression 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 [Boolean] :active_only If `true`, the response only includes ongoing shard recoveries @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb) @option arguments [Boolean] :detailed If `true`, the response includes detailed information about shard recoveries @option arguments [List] :h Comma-separated list of column names to display @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) @option arguments [Boolean] :v Verbose mode. Display column headers @option arguments [Hash] :headers Custom HTTP headers

@see www.elastic.co/guide/en/elasticsearch/reference/7.15/cat-recovery.html

# File lib/elasticsearch/api/actions/cat/recovery.rb, line 38
def recovery(arguments = {})
  headers = arguments.delete(:headers) || {}

  arguments = arguments.clone

  _index = arguments.delete(:index)

  method = Elasticsearch::API::HTTP_GET
  path   = if _index
             "_cat/recovery/#{Utils.__listify(_index)}"
           else
             "_cat/recovery"
           end
  params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
  params[:h] = Utils.__listify(params[:h]) if params[:h]

  body = nil
  perform_request(method, path, params, body, headers).body
end
repositories(arguments = {}) click to toggle source

Returns information about snapshot repositories registered in the cluster.

@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 @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 [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 [Hash] :headers Custom HTTP headers

@see www.elastic.co/guide/en/elasticsearch/reference/7.15/cat-repositories.html

# File lib/elasticsearch/api/actions/cat/repositories.rb, line 35
def repositories(arguments = {})
  headers = arguments.delete(:headers) || {}

  arguments = arguments.clone

  method = Elasticsearch::API::HTTP_GET
  path   = "_cat/repositories"
  params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)

  body = nil
  perform_request(method, path, params, body, headers).body
end
segments(arguments = {}) click to toggle source

Provides low-level information about the segments in the shards of an index.

@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 [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb) @option arguments [List] :h Comma-separated list of column names to display @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 [Hash] :headers Custom HTTP headers

@see www.elastic.co/guide/en/elasticsearch/reference/7.15/cat-segments.html

# File lib/elasticsearch/api/actions/cat/segments.rb, line 35
def segments(arguments = {})
  headers = arguments.delete(:headers) || {}

  arguments = arguments.clone

  _index = arguments.delete(:index)

  method = Elasticsearch::API::HTTP_GET
  path   = if _index
             "_cat/segments/#{Utils.__listify(_index)}"
           else
             "_cat/segments"
           end
  params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)

  body = nil
  perform_request(method, path, params, body, headers).body
end
shards(arguments = {}) click to toggle source

Provides a detailed view of shard allocation on nodes.

@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 [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb) @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) Deprecated @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 [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) @option arguments [Boolean] :v Verbose mode. Display column headers @option arguments [Hash] :headers Custom HTTP headers

@see www.elastic.co/guide/en/elasticsearch/reference/7.15/cat-shards.html

# File lib/elasticsearch/api/actions/cat/shards.rb, line 38
def shards(arguments = {})
  headers = arguments.delete(:headers) || {}

  arguments = arguments.clone

  _index = arguments.delete(:index)

  method = Elasticsearch::API::HTTP_GET
  path   = if _index
             "_cat/shards/#{Utils.__listify(_index)}"
           else
             "_cat/shards"
           end
  params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
  params[:h] = Utils.__listify(params[:h]) if params[:h]

  body = nil
  perform_request(method, path, params, body, headers).body
end
snapshots(arguments = {}) click to toggle source

Returns all snapshots in a specific repository.

@option arguments [List] :repository Name of repository from which to fetch the snapshot information @option arguments [String] :format a short version of the Accept header, e.g. json, yaml @option arguments [Boolean] :ignore_unavailable Set to true to ignore unavailable snapshots @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 [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) @option arguments [Boolean] :v Verbose mode. Display column headers @option arguments [Hash] :headers Custom HTTP headers

@see www.elastic.co/guide/en/elasticsearch/reference/7.15/cat-snapshots.html

# File lib/elasticsearch/api/actions/cat/snapshots.rb, line 37
def snapshots(arguments = {})
  headers = arguments.delete(:headers) || {}

  arguments = arguments.clone

  _repository = arguments.delete(:repository)

  method = Elasticsearch::API::HTTP_GET
  path   = if _repository
             "_cat/snapshots/#{Utils.__listify(_repository)}"
           else
             "_cat/snapshots"
           end
  params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)

  body = nil
  perform_request(method, path, params, body, headers).body
end
tasks(arguments = {}) click to toggle source

Returns information about the tasks currently executing on one or more nodes in the cluster.

@option arguments [String] :format a short version of the Accept header, e.g. json, yaml @option arguments [List] :nodes A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes @option arguments [List] :actions A comma-separated list of actions that should be returned. Leave empty to return all. @option arguments [Boolean] :detailed Return detailed task information (default: false) @option arguments [String] :parent_task_id Return tasks with specified parent task id (node_id:task_number). Set to -1 to return all. @option arguments [List] :h Comma-separated list of column names to display @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) @option arguments [Boolean] :v Verbose mode. Display column headers @option arguments [Hash] :headers Custom HTTP headers

@see www.elastic.co/guide/en/elasticsearch/reference/7.15/tasks.html

# File lib/elasticsearch/api/actions/cat/tasks.rb, line 38
def tasks(arguments = {})
  headers = arguments.delete(:headers) || {}

  arguments = arguments.clone

  method = Elasticsearch::API::HTTP_GET
  path   = "_cat/tasks"
  params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)

  body = nil
  perform_request(method, path, params, body, headers).body
end
templates(arguments = {}) click to toggle source

Returns information about existing templates.

@option arguments [String] :name A pattern that returned template names must match @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 [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 [Hash] :headers Custom HTTP headers

@see www.elastic.co/guide/en/elasticsearch/reference/7.15/cat-templates.html

# File lib/elasticsearch/api/actions/cat/templates.rb, line 36
def templates(arguments = {})
  headers = arguments.delete(:headers) || {}

  arguments = arguments.clone

  _name = arguments.delete(:name)

  method = Elasticsearch::API::HTTP_GET
  path   = if _name
             "_cat/templates/#{Utils.__listify(_name)}"
           else
             "_cat/templates"
           end
  params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)

  body = nil
  perform_request(method, path, params, body, headers).body
end
thread_pool(arguments = {}) click to toggle source

Returns cluster-wide thread pool statistics per node. By default the active, queue and rejected statistics are returned for all thread pools.

@option arguments [List] :thread_pool_patterns A comma-separated list of regular-expressions to filter the thread pools in the output @option arguments [String] :format a short version of the Accept header, e.g. json, yaml @option arguments [String] :size The multiplier in which to display values Deprecated (options: , k, m, g, t, p) @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 [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 [Hash] :headers Custom HTTP headers

@see www.elastic.co/guide/en/elasticsearch/reference/7.15/cat-thread-pool.html

# File lib/elasticsearch/api/actions/cat/thread_pool.rb, line 38
def thread_pool(arguments = {})
  headers = arguments.delete(:headers) || {}

  arguments = arguments.clone

  _thread_pool_patterns = arguments.delete(:thread_pool_patterns)

  method = Elasticsearch::API::HTTP_GET
  path   = if _thread_pool_patterns
             "_cat/thread_pool/#{Utils.__listify(_thread_pool_patterns)}"
           else
             "_cat/thread_pool"
           end
  params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
  params[:h] = Utils.__listify(params[:h]) if params[:h]

  body = nil
  perform_request(method, path, params, body, headers).body
end