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 [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 ]

          method = '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

7 entries across 7 versions & 1 rubygems

Version	Path
elasticsearch-api-1.0.6	lib/elasticsearch/api/actions/cat/pending_tasks.rb
elasticsearch-api-1.0.5	lib/elasticsearch/api/actions/cat/pending_tasks.rb
elasticsearch-api-1.0.4	lib/elasticsearch/api/actions/cat/pending_tasks.rb
elasticsearch-api-1.0.2	lib/elasticsearch/api/actions/cat/pending_tasks.rb
elasticsearch-api-1.0.1	lib/elasticsearch/api/actions/cat/pending_tasks.rb
elasticsearch-api-1.0.0	lib/elasticsearch/api/actions/cat/pending_tasks.rb
elasticsearch-api-1.0.0.rc2	lib/elasticsearch/api/actions/cat/pending_tasks.rb