Module: Elasticsearch::API::Cat::Actions
- Included in:
- CatClient
- Defined in:
- lib/elasticsearch/api/namespace/cat.rb,
lib/elasticsearch/api/actions/cat/help.rb,
lib/elasticsearch/api/actions/cat/count.rb,
lib/elasticsearch/api/actions/cat/nodes.rb,
lib/elasticsearch/api/actions/cat/tasks.rb,
lib/elasticsearch/api/actions/cat/health.rb,
lib/elasticsearch/api/actions/cat/master.rb,
lib/elasticsearch/api/actions/cat/shards.rb,
lib/elasticsearch/api/actions/cat/aliases.rb,
lib/elasticsearch/api/actions/cat/indices.rb,
lib/elasticsearch/api/actions/cat/plugins.rb,
lib/elasticsearch/api/actions/cat/recovery.rb,
lib/elasticsearch/api/actions/cat/segments.rb,
lib/elasticsearch/api/actions/cat/fielddata.rb,
lib/elasticsearch/api/actions/cat/nodeattrs.rb,
lib/elasticsearch/api/actions/cat/snapshots.rb,
lib/elasticsearch/api/actions/cat/templates.rb,
lib/elasticsearch/api/actions/cat/allocation.rb,
lib/elasticsearch/api/actions/cat/thread_pool.rb,
lib/elasticsearch/api/actions/cat/repositories.rb,
lib/elasticsearch/api/actions/cat/pending_tasks.rb
Instance Method Summary collapse
-
#aliases(arguments = {}) ⇒ Object
Returns information about aliases, including associated routing values and filters.
-
#allocation(arguments = {}) ⇒ Object
Return shard allocation information.
-
#count(arguments = {}) ⇒ Object
Return document counts for the entire cluster or specific indices.
-
#fielddata(arguments = {}) ⇒ Object
Return information about field data usage across the cluster.
-
#health(arguments = {}) ⇒ Object
Display a terse version of the Elasticsearch::API::Cluster::Actions#health API output.
-
#help(arguments = {}) ⇒ Object
Help information for the Cat API.
-
#indices(arguments = {}) ⇒ Object
Return the most important statistics about indices, across the cluster nodes.
-
#master(arguments = {}) ⇒ Object
Display basic information about the master node.
-
#nodeattrs(arguments = {}) ⇒ Object
Display custom node attributes.
-
#nodes(arguments = {}) ⇒ Object
Display information about cluster topology and nodes statistics.
-
#pending_tasks(arguments = {}) ⇒ Object
Display the information from the Elasticsearch::API::Cluster::Actions#pending_tasks API in a tabular format.
-
#plugins(arguments = {}) ⇒ Object
Return information about installed plugins.
-
#recovery(arguments = {}) ⇒ Object
Display information about the recovery process (allocating shards).
-
#repositories(arguments = {}) ⇒ Object
Shows all repositories registered in a cluster.
-
#segments(arguments = {}) ⇒ Object
Display information about the segments in the shards of an index.
-
#shards(arguments = {}) ⇒ Object
Display shard allocation across nodes.
-
#snapshots(arguments = {}) ⇒ Object
Shows all snapshots that belong to a specific repository.
-
#tasks(arguments = {}) ⇒ Object
Return currently running tasks.
-
#templates(arguments = {}) ⇒ Object
Returns information about existing templates.
-
#thread_pool(arguments = {}) ⇒ Object
Display thread pool statistics across nodes (use the ‘help` parameter to display a list of avaialable thread pools).
Instance Method Details
#aliases(arguments = {}) ⇒ Object
Returns information about aliases, including associated routing values and filters.
48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 |
# File 'lib/elasticsearch/api/actions/cat/aliases.rb', line 48 def aliases(arguments={}) valid_params = [ :local, :master_timeout, :h, :help, :v, :s ] name = arguments.delete(:name) method = HTTP_GET path = Utils.__pathify '_cat/aliases', Utils.__listify(name) params = Utils.__validate_and_extract_params arguments, valid_params params[:h] = Utils.__listify(params[:h]) if params[:h] body = nil perform_request(method, path, params, body).body end |
#allocation(arguments = {}) ⇒ Object
Return shard allocation information
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 |
# File 'lib/elasticsearch/api/actions/cat/allocation.rb', line 45 def allocation(arguments={}) valid_params = [ :bytes, :local, :master_timeout, :h, :help, :v, :s ] node_id = arguments.delete(:node_id) method = HTTP_GET path = Utils.__pathify '_cat/allocation', Utils.__listify(node_id) params = Utils.__validate_and_extract_params arguments, valid_params params[:h] = Utils.__listify(params[:h]) if params[:h] body = nil perform_request(method, path, params, body).body end |
#count(arguments = {}) ⇒ Object
Return document counts for the entire cluster or specific indices
40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 |
# File 'lib/elasticsearch/api/actions/cat/count.rb', line 40 def count(arguments={}) valid_params = [ :local, :master_timeout, :h, :help, :v, :s ] index = arguments.delete(:index) method = HTTP_GET path = Utils.__pathify '_cat/count', Utils.__listify(index) params = Utils.__validate_and_extract_params arguments, valid_params params[:h] = Utils.__listify(params[:h]) if params[:h] body = nil perform_request(method, path, params, body).body end |
#fielddata(arguments = {}) ⇒ Object
Return information about field data usage across the cluster
28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 |
# File 'lib/elasticsearch/api/actions/cat/fielddata.rb', line 28 def fielddata(arguments={}) valid_params = [ :bytes, :local, :master_timeout, :h, :help, :v, :s, :fields ] fields = arguments.delete(:fields) method = HTTP_GET path = Utils.__pathify "_cat/fielddata", Utils.__listify(fields) params = Utils.__validate_and_extract_params arguments, valid_params body = nil perform_request(method, path, params, body).body end |
#health(arguments = {}) ⇒ Object
Display a terse version of the Elasticsearch::API::Cluster::Actions#health API output
32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 |
# File 'lib/elasticsearch/api/actions/cat/health.rb', line 32 def health(arguments={}) valid_params = [ :local, :master_timeout, :h, :help, :ts, :v, :s ] method = HTTP_GET path = "_cat/health" params = Utils.__validate_and_extract_params arguments, valid_params params[:h] = Utils.__listify(params[:h]) if params[:h] body = nil perform_request(method, path, params, body).body end |
#help(arguments = {}) ⇒ Object
Help information for the Cat API
12 13 14 15 16 17 18 19 20 21 |
# File 'lib/elasticsearch/api/actions/cat/help.rb', line 12 def help(arguments={}) valid_params = [ :help ] method = HTTP_GET path = "_cat" params = Utils.__validate_and_extract_params arguments, valid_params body = nil perform_request(method, path, params, body).body end |
#indices(arguments = {}) ⇒ Object
Return the most important statistics about indices, across the cluster nodes
Use the ‘help` parameter to display available statistics.
54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 |
# File 'lib/elasticsearch/api/actions/cat/indices.rb', line 54 def indices(arguments={}) valid_params = [ :bytes, :h, :health, :help, :local, :master_timeout, :pri, :v, :s ] index = arguments.delete(:index) method = HTTP_GET path = Utils.__pathify '_cat/indices', Utils.__listify(index) params = Utils.__validate_and_extract_params arguments, valid_params params[:h] = Utils.__listify(params[:h]) if params[:h] body = nil perform_request(method, path, params, body).body end |
#master(arguments = {}) ⇒ Object
Display basic information about the master node
31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 |
# File 'lib/elasticsearch/api/actions/cat/master.rb', line 31 def master(arguments={}) valid_params = [ :local, :master_timeout, :h, :help, :v, :s ] method = HTTP_GET path = "_cat/master" params = Utils.__validate_and_extract_params arguments, valid_params body = nil perform_request(method, path, params, body).body end |
#nodeattrs(arguments = {}) ⇒ Object
Display custom node attributes
17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 |
# File 'lib/elasticsearch/api/actions/cat/nodeattrs.rb', line 17 def nodeattrs(arguments={}) valid_params = [ :local, :master_timeout, :h, :help, :v, :s ] method = 'GET' path = "_cat/nodeattrs" params = Utils.__validate_and_extract_params arguments, valid_params body = nil perform_request(method, path, params, body).body end |
#nodes(arguments = {}) ⇒ Object
Display information about cluster topology and nodes statistics
40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 |
# File 'lib/elasticsearch/api/actions/cat/nodes.rb', line 40 def nodes(arguments={}) valid_params = [ :full_id, :local, :master_timeout, :h, :help, :v, :s ] method = HTTP_GET path = "_cat/nodes" params = Utils.__validate_and_extract_params arguments, valid_params params[:h] = Utils.__listify(params[:h], :escape => false) if params[:h] body = nil perform_request(method, path, params, body).body end |
#pending_tasks(arguments = {}) ⇒ Object
Display the information from the Elasticsearch::API::Cluster::Actions#pending_tasks API in a tabular format
31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 |
# File 'lib/elasticsearch/api/actions/cat/pending_tasks.rb', line 31 def pending_tasks(arguments={}) valid_params = [ :local, :master_timeout, :h, :help, :v, :s ] method = HTTP_GET path = "_cat/pending_tasks" params = Utils.__validate_and_extract_params arguments, valid_params params[:h] = Utils.__listify(params[:h]) if params[:h] body = nil perform_request(method, path, params, body).body end |
#plugins(arguments = {}) ⇒ Object
Return information about installed plugins
18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 |
# File 'lib/elasticsearch/api/actions/cat/plugins.rb', line 18 def plugins(arguments={}) valid_params = [ :local, :master_timeout, :h, :help, :v, :s ] method = 'GET' path = "_cat/plugins" params = Utils.__validate_and_extract_params arguments, valid_params body = nil perform_request(method, path, params, body).body end |
#recovery(arguments = {}) ⇒ Object
Display information about the recovery process (allocating shards)
49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 |
# File 'lib/elasticsearch/api/actions/cat/recovery.rb', line 49 def recovery(arguments={}) valid_params = [ :bytes, :local, :master_timeout, :h, :help, :v, :s ] index = arguments.delete(:index) method = HTTP_GET path = Utils.__pathify '_cat/recovery', Utils.__listify(index) params = Utils.__validate_and_extract_params arguments, valid_params params[:h] = Utils.__listify(params[:h]) if params[:h] body = nil perform_request(method, path, params, body).body end |
#repositories(arguments = {}) ⇒ Object
Shows all repositories registered in a cluster
24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 |
# File 'lib/elasticsearch/api/actions/cat/repositories.rb', line 24 def repositories(arguments={}) valid_params = [ :master_timeout, :h, :help, :v, :s ] method = HTTP_GET path = "_cat/repositories" params = Utils.__validate_and_extract_params arguments, valid_params body = nil perform_request(method, path, params, body).body end |
#segments(arguments = {}) ⇒ Object
Display information about the segments in the shards of an index
21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 |
# File 'lib/elasticsearch/api/actions/cat/segments.rb', line 21 def segments(arguments={}) valid_params = [ :bytes, :index, :h, :help, :v, :s ] method = 'GET' path = "_cat/segments" params = Utils.__validate_and_extract_params arguments, valid_params body = nil perform_request(method, path, params, body).body end |
#shards(arguments = {}) ⇒ Object
Display shard allocation across nodes
53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 |
# File 'lib/elasticsearch/api/actions/cat/shards.rb', line 53 def shards(arguments={}) valid_params = [ :local, :master_timeout, :bytes, :h, :help, :v, :s ] index = arguments.delete(:index) method = HTTP_GET path = Utils.__pathify '_cat/shards', Utils.__listify(index) params = Utils.__validate_and_extract_params arguments, valid_params params[:h] = Utils.__listify(params[:h]) if params[:h] body = nil perform_request(method, path, params, body).body end |
#snapshots(arguments = {}) ⇒ Object
Shows all snapshots that belong to a specific repository
24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 |
# File 'lib/elasticsearch/api/actions/cat/snapshots.rb', line 24 def snapshots(arguments={}) raise ArgumentError, "Required argument 'repository' missing" if !arguments[:repository] && !arguments[:help] valid_params = [ :master_timeout, :h, :help, :v, :s ] repository = arguments.delete(:repository) method = HTTP_GET path = Utils.__pathify "_cat/snapshots", Utils.__escape(repository) params = Utils.__validate_and_extract_params arguments, valid_params body = nil perform_request(method, path, params, body).body end |
#tasks(arguments = {}) ⇒ Object
Return currently running tasks
21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 |
# File 'lib/elasticsearch/api/actions/cat/tasks.rb', line 21 def tasks(arguments={}) valid_params = [ :format, :node_id, :actions, :detailed, :parent_node, :parent_task, :h, :help, :v, :s ] method = 'GET' path = "_cat/tasks" params = Utils.__validate_and_extract_params arguments, valid_params body = nil perform_request(method, path, params, body).body end |
#templates(arguments = {}) ⇒ Object
Returns information about existing templates
19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 |
# File 'lib/elasticsearch/api/actions/cat/templates.rb', line 19 def templates(arguments={}) valid_params = [ :name, :format, :local, :master_timeout, :h, :help, :v, :s ] method = HTTP_GET path = "_cat/templates" params = Utils.__validate_and_extract_params arguments, valid_params body = nil perform_request(method, path, params, body).body end |
#thread_pool(arguments = {}) ⇒ Object
Display thread pool statistics across nodes (use the ‘help` parameter to display a list of avaialable thread pools)
41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 |
# File 'lib/elasticsearch/api/actions/cat/thread_pool.rb', line 41 def thread_pool(arguments={}) valid_params = [ :full_id, :size, :local, :thread_pool_patterns, :master_timeout, :h, :help, :v, :s ] method = HTTP_GET path = "_cat/thread_pool" params = Utils.__validate_and_extract_params arguments, valid_params params[:h] = Utils.__listify(params[:h]) if params[:h] body = nil perform_request(method, path, params, body).body end |