Sha256: ef1cccd32535e129b19fb75c5c244407c6f3fbc3511ab14b6dc23579b0eb917f
Contents?: true
Size: 1.89 KB
Versions: 47
Compression:
Stored size: 1.89 KB
Contents
module Elasticsearch
module API
module Cat
module Actions
# Display the information from the {Cluster::Actions#pending_tasks} API in a tabular format
#
# @example
#
# puts client.cat.pending_tasks
#
# @example Display header names in the output
#
# puts client.cat.pending_tasks v: true
#
# @example Return the information as Ruby objects
#
# client.cat.pending_tasks format: 'json'
#
# @option arguments [List] :h Comma-separated list of column names to display -- see the `help` argument
# @option arguments [Boolean] :v Display column headers as part of the output
# @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
# @option arguments [String] :format The output format. Options: 'text', 'json'; default: 'text'
# @option arguments [Boolean] :help Return information about headers
# @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
#
# @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-pending-tasks.html
#
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
end
end
end
end
Version data entries
47 entries across 47 versions & 6 rubygems